feat : initial migrator implementation

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

Author: daviddexter

README.md

@@ -45,3 +45,5 @@ gormgx.go -v make-migrations
 ## Gotchas
 
 - 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

example/app/main.go

@@ -3,28 +3,11 @@ package main
 import (
 	"time"
 
-	"github.com/lib/pq"
-
+	"github.com/kineticengines/gorm-migrations/example/models"
 	"gorm.io/driver/postgres"
 	"gorm.io/gorm"
 )
 
-// Accounts ...
-type Accounts struct {
-	gorm.Model
-	GUID              *string `gorm:"not null;unique;column:guid"`
-	FirstName         *string `gorm:"not null;column:first_name"`
-	LastName          string  `gorm:"not null;column:last_name"`
-	IsAccountBillable *bool   `gorm:"default:true;column:is_account_billable"`
-
-	Active           *bool          `gorm:"default:true"`
-	HasAcceptedTerms bool           `gorm:"default:false"`
-	AmountPaid       float32        `gorm:"null;type:numeric"`
-	AmountDeducted   *float32       `gorm:"type:numeric;default:0"`
-	Date             time.Time      `gorm:"not null"`
-	Grouped          pq.StringArray `gorm:"type:varchar(64)[];"`
-}
-
 func main() {
 
 	dsn := "host=localhost user=gorm password=gorm dbname=gorm port=5432 sslmode=disable TimeZone=Africa/Nairobi"
@@ -35,21 +18,22 @@ func main() {
 	}
 
 	// Migrate the schema
-	_ = db.AutoMigrate(&Accounts{})
+	_ = db.AutoMigrate(&models.Accounts{}, &models.Company{}, &models.User{}, &models.Organisations{}, &models.Credentials{}, &models.Company{})
 
 	// Create
 	guid := "0afca2aa-7de1-11eb-8398-434ca8dedd68"
 	fname := "dx"
-	db.Create(&Accounts{FirstName: &fname, LastName: "ter", GUID: &guid})
+	lname := "ter"
+	db.Create(&models.Accounts{FirstName: &fname, LastName: &lname, GUID: &guid})
 
 	// Read
-	var account Accounts
+	var account models.Accounts
 	db.First(&account, 1)
 	db.First(&account, "guid = ?", guid)
 
 	db.Model(&account).Update("last_name", "new-last-name")
 
-	db.Model(&account).Updates(Accounts{HasAcceptedTerms: true, Date: time.Now()})
+	db.Model(&account).Updates(models.Accounts{HasAcceptedTerms: true, Date: time.Now()})
 
 	// Delete - delete product
 	db.Delete(&account, 1)

example/models/models.go

@@ -13,17 +13,24 @@ type Product struct {
 	Price uint
 }
 
+// // IsModel ..
+// func (m *Product) IsModel() bool {
+// 	return true
+// }
+
 // User ...
 type User struct {
-	Name string
-	Age  uint
-	Product
+	gorm.Model
+	Name         string
+	Age          uint
+	CompanyRefer int
+	Company      Company `gorm:"foreignKey:CompanyRefer"`
 }
 
-// IsModel ..
-func (m *User) IsModel() bool {
-	return true
-}
+// // IsModel ..
+// func (m *User) IsModel() bool {
+// 	return true
+// }
 
 // Organisations is the parent of each individual account
 type Organisations struct {
@@ -32,10 +39,10 @@ type Organisations struct {
 	OrganisationCode *int32  `gorm:"not null;unique;column:organisation_code"`
 }
 
-// IsModel ..
-func (m *Organisations) IsModel() bool {
-	return true
-}
+// // IsModel ..
+// func (m *Organisations) IsModel() bool {
+// 	return true
+// }
 
 // Accounts is the child/children of an organisation. An organisation must have at least one
 // acoount
@@ -54,6 +61,7 @@ type Accounts struct {
 	AmountDeducted    *float32       `gorm:"type:numeric;default:0"`
 	Date              time.Time      `gorm:"not null"`
 	Grouped           pq.StringArray `gorm:"type:varchar(64)[];"`
+	Company           interface{}    `gorm:"foreignKey:CompanyRefer"`
 }
 
 // IsModel ..
@@ -68,3 +76,19 @@ type Credentials struct {
 	AccountID string `gorm:"not null;unique;column:account_id"`
 	Password  string `gorm:"type:varchar(255)"`
 }
+
+// // IsModel ..
+// func (m *Credentials) IsModel() bool {
+// 	return true
+// }
+
+// Company ....
+type Company struct {
+	ID   int
+	Name string
+}
+
+// IsModel ..
+func (m *Company) IsModel() bool {
+	return true
+}

pkg/commands/intialize.go

@@ -33,6 +33,9 @@ models:
 # Optional: set to add "gorm.Model" to your models
 add_gorm_model: true
 
+# Optional : set the time zone for time.Time fields. Defaults to "Africa/Nairobi"
+time_zone: Africa/Nairobi
+
 `))
 
 type initializor struct {

pkg/commands/make_migrations.go

@@ -25,7 +25,7 @@ var MakeMigrationCmd = &cli.Command{
 		dir, _ := os.Getwd()
 		configPath = filepath.Join(dir, definitions.GormgxYamlFileName)
 		verbose := c.Bool("v")
-		return NewMgxMaker(configPath, engine.NewRunner(), verbose).Migrate()
+		return NewMgxMaker(configPath, verbose).Migrate()
 	},
 }
 
@@ -53,9 +53,14 @@ type MgxMaker struct {
 }
 
 // NewMgxMaker ...
-func NewMgxMaker(path string, runner definitions.Worker, verbose bool) MakeMigration {
-	return &MgxMaker{modelsPath: path, verbose: verbose, errorsCache: &sync.Map{}, runner: runner,
-		modelsPkgs: &[]*types.Package{}, tables: map[string]*definitions.TableTree{}}
+func NewMgxMaker(path string, verbose bool) MakeMigration {
+	return &MgxMaker{
+		modelsPath:  path,
+		verbose:     verbose,
+		errorsCache: &sync.Map{},
+		runner:      engine.NewRunner(),
+		modelsPkgs:  &[]*types.Package{},
+		tables:      map[string]*definitions.TableTree{}}
 }
 
 // Migrate ...
@@ -163,7 +168,7 @@ func (m *MgxMaker) createMigrationFiles() (MakeMigration, error) {
 			wg.Add(1)
 			go func(w *sync.WaitGroup, tn string, tt *definitions.TableTree, mgx *MgxMaker) {
 				defer wg.Done()
-				if err := migrator.NewMigratorWorker(tn, tt, m.verbose).RunIntialIntent(); err != nil {
+				if err := migrator.NewMigratorWorker(tn, tt, mgx.verbose, mgx.runner).RunIntialIntent(); err != nil {
 					m.errorsCache.Store(errorKey, err)
 				}
 

pkg/definitions/basic_types.go

@@ -23,5 +23,7 @@ const (
 	String     BasicType = "string"
 	Compound   BasicType = "compound"
 	Time       BasicType = "time"
+	NullTime   BasicType = "nulltime"
+	Bytes      BasicType = "bytes"
 	Nil        BasicType = "nil"
 )

pkg/definitions/models.go

@@ -9,6 +9,7 @@ type Config struct {
 	Migrations   string   `yaml:"migrations"`
 	Models       []string `yaml:"models"`
 	AddGormModel bool     `yaml:"add_gorm_model"`
+	TimeZone     string   `yaml:"time_zone"`
 }
 
 // Model is a same model as defines in `gorm.Model`

pkg/definitions/ops.go

@@ -0,0 +1,123 @@
+package definitions
+
+// Op identifier of operations that can be invoked
+type Op int
+
+const (
+
+	// CreateModelOp creates a new model and the corresponding database table
+	CreateModelOp Op = iota
+
+	// DeleteModelOp deletes a model and drops its database table
+	DeleteModelOp
+
+	// RenameModelOp renames a model and renames its database table
+	RenameModelOp
+
+	// AlterModelTableOp renames the database table for a model
+	AlterModelTableOp
+
+	// AlterUniqueTogetherOp changes the unique constraints of a model
+	AlterUniqueTogetherOp
+
+	// AlterIndexTogetherOp changes the indexes of a model
+	AlterIndexTogetherOp
+
+	// AlterOrderWithRespectToOp creates or deletes the _order column for a model
+	AlterOrderWithRespectToOp
+
+	// AlterModelOptionsOp changes various model options without affecting the database
+	AlterModelOptionsOp
+
+	// AddFieldOp adds a field to a model and the corresponding column in the database
+	AddFieldOp
+
+	// RemoveFieldOp removes a field from a model and drops the corresponding column from the database
+	RemoveFieldOp
+
+	// AlterFieldOp changes a field’s definition and alters its database column if necessary
+	AlterFieldOp
+
+	// RenameFieldOp renames a field and, if necessary, also its database column
+	RenameFieldOp
+
+	// AddIndexOp creates an index in the database table for the model
+	AddIndexOp
+
+	// RemoveIndexOp removes an index in the database table for the model
+	RemoveIndexOp
+)
+
+// FieldConstraint ...
+type FieldConstraint int
+
+const (
+
+	// OnDeleteCascadeConstraint ...
+	OnDeleteCascadeConstraint FieldConstraint = 1
+
+	// OnUpdateCascaseConstraint ...
+	OnUpdateCascaseConstraint
+)
+
+// OpColumn ...
+type OpColumn struct {
+
+	// this is the column name. If name is provided by the tags, gormgx will use that.
+	// Otherwise, lowercase, underscore separated name from struct will be used
+	CanonicalName string
+
+	FieldType BasicType
+
+	// the type of the field that corresponds to what the database expects
+	DatabaseType string
+
+	// whether this column can take nulls
+	IsNull bool
+
+	// the maximum number of characters. this is for `VARCHAR`, INT and Floats types
+	Size int
+
+	// the default of the the column, It's an interface since we don't know the `DatabaseType` for hand
+	Default interface{}
+
+	// the timezone to use for date fields. All date/time fields in gormgx are timezone by default
+	TimeZone string
+
+	IsNullable bool
+
+	IsPrimaryKey bool
+
+	IsAutoIncrement bool
+
+	// whether this column should considered as an index
+	IsIndex bool
+
+	IsUnique bool
+
+	IsForeignKey bool
+
+	// the table that this column is foreignKey to. the value will be like `Model.Field`
+	ForeignKeyTo string
+
+	ForeignKeyConstraints FieldConstraint
+
+	// applied for floats data types
+	Precision int
+
+	Scale int
+}
+
+// Operation describes a single operation with all it's relevant metadata
+type Operation struct {
+	Op        Op
+	TableName string
+	Columns   []*OpColumn
+}
+
+// MigrationDump ...
+type MigrationDump struct {
+	IsInitial    bool        `yaml:"is_initial"`
+	Dependencies []string    `yaml:"dependencies"`
+	Operations   []Operation `yaml:"operations"`
+}

pkg/definitions/schema_data_types.go

@@ -0,0 +1,64 @@
+package definitions
+
+import (
+	"fmt"
+)
+
+// SchemaDataType ...
+type SchemaDataType interface {
+	DataTypeOf() string
+}
+
+// PostgresSchemaDataType ....
+type PostgresSchemaDataType struct{}
+
+// DataTypeOf ...
+func (p *PostgresSchemaDataType) DataTypeOf(field OpColumn) string {
+	switch field.FieldType {
+	case Bool:
+		return "boolean"
+	case Int, Int8, Int16, Int32, Int64, Uint, Uint8, Uint16, Uint32, Uint64:
+		size := field.Size
+		if field.FieldType == Uint {
+			size++
+		}
+		if field.IsAutoIncrement {
+			switch {
+			case size <= 16:
+				return "smallserial"
+			case size <= 32:
+				return "serial"
+			default:
+				return "bigserial"
+			}
+		} else {
+			switch {
+			case size <= 16:
+				return "smallint"
+			case size <= 32:
+				return "integer"
+			default:
+				return "bigint"
+			}
+		}
+	case Float32, Float64:
+		if field.Precision > 0 {
+			if field.Scale > 0 {
+				return fmt.Sprintf("numeric(%d, %d)", field.Precision, field.Scale)
+			}
+			return fmt.Sprintf("numeric(%d)", field.Precision)
+		}
+		return "decimal"
+	case String:
+		if field.Size > 0 {
+			return fmt.Sprintf("varchar(%d)", field.Size)
+		}
+		return "text"
+	case Time:
+		return "timestamptz"
+	case Bytes:
+		return "bytea"
+	}
+
+	return string(field.FieldType)
+}