Modify VIEW-related comments to adhere to Go conventions

Signed-off-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com>

Author: agarciamontoro

sql/analyzer/resolve_tables_test.go

@@ -115,27 +115,23 @@ func TestResolveViews(t *testing.T) {
 	subqueryAlias := plan.NewSubqueryAlias("myview", subquery)
 	view := sql.NewView("myview", subqueryAlias)
 
-	// Register the view in the catalog
 	catalog := sql.NewCatalog()
 	catalog.AddDatabase(db)
 	err := catalog.ViewRegistry.Register(db.Name(), view)
 	require.NoError(err)
 
 	a := NewBuilder(catalog).AddPostAnalyzeRule(f.Name, f.Apply).Build()
 
-	// Check whether the view is resolved and replaced with the subquery
 	var notAnalyzed sql.Node = plan.NewUnresolvedTable("myview", "")
 	analyzed, err := f.Apply(sql.NewEmptyContext(), a, notAnalyzed)
 	require.NoError(err)
 	require.Equal(subqueryAlias, analyzed)
 
-	// Ensures that the resolution is case-insensitive
 	notAnalyzed = plan.NewUnresolvedTable("MyVieW", "")
 	analyzed, err = f.Apply(sql.NewEmptyContext(), a, notAnalyzed)
 	require.NoError(err)
 	require.Equal(subqueryAlias, analyzed)
 
-	// Ensures that the resolution is idempotent
 	analyzed, err = f.Apply(sql.NewEmptyContext(), a, subqueryAlias)
 	require.NoError(err)
 	require.Equal(subqueryAlias, analyzed)

sql/parse/util.go

@@ -80,8 +80,8 @@ func skipSpaces(r *bufio.Reader) error {
 	}
 }
 
-// Reads every contiguous space from the reader, populating numSpacesRead with
-// the number of spaces read.
+// readSpaces reads every contiguous space from the reader, populating
+// numSpacesRead with the number of spaces read.
 func readSpaces(r *bufio.Reader, numSpacesRead *int) error {
 	*numSpacesRead = 0
 	for {
@@ -148,8 +148,8 @@ func readLetter(r *bufio.Reader, buf *bytes.Buffer) error {
 	return nil
 }
 
-// Parses a single rune from the reader and consumes it, copying it to the
-// buffer, if it is either a letter or a point
+// readLetterOrPoint parses a single rune from the reader and consumes it,
+// copying it to the buffer, if it is either a letter or a point
 func readLetterOrPoint(r *bufio.Reader, buf *bytes.Buffer) error {
 	ru, _, err := r.ReadRune()
 	if err != nil {
@@ -188,8 +188,9 @@ func readValidIdentRune(r *bufio.Reader, buf *bytes.Buffer) error {
 	return nil
 }
 
-// Parses a single rune from the reader and consumes it, copying it to the
-// buffer, if is a letter, a digit, an underscore or the specified separator.
+// readValidScopedIdentRune parses a single rune from the reader and consumes
+// it, copying it to the buffer, if is a letter, a digit, an underscore or the
+// specified separator.
 func readValidScopedIdentRune(r *bufio.Reader, separator rune, buf *bytes.Buffer) error {
 	ru, _, err := r.ReadRune()
 	if err != nil {
@@ -404,8 +405,8 @@ func expectQuote(r *bufio.Reader) error {
 	return nil
 }
 
-// Tries to read the specified string, consuming the reader if the string is
-// found. The `matched` boolean is set to true if the string is found
+// maybe tries to read the specified string, consuming the reader if the string
+// is found. The `matched` boolean is set to true if the string is found
 func maybe(matched *bool, str string) parseFunc {
 	return func(rd *bufio.Reader) error {
 		*matched = false
@@ -436,9 +437,9 @@ func maybe(matched *bool, str string) parseFunc {
 	}
 }
 
-// Tries to read the specified strings, one after the other, separated by an
-// arbitrary number of spaces. It consumes the reader if and only if all the
-// strings are found.
+// multiMaybe tries to read the specified strings, one after the other,
+// separated by an arbitrary number of spaces. It consumes the reader if and
+// only if all the strings are found.
 func multiMaybe(matched *bool, strings ...string) parseFunc {
 	return func(rd *bufio.Reader) error {
 		*matched = false
@@ -468,8 +469,9 @@ func multiMaybe(matched *bool, strings ...string) parseFunc {
 	}
 }
 
-// Reads a list of strings separated by the specified separator, with a rune
-// indicating the opening of the list and another one specifying its closing.
+// maybeList reads a list of strings separated by the specified separator, with
+// a rune indicating the opening of the list and another one specifying its
+// closing.
 // For example, readList('(', ',', ')', list) parses "(uno,  dos,tres)" and
 // populates list with the array of strings ["uno", "dos", "tres"]
 // If the opening is not found, this does not consumes any rune from the

sql/parse/views.go

@@ -14,7 +14,7 @@ import (
 var ErrMalformedViewName = errors.NewKind("the view name '%s' is not correct")
 var ErrMalformedCreateView = errors.NewKind("view definition %#v is not a SELECT query")
 
-// Parses
+// parseCreateView parses
 // CREATE [OR REPLACE] VIEW [db_name.]view_name AS select_statement
 // and returns a NewCreateView node in case of success
 func parseCreateView(ctx *sql.Context, s string) (sql.Node, error) {

sql/plan/create_view_test.go

@@ -60,7 +60,6 @@ func TestCreateExistingView(t *testing.T) {
 
 	createView := mockCreateView(false)
 
-	// Register a view with the same name
 	view := createView.View()
 	err := createView.Catalog.ViewRegistry.Register(createView.database.Name(), view)
 	require.NoError(err)
@@ -78,12 +77,10 @@ func TestReplaceExistingView(t *testing.T) {
 
 	createView := mockCreateView(true)
 
-	// Register a view with the same name but no child
 	view := sql.NewView(createView.Name, nil)
 	err := createView.Catalog.ViewRegistry.Register(createView.database.Name(), view)
 	require.NoError(err)
 
-	// Set the IsReplace flag to true
 	createView.IsReplace = true
 
 	ctx := sql.NewEmptyContext()

sql/viewregistry.go

@@ -12,23 +12,23 @@ var (
 	ErrNonExistingView = errors.NewKind("the view %s.%s does not exist in the registry")
 )
 
-// A View is defined by a Node and has a name.
+// View is defined by a Node and has a name.
 type View struct {
 	name       string
 	definition Node
 }
 
-// Creates a View with the specified name and definition.
+// NewView creates a View with the specified name and definition.
 func NewView(name string, definition Node) View {
 	return View{name, definition}
 }
 
-// Returns the name of the view.
+// Name returns the name of the view.
 func (view *View) Name() string {
 	return view.name
 }
 
-// Returns the definition of the view.
+// Definition returns the definition of the view.
 func (view *View) Definition() Node {
 	return view.definition
 }
@@ -39,7 +39,7 @@ type viewKey struct {
 	dbName, viewName string
 }
 
-// Creates a viewKey ensuring both names are lowercase.
+// newViewKey creates a viewKey ensuring both names are lowercase.
 func newViewKey(databaseName, viewName string) viewKey {
 	return viewKey{strings.ToLower(databaseName), strings.ToLower(viewName)}
 }
@@ -51,15 +51,15 @@ type ViewRegistry struct {
 	views map[viewKey]View
 }
 
-// Creates an empty ViewRegistry.
+// NewViewRegistry creates an empty ViewRegistry.
 func NewViewRegistry() *ViewRegistry {
 	return &ViewRegistry{
 		views: make(map[viewKey]View),
 	}
 }
 
-// Adds the view specified by the pair {database, view.Name()}, returning
-// an error if there is already an element with that key.
+// Register adds the view specified by the pair {database, view.Name()},
+// returning an error if there is already an element with that key.
 func (registry *ViewRegistry) Register(database string, view View) error {
 	registry.mutex.Lock()
 	defer registry.mutex.Unlock()
@@ -74,8 +74,8 @@ func (registry *ViewRegistry) Register(database string, view View) error {
 	return nil
 }
 
-// Deletes the view specified by the pair {databaseName, viewName}, returning
-// an error if it does not exist.
+// Delete deletes the view specified by the pair {databaseName, viewName},
+// returning an error if it does not exist.
 func (registry *ViewRegistry) Delete(databaseName, viewName string) error {
 	registry.mutex.Lock()
 	defer registry.mutex.Unlock()
@@ -90,7 +90,7 @@ func (registry *ViewRegistry) Delete(databaseName, viewName string) error {
 	return nil
 }
 
-// Returns a pointer to the view specified by the pair {databaseName,
+// View returns a pointer to the view specified by the pair {databaseName,
 // viewName}, returning an error if it does not exist.
 func (registry *ViewRegistry) View(databaseName, viewName string) (*View, error) {
 	registry.mutex.RLock()
@@ -105,15 +105,16 @@ func (registry *ViewRegistry) View(databaseName, viewName string) (*View, error)
 	return nil, ErrNonExistingView.New(databaseName, viewName)
 }
 
-// Returns the map of all views in the registry.
+// AllViews returns the map of all views in the registry.
 func (registry *ViewRegistry) AllViews() map[viewKey]View {
 	registry.mutex.RLock()
 	defer registry.mutex.RUnlock()
 
 	return registry.views
 }
 
-// Returns an array of all the views registered under the specified database.
+// ViewsInDatabase returns an array of all the views registered under the
+// specified database.
 func (registry *ViewRegistry) ViewsInDatabase(databaseName string) (views []View) {
 	registry.mutex.RLock()
 	defer registry.mutex.RUnlock()

sql/viewregistry_test.go

@@ -45,7 +45,6 @@ func TestRegisterExistingVIew(t *testing.T) {
 	require.NoError(err)
 	require.Equal(1, len(registry.AllViews()))
 
-	// Try to register the same view once again
 	err = registry.Register(dbName, mockView)
 	require.Error(err)
 	require.True(ErrExistingView.Is(err))