Rename RawSql to RawSQL to follow conventions (#19)

gobuffalo · Aug 20, 2018 · f3f4d6f · f3f4d6f
1 parent 7dcea5e
commit f3f4d6f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/bubbler.go b/bubbler.go
@@ -34,8 +34,8 @@ func (b *Bubbler) Bubble(s string) (string, error) {
 		"add_column":       f.AddColumn,
 		"drop_column":      f.DropColumn,
 		"rename_column":    f.RenameColumn,
-		"raw":              f.RawSql,
-		"sql":              f.RawSql,
+		"raw":              f.RawSQL,
+		"sql":              f.RawSQL,
 		"add_index":        f.AddIndex,
 		"drop_index":       f.DropIndex,
 		"rename_index":     f.RenameIndex,

diff --git a/fizz.go b/fizz.go
@@ -39,6 +39,7 @@ func (f fizzer) Exec(out io.Writer) func(string) error {
 	}
 }
 
+// AFile reads a fizz file, and translates its contents to SQL.
 func AFile(f *os.File, t Translator) (string, error) {
 	b, err := ioutil.ReadAll(f)
 	if err != nil {
@@ -47,6 +48,7 @@ func AFile(f *os.File, t Translator) (string, error) {
 	return AString(string(b), t)
 }
 
+// AString reads a fizz string, and translates its contents to SQL.
 func AString(s string, t Translator) (string, error) {
 	b := NewBubbler(t)
 	return b.Bubble(s)

diff --git a/raw_sql.go b/raw_sql.go
@@ -4,9 +4,14 @@ import (
 	"strings"
 )
 
-func (f fizzer) RawSql(sql string) {
+func (f fizzer) RawSQL(sql string) {
 	if !strings.HasSuffix(sql, ";") {
 		sql += ";"
 	}
 	f.add(sql, nil)
 }
+
+// Deprecated: use RawSQL instead.
+func (f fizzer) RawSql(sql string) {
+	f.RawSQL(sql)
+}
diff --git a/translator.go b/translator.go
@@ -1,5 +1,7 @@
 package fizz
 
+// Translator describes the common interface to define a fizz
+// to SQL translator.
 type Translator interface {
 	CreateTable(Table) (string, error)
 	DropTable(Table) (string, error)