sqlpath: Move ReadSQLFiles into a separate package (#495)

Author: kyleconroy

internal/dinosql/parser.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 	"fmt"
 	"io/ioutil"
-	"os"
 	"path/filepath"
 	"sort"
 	"strconv"
@@ -17,6 +16,7 @@ import (
 	core "github.com/kyleconroy/sqlc/internal/pg"
 	"github.com/kyleconroy/sqlc/internal/postgres"
 	"github.com/kyleconroy/sqlc/internal/postgresql/ast"
+	"github.com/kyleconroy/sqlc/internal/sql/sqlpath"
 
 	"github.com/davecgh/go-spew/spew"
 	pg "github.com/lfittl/pg_query_go"
@@ -60,43 +60,8 @@ func (e *ParserErr) Error() string {
 	return fmt.Sprintf("multiple errors: %d errors", len(e.Errs))
 }
 
-func ReadSQLFiles(paths []string) ([]string, error) {
-	var files []string
-	for _, path := range paths {
-		f, err := os.Stat(path)
-		if err != nil {
-			return nil, fmt.Errorf("path %s does not exist", path)
-		}
-		if f.IsDir() {
-			listing, err := ioutil.ReadDir(path)
-			if err != nil {
-				return nil, err
-			}
-			for _, f := range listing {
-				files = append(files, filepath.Join(path, f.Name()))
-			}
-		} else {
-			files = append(files, path)
-		}
-	}
-	var sqlFiles []string
-	for _, file := range files {
-		if !strings.HasSuffix(file, ".sql") {
-			continue
-		}
-		if strings.HasPrefix(filepath.Base(file), ".") {
-			continue
-		}
-		if migrations.IsDown(filepath.Base(file)) {
-			continue
-		}
-		sqlFiles = append(sqlFiles, file)
-	}
-	return sqlFiles, nil
-}
-
 func ParseCatalog(schemas []string) (core.Catalog, error) {
-	files, err := ReadSQLFiles(schemas)
+	files, err := sqlpath.Glob(schemas)
 	if err != nil {
 		return core.Catalog{}, err
 	}
@@ -202,7 +167,7 @@ func ParseQueries(c core.Catalog, queriesPaths []string, opts ParserOpts) (*Resu
 	var q []*Query
 
 	set := map[string]struct{}{}
-	files, err := ReadSQLFiles(queriesPaths)
+	files, err := sqlpath.Glob(queriesPaths)
 	if err != nil {
 		return nil, err
 	}

internal/dinosql/parser_test.go

@@ -6,6 +6,8 @@ import (
 	"path"
 	"testing"
 
+	"github.com/kyleconroy/sqlc/internal/sql/sqlpath"
+
 	"github.com/google/go-cmp/cmp"
 	pg "github.com/lfittl/pg_query_go"
 	nodes "github.com/lfittl/pg_query_go/nodes"
@@ -235,7 +237,7 @@ func TestReadFiles(t *testing.T) {
 		path.Join(subdir2, "include-me.up.sql"),
 	}
 
-	filesRead, err := ReadSQLFiles(input)
+	filesRead, err := sqlpath.Glob(input)
 	if err != nil {
 		t.Error(err)
 	}

internal/mysql/parse.go

@@ -12,6 +12,7 @@ import (
 	"github.com/kyleconroy/sqlc/internal/config"
 	"github.com/kyleconroy/sqlc/internal/dinosql"
 	"github.com/kyleconroy/sqlc/internal/migrations"
+	"github.com/kyleconroy/sqlc/internal/sql/sqlpath"
 )
 
 // Query holds the data for walking and validating mysql querys
@@ -32,7 +33,7 @@ type Column struct {
 }
 
 func parsePath(sqlPath []string, generator PackageGenerator) (*Result, error) {
-	files, err := dinosql.ReadSQLFiles(sqlPath)
+	files, err := sqlpath.Glob(sqlPath)
 	if err != nil {
 		return nil, err
 	}

internal/sql/catalog/catalog.go

@@ -217,51 +217,55 @@ func New(def string) *Catalog {
 
 func (c *Catalog) Build(stmts []ast.Statement) error {
 	for i := range stmts {
-		if stmts[i].Raw == nil {
-			continue
-		}
-		var err error
-		switch n := stmts[i].Raw.Stmt.(type) {
-		case *ast.AlterTableStmt:
-			err = c.alterTable(n)
-		case *ast.AlterTableSetSchemaStmt:
-			err = c.alterTableSetSchema(n)
-		case *ast.AlterTypeAddValueStmt:
-			err = c.alterTypeAddValue(n)
-		case *ast.AlterTypeRenameValueStmt:
-			err = c.alterTypeRenameValue(n)
-		case *ast.CommentOnColumnStmt:
-			err = c.commentOnColumn(n)
-		case *ast.CommentOnSchemaStmt:
-			err = c.commentOnSchema(n)
-		case *ast.CommentOnTableStmt:
-			err = c.commentOnTable(n)
-		case *ast.CommentOnTypeStmt:
-			err = c.commentOnType(n)
-		case *ast.CreateEnumStmt:
-			err = c.createEnum(n)
-		case *ast.CreateFunctionStmt:
-			err = c.createFunction(n)
-		case *ast.CreateSchemaStmt:
-			err = c.createSchema(n)
-		case *ast.CreateTableStmt:
-			err = c.createTable(n)
-		case *ast.DropFunctionStmt:
-			err = c.dropFunction(n)
-		case *ast.DropSchemaStmt:
-			err = c.dropSchema(n)
-		case *ast.DropTableStmt:
-			err = c.dropTable(n)
-		case *ast.DropTypeStmt:
-			err = c.dropType(n)
-		case *ast.RenameColumnStmt:
-			err = c.renameColumn(n)
-		case *ast.RenameTableStmt:
-			err = c.renameTable(n)
-		}
-		if err != nil {
+		if err := c.Update(stmts[i]); err != nil {
 			return err
 		}
 	}
 	return nil
 }
+
+func (c *Catalog) Update(stmt ast.Statement) error {
+	if stmt.Raw == nil {
+		return nil
+	}
+	var err error
+	switch n := stmt.Raw.Stmt.(type) {
+	case *ast.AlterTableStmt:
+		err = c.alterTable(n)
+	case *ast.AlterTableSetSchemaStmt:
+		err = c.alterTableSetSchema(n)
+	case *ast.AlterTypeAddValueStmt:
+		err = c.alterTypeAddValue(n)
+	case *ast.AlterTypeRenameValueStmt:
+		err = c.alterTypeRenameValue(n)
+	case *ast.CommentOnColumnStmt:
+		err = c.commentOnColumn(n)
+	case *ast.CommentOnSchemaStmt:
+		err = c.commentOnSchema(n)
+	case *ast.CommentOnTableStmt:
+		err = c.commentOnTable(n)
+	case *ast.CommentOnTypeStmt:
+		err = c.commentOnType(n)
+	case *ast.CreateEnumStmt:
+		err = c.createEnum(n)
+	case *ast.CreateFunctionStmt:
+		err = c.createFunction(n)
+	case *ast.CreateSchemaStmt:
+		err = c.createSchema(n)
+	case *ast.CreateTableStmt:
+		err = c.createTable(n)
+	case *ast.DropFunctionStmt:
+		err = c.dropFunction(n)
+	case *ast.DropSchemaStmt:
+		err = c.dropSchema(n)
+	case *ast.DropTableStmt:
+		err = c.dropTable(n)
+	case *ast.DropTypeStmt:
+		err = c.dropType(n)
+	case *ast.RenameColumnStmt:
+		err = c.renameColumn(n)
+	case *ast.RenameTableStmt:
+		err = c.renameTable(n)
+	}
+	return err
+}

internal/sql/sqlpath/read.go

@@ -0,0 +1,48 @@
+package sqlpath
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/kyleconroy/sqlc/internal/migrations"
+)
+
+// Return a list of SQL files in the listed paths. Only includes files ending
+// in .sql. Omits hidden files, directories, and migrations.
+func Glob(paths []string) ([]string, error) {
+	var files []string
+	for _, path := range paths {
+		f, err := os.Stat(path)
+		if err != nil {
+			return nil, fmt.Errorf("path %s does not exist", path)
+		}
+		if f.IsDir() {
+			listing, err := ioutil.ReadDir(path)
+			if err != nil {
+				return nil, err
+			}
+			for _, f := range listing {
+				files = append(files, filepath.Join(path, f.Name()))
+			}
+		} else {
+			files = append(files, path)
+		}
+	}
+	var sqlFiles []string
+	for _, file := range files {
+		if !strings.HasSuffix(file, ".sql") {
+			continue
+		}
+		if strings.HasPrefix(filepath.Base(file), ".") {
+			continue
+		}
+		if migrations.IsDown(filepath.Base(file)) {
+			continue
+		}
+		sqlFiles = append(sqlFiles, file)
+	}
+	return sqlFiles, nil
+}

internal/sqltest/postgres.go

@@ -10,7 +10,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/kyleconroy/sqlc/internal/dinosql"
+	"github.com/kyleconroy/sqlc/internal/sql/sqlpath"
 
 	_ "github.com/lib/pq"
 )
@@ -79,7 +79,7 @@ func PostgreSQL(t *testing.T, migrations []string) (*sql.DB, func()) {
 		t.Fatal(err)
 	}
 
-	files, err := dinosql.ReadSQLFiles(migrations)
+	files, err := sqlpath.Glob(migrations)
 	if err != nil {
 		t.Fatal(err)
 	}