Merge pull request #32 from LUSHDigital/feature/builtin-names-conflict

Feature/builtin names conflict

Makefile

@@ -1,9 +1,9 @@
-OLD_SHA:=$(shell shasum -a 256 main-packr.go | cut -d' ' -f1)
-NEW_SHA= $(shell shasum -a 256 main-packr.go | cut -d' ' -f1)
+OLD_SHA:=$(shell shasum -a 256 a_main-packr.go | cut -d' ' -f1)
+NEW_SHA= $(shell shasum -a 256 a_main-packr.go | cut -d' ' -f1)
 
 all: test install post
 test:
-	go test -v ./...
+	go test -v -count 1 ./...
 	go build
 	docker-compose --no-ansi -f docker-compose.yml up -d --force-recreate
 	sleep 5
@@ -12,7 +12,7 @@ test:
 	rm -rf modelgen
 	rm -rf ./generated_models
 test-ci:
-	go test -v ./...
+	go test -v -count 1 ./...
 	go build
 	docker-compose --no-ansi -f docker-compose.yml up -d --force-recreate
 	sleep 30 # annoying, but for ci.
@@ -26,6 +26,6 @@ install:
 	packr && go install
 post:
 	@if [ "$(NEW_SHA)" != "$(OLD_SHA)" ]; then\
-        echo "sha comparison failed on main-packr.go";\
+        echo "sha comparison failed on a_main-packr.go";\
 		exit 1;\
     fi

generate.go

@@ -104,6 +104,8 @@ func getTables() (tables map[string]string) {
 	return tables
 }
 
+// GetOrderFromComment reads the modelgen:1 type comments and returns
+// the integer part on the right
 func GetOrderFromComment(comment string) (order int) {
 	if !strings.HasPrefix(comment, "modelgen") {
 		return
@@ -120,11 +122,17 @@ func GetOrderFromComment(comment string) (order int) {
 	return
 }
 
+// backtick is needed is the user picked a table name
+// which conflicts with a builtin keyword, example "order"
+func backtick(s string) string { return "`" + s + "`" }
+
+// ToStructs takes an 'EXPLAIN' statement and transforms it's output
+// into structs.
 func ToStructs(tables map[string]string) []tmpl.TmplStruct {
 	var explained = make(map[string][]sqltypes.Explain)
 	for table := range tables {
 		var expl []sqltypes.Explain
-		rows, err := database.Query("EXPLAIN " + table)
+		rows, err := database.Query("EXPLAIN " + backtick(table))
 		if err != nil {
 			log.Fatal(err)
 		}

init.sql

@@ -2,6 +2,15 @@ CREATE DATABASE `modelgen_tests`;
 
 USE `modelgen_tests`;
 
+-- order is a builtin, tests should pass despite this
+DROP TABLE IF EXISTS `order`;
+
+-- only one field should not break despite the special cases.
+CREATE TABLE `order` (
+  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
 DROP TABLE IF EXISTS `common_cases`;
 
 CREATE TABLE `common_cases` (

tmpl/model.html

@@ -29,7 +29,7 @@
 // Insert a new {{.Model.Name}} row in the {{.Model.TableName}} table
 func ({{.Receiver}} *{{.Model.Name}}) Insert(qu Queryer) (lastInsertID int64, err error) {
     const stmt = "INSERT INTO {{.Model.TableName}} ({{.Model.Fields | insert_fields}}) VALUES ({{.Model.Fields | insert_values}})"
-    res, err := qu.Exec(stmt, {{ . | insert_args }})
+    res, err := qu.Exec(stmt{{ . | insert_args }})
     if err != nil {
         return 0, err
     }
@@ -39,7 +39,7 @@
 // Update an existing {{.Model.Name}} row in the {{.Model.TableName}} table.
 func ({{.Receiver}} *{{.Model.Name}}) Update(qu Queryer, id int64) (int64, error) {
     const stmt = "UPDATE {{.Model.TableName}} SET {{ . | update_values }} WHERE id = ?"
-    result, err := qu.Exec(stmt, {{ . | update_args }} , id)
+    result, err := qu.Exec(stmt, {{ . | update_args }} id)
     if err != nil {
         return 0, err
     }

tmpl/tmpl.go

@@ -7,16 +7,16 @@ import (
 )
 
 var FuncMap = template.FuncMap{
-	"insert_fields": GetInsertFields,
-	"insert_values": GetInsertValues,
-	"insert_args":   GetInsertArgs,
-	"scan_fields":   GetScanFields,
-	"update_args":   GetUpdateArgs,
-	"update_values": GetUpdateValues,
-	"upsert_fields": GetUpsertFields,
-	"upsert_values": GetUpsertValues,
+	"insert_fields":       GetInsertFields,
+	"insert_values":       GetInsertValues,
+	"insert_args":         GetInsertArgs,
+	"scan_fields":         GetScanFields,
+	"update_args":         GetUpdateArgs,
+	"update_values":       GetUpdateValues,
+	"upsert_fields":       GetUpsertFields,
+	"upsert_values":       GetUpsertValues,
 	"upsert_on_duplicate": GetUpsertOnDuplicate,
-	"upsert_args": GetUpsertArgs,
+	"upsert_args":         GetUpsertArgs,
 }
 
 func GetInsertFields(fields []TmplField) string {
@@ -55,7 +55,10 @@ func GetInsertArgs(m StructTmplData) string {
 		}
 		parts = append(parts, fmt.Sprintf("%s.%s", m.Receiver, fl.Name))
 	}
-	return strings.Join(parts, ", ")
+	if len(parts) > 0 {
+		return ", " + strings.Join(parts, ", ")
+	}
+	return ""
 }
 
 func GetScanFields(m StructTmplData) template.HTML {
@@ -75,7 +78,10 @@ func GetUpdateArgs(m StructTmplData) template.HTML {
 		}
 		parts = append(parts, fmt.Sprintf("%s.%s", m.Receiver, fl.Name))
 	}
-	return template.HTML(strings.Join(parts, ", "))
+	if len(parts) > 0 {
+		return template.HTML(strings.Join(parts, ", ") + ", ")
+	}
+	return ""
 }
 
 func GetUpdateValues(m StructTmplData) string {
@@ -142,4 +148,4 @@ func GetUpsertArgs(m StructTmplData) string {
 		parts = append(parts, fmt.Sprintf("%s.%s", m.Receiver, fl.Name))
 	}
 	return strings.Join(parts, ", ")
-}
+}