feat : migrator implementation

Signed-off-by: DavidDexter <dmwangi@kineticengines.co.ke>

Author: daviddexter

.gitignore

@@ -1,2 +1 @@
-gormgx*
 cover*

README.md

@@ -47,3 +47,9 @@ gormgx.go -v make-migrations
 - Models specifications should be in one (1) go file. Preferably `models.go`
 - Override Foreign Key must be of the form `ModelNameRefer`.
 - Foreign key must be `Interface{}`. Gormgx will extract the extact model from the tags
+
+## Environment
+
+```sh
+export DATABASE_DSN="host=localhost user=gorm password=gorm dbname=gorm port=9920 sslmode=disable TimeZone=Africa/Nairobi"
+```

env.sh

@@ -0,0 +1 @@
+export DATABASE_DSN="host=localhost user=gorm password=gorm dbname=gorm port=9920 sslmode=disable TimeZone=Africa/Nairobi"

example/app/main.go

@@ -10,8 +10,13 @@ import (
 
 func main() {
 
-	dsn := "host=localhost user=gorm password=gorm dbname=gorm port=5432 sslmode=disable TimeZone=Africa/Nairobi"
-	db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
+	// dsn := "host=localhost user=gorm password=gorm dbname=gorm port=5432 sslmode=disable TimeZone=Africa/Nairobi"
+	// db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
+
+	db, err := gorm.Open(postgres.New(postgres.Config{
+		DSN:                  "host=localhost user=gorm password=gorm dbname=gorm port=5432 sslmode=disable TimeZone=Africa/Nairobi",
+		PreferSimpleProtocol: true, // disables implicit prepared statement usage
+	}), &gorm.Config{})
 
 	if err != nil {
 		panic("failed to connect database")

example/models/models.go

@@ -7,17 +7,6 @@ import (
 	"gorm.io/gorm"
 )
 
-// Product ...
-type Product struct {
-	Code  string
-	Price uint
-}
-
-// // IsModel ..
-// func (m *Product) IsModel() bool {
-// 	return true
-// }
-
 // User ...
 type User struct {
 	gorm.Model
@@ -65,9 +54,9 @@ type Accounts struct {
 }
 
 // IsModel ..
-func (m *Accounts) IsModel() bool {
-	return true
-}
+// func (m *Accounts) IsModel() bool {
+// 	return true
+// }
 
 // Credentials holds auth credentials when user logs in via afya notes console
 // This table is populated on first sign up
@@ -82,9 +71,22 @@ type Credentials struct {
 // 	return true
 // }
 
+// Product ...
+type Product struct {
+	Code    string
+	Price   uint
+	Company interface{} `gorm:"foreignKey:CompanyRefer;foreignKeyRefField:guid"`
+}
+
+// IsModel ..
+func (m *Product) IsModel() bool {
+	return true
+}
+
 // Company ....
 type Company struct {
 	ID   int
+	GUID string `gorm:"not null;unique;column:guid"`
 	Name string
 }
 

gormgx.yaml

@@ -0,0 +1,16 @@
+# Where all migrations files will be located
+migrations: migrations/*.gormgx
+
+# Where your gorm models are located
+models:
+  - example/models/models.go  
+
+# Which database type to use. Defaults to "postgres". Choices : [postgres,mysql,sqlite]
+dialect: postgres
+
+# Which driver to use. Defaults to "default". Choices : [default,cloudsqlpostgres]
+driver_name: default
+
+# Optional : set the time zone for time.Time fields. Defaults to "Africa/Nairobi"
+time_zone: Africa/Nairobi
+

pkg/commands/intialize.go pkg/commands/initialize.go

@@ -12,12 +12,12 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
-// IntializeCmd ...
-var IntializeCmd = &cli.Command{
-	Name:  definitions.IntializeCmd,
-	Usage: definitions.IntializeCmdUsage,
+// InitializeCmd ...
+var InitializeCmd = &cli.Command{
+	Name:  definitions.InitializeCmd,
+	Usage: definitions.InitializeCmdUsage,
 	Action: func(c *cli.Context) error {
-		i := initializor{runner: engine.NewRunner()}
+		i := initializer{runner: engine.NewRunner()}
 		return i.initialize()
 	},
 }
@@ -30,19 +30,22 @@ migrations: migrations/*.gormgx
 models:
   - models/models.go  
 
-# Optional: set to add "gorm.Model" to your models
-add_gorm_model: true
+# Which database type to use. Defaults to "postgres". Choices : [postgres,mysql,sqlite]
+dialect: postgres
+
+# Which driver to use. Defaults to "default". Choices : [default,cloudsqlpostgres]
+driver_name: default
 
 # Optional : set the time zone for time.Time fields. Defaults to "Africa/Nairobi"
 time_zone: Africa/Nairobi
 
 `))
 
-type initializor struct {
+type initializer struct {
 	runner definitions.Worker
 }
 
-func (i *initializor) initialize() error {
+func (i *initializer) initialize() error {
 	exists, err := i.checkIfInitialized()
 	if err != nil {
 		return err
@@ -55,7 +58,7 @@ func (i *initializor) initialize() error {
 
 // checkIfInitialized checks for the presence of gormgx.yaml file
 // returns an error if it absent
-func (i *initializor) checkIfInitialized() (bool, error) {
+func (i *initializer) checkIfInitialized() (bool, error) {
 	file, err := i.runner.GormgxFilePath()
 	if err != nil {
 		return false, err
@@ -66,7 +69,7 @@ func (i *initializor) checkIfInitialized() (bool, error) {
 	return true, nil
 }
 
-func (i *initializor) createGormgxYamlFile() error {
+func (i *initializer) createGormgxYamlFile() error {
 	path, err := i.runner.GormgxFilePath()
 	if err != nil {
 		return err
@@ -85,6 +88,6 @@ func (i *initializor) createGormgxYamlFile() error {
 		return fmt.Errorf("unable to write gormgx file: " + err.Error())
 	}
 
-	fmt.Println(definitions.AfterIntializeMessage)
+	fmt.Println(definitions.AfterInitializeMessage)
 	return nil
 }

pkg/commands/make_migrations.go

@@ -36,8 +36,8 @@ type MakeMigration interface {
 	hasError() error
 	loadYaml() MakeMigration
 	setIntent() (MakeMigration, error)
-	buildIntialIntent() (MakeMigration, error)
-	buildAfterIntialIntent() (MakeMigration, error)
+	buildInitialIntent() (MakeMigration, error)
+	buildAfterInitialIntent() (MakeMigration, error)
 }
 
 // MgxMaker ...
@@ -65,17 +65,20 @@ func NewMgxMaker(path string, verbose bool) MakeMigration {
 
 // Migrate ...
 func (m *MgxMaker) Migrate() error {
+	// check if required envs are set. Otherwise, kill the app early
+	m.runner.FetchConnectionDNSFromEnv()
+
 	// read gormgx.yaml file
 	if err := m.hasError(); err != nil {
 		return err
 	}
 	if _, err := m.loadYaml().setIntent(); err != nil {
 		return err
 	}
-	if _, err := m.buildIntialIntent(); err != nil {
+	if _, err := m.buildInitialIntent(); err != nil {
 		return err
 	}
-	if _, err := m.buildAfterIntialIntent(); err != nil {
+	if _, err := m.buildAfterInitialIntent(); err != nil {
 		return err
 	}
 	// called to catch any errors in the final steps
@@ -110,20 +113,20 @@ func (m *MgxMaker) setIntent() (MakeMigration, error) {
 	}
 
 	m.runner.PrintVerbose(m.verbose, log.InfoLevel, "Setting intent")
-	if !m.runner.CheckIntialMigrationExists() {
-		m.intent = definitions.IntialIntent
+	if !m.runner.CheckInitialMigrationExists() {
+		m.intent = definitions.InitialIntent
 		return m, nil
 	}
 
-	m.intent = definitions.AfterIntialIntent
+	m.intent = definitions.AfterInitialIntent
 	return m, nil
 }
 
-func (m *MgxMaker) buildIntialIntent() (MakeMigration, error) {
+func (m *MgxMaker) buildInitialIntent() (MakeMigration, error) {
 	if err := m.hasError(); err != nil {
 		return nil, err
 	}
-	if m.intent == definitions.IntialIntent {
+	if m.intent == definitions.InitialIntent {
 		if err := m.runner.ReadIntentModels(m.modelsPkgs, m.config.Models, m.verbose); err != nil {
 			m.errorsCache.Store(errorKey, err)
 			return nil, err
@@ -151,24 +154,24 @@ func (m *MgxMaker) buildIntialIntent() (MakeMigration, error) {
 	return m.createMigrationFiles()
 }
 
-func (m *MgxMaker) buildAfterIntialIntent() (MakeMigration, error) {
+func (m *MgxMaker) buildAfterInitialIntent() (MakeMigration, error) {
 	if err := m.hasError(); err != nil {
 		return nil, err
 	}
-	if m.intent == definitions.AfterIntialIntent {
+	if m.intent == definitions.AfterInitialIntent {
 		return m, nil
 	}
 	return m, nil
 }
 
 func (m *MgxMaker) createMigrationFiles() (MakeMigration, error) {
-	if m.intent == definitions.IntialIntent {
+	if m.intent == definitions.InitialIntent {
 		var wg sync.WaitGroup
 		for tableName, tableTree := range m.tables {
 			wg.Add(1)
 			go func(w *sync.WaitGroup, tn string, tt *definitions.TableTree, mgx *MgxMaker) {
 				defer wg.Done()
-				if err := migrator.NewMigratorWorker(tn, tt, mgx.verbose, mgx.runner).RunIntialIntent(); err != nil {
+				if err := migrator.NewMigratorWorker(tn, tt, mgx.verbose, mgx.runner).RunInitialIntent(); err != nil {
 					m.errorsCache.Store(errorKey, err)
 				}
 

pkg/definitions/consts.go

@@ -6,18 +6,19 @@ import (
 
 // context constants
 const (
-	AppName                 = "Gorm Migrations [gormgx]"
-	AppDescription          = `Gorm Migrations CLI utility manages SQL migrations for gorm. It implements the same API as Django migrations, so you should be at home if coming from Django.`
-	AppUsage                = "Making database changes ease, manageable and maintainable"
-	GormgxYamlFileName      = "gormgx.yaml"
-	IntialMigrationFileName = "00001_init.gormgx"
-	DefaultMIgrationsPath   = "migrations"
-	GormModelInterfaceFile  = "pkg/definitions/gorm_model.go"
+	AppName                  = "Gorm Migrations [gormgx]"
+	AppDescription           = `Gorm Migrations CLI utility manages SQL migrations for gorm. It implements the same API as Django migrations, so you should be at home if coming from Django.`
+	AppUsage                 = "Making database changes ease, manageable and maintainable"
+	GormgxYamlFileName       = "gormgx.yaml"
+	InitialMigrationFileName = "00001_init.gormgx"
+	DefaultMIgrationsPath    = "migrations"
+	GormModelInterfaceFile   = "pkg/definitions/gorm_model.go"
+	GormDatabaseDSNEnv       = "DATABASE_DSN"
 )
 
 // commands
 const (
-	IntializeCmd      = "init"
+	InitializeCmd     = "init"
 	MakemigrationsCmd = "make-migrations"
 	ApplyCmd          = "apply"
 	RevertCmd         = "revert"
@@ -28,7 +29,7 @@ const (
 
 // commands usage descriptions
 const (
-	IntializeCmdUsage      = "intializes the default gormgx configuration. It create gormgx.yaml in the current working directory"
+	InitializeCmdUsage     = "initializes the default gormgx configuration. It create gormgx.yaml in the current working directory"
 	MakemigrationsCmdUsage = "analyzes models and create migrations"
 	ApplyCmdUsage          = "commits migrations to the database"
 	RevertCmdUsage         = "undoes the previously performed migration"
@@ -51,14 +52,14 @@ const (
 type Intent int
 
 const (
-	// IntialIntent ...
-	IntialIntent Intent = iota
+	// InitialIntent ...
+	InitialIntent Intent = iota
 
 	// AfterIntialIntent ...
-	AfterIntialIntent
+	AfterInitialIntent
 )
 
 // response message
 var (
-	AfterIntializeMessage = emoji.Sprint(`:beer: Hurray!!! Gormgx has been intialized. Check "gormgx.yaml" file and amend it to your needs. Remember not to remove it`)
+	AfterInitializeMessage = emoji.Sprint(`:beer: Hurray!!! Gormgx has been intialized. Check "gormgx.yaml" file and amend it to your needs. Remember not to remove it`)
 )

pkg/definitions/models.go

@@ -6,10 +6,12 @@ import (
 
 // Config ...
 type Config struct {
-	Migrations   string   `yaml:"migrations"`
-	Models       []string `yaml:"models"`
-	AddGormModel bool     `yaml:"add_gorm_model"`
-	TimeZone     string   `yaml:"time_zone"`
+	Migrations string   `yaml:"migrations"`
+	Models     []string `yaml:"models"`
+	Dialect    string   `yaml:"dialect"`
+	DriverName string   `yaml:"driver_name"`
+	DSN        string   `yaml:"dsn"`
+	TimeZone   string   `yaml:"time_zone"`
 }
 
 // Model is a same model as defines in `gorm.Model`

pkg/definitions/ops.go

@@ -79,7 +79,7 @@ type OpColumn struct {
 	Size int
 
 	// the default of the the column, It's an interface since we don't know the `DatabaseType` for hand
-	Default interface{}
+	Default string
 
 	// the timezone to use for date fields. All date/time fields in gormgx are timezone by default
 	TimeZone string

pkg/definitions/worker.go

@@ -14,7 +14,7 @@ type Worker interface {
 
 	ReadYamlToconfig() (*Config, error)
 
-	CheckIntialMigrationExists() bool
+	CheckInitialMigrationExists() bool
 
 	ReadIntentModels(modelsPkgs *[]*types.Package, paths []string, verbose bool) error
 
@@ -29,4 +29,6 @@ type Worker interface {
 	NameTypeFieldsMeta(v *types.Named) *TableTree
 
 	SplitTypedNameToObjectName(t *types.Named) string
+
+	FetchConnectionDNSFromEnv() *string
 }