Update the soft delete

gongmengnan · gongmengnan · commit b51c1951df76 · 2020-04-25T16:49:11.000+08:00
1. Change the CLI flag to --add-soft-delete;
2. Change the flag in delete methods to hardDelete;
3. Add test suites for soft deletes when it's enabled;
4. Add tests for table.CanSoftDelete;
5. Change randomize.Struct to ignore the deleted_at column;
6. Fix the soft delete in slice.DeleteAll.
diff --git a/boilingcore/boilingcore.go b/boilingcore/boilingcore.go
@@ -141,7 +141,7 @@ func (s *State) Run() error {
 		PkgName:           s.Config.PkgName,
 		AddGlobal:         s.Config.AddGlobal,
 		AddPanic:          s.Config.AddPanic,
-		SoftDeletes:       s.Config.SoftDeletes,
+		AddSoftDeletes:    s.Config.AddSoftDeletes,
 		NoContext:         s.Config.NoContext,
 		NoHooks:           s.Config.NoHooks,
 		NoAutoTimestamps:  s.Config.NoAutoTimestamps,
diff --git a/boilingcore/config.go b/boilingcore/config.go
@@ -22,7 +22,7 @@ type Config struct {
 	Debug             bool     `toml:"debug,omitempty" json:"debug,omitempty"`
 	AddGlobal         bool     `toml:"add_global,omitempty" json:"add_global,omitempty"`
 	AddPanic          bool     `toml:"add_panic,omitempty" json:"add_panic,omitempty"`
-	SoftDeletes       bool     `toml:"soft_deletes,omitempty" json:"soft_deletes,omitempty"`
+	AddSoftDeletes    bool     `toml:"add_soft_deletes,omitempty" json:"add_soft_deletes,omitempty"`
 	NoContext         bool     `toml:"no_context,omitempty" json:"no_context,omitempty"`
 	NoTests           bool     `toml:"no_tests,omitempty" json:"no_tests,omitempty"`
 	NoHooks           bool     `toml:"no_hooks,omitempty" json:"no_hooks,omitempty"`
diff --git a/boilingcore/templates.go b/boilingcore/templates.go
@@ -39,7 +39,7 @@ type templateData struct {
 	// Control various generation features
 	AddGlobal         bool
 	AddPanic          bool
-	SoftDeletes       bool
+	AddSoftDeletes    bool
 	NoContext         bool
 	NoHooks           bool
 	NoAutoTimestamps  bool
diff --git a/drivers/table_test.go b/drivers/table_test.go
@@ -118,3 +118,33 @@ func TestCanLastInsertID(t *testing.T) {
 		}
 	}
 }
+
+func TestCanSoftDelete(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		Can     bool
+		Columns []Column
+	}{
+		{true, []Column{
+			{Name: "deleted_at", Type: "null.Time"},
+		}},
+		{false, []Column{
+			{Name: "deleted_at", Type: "time.Time"},
+		}},
+		{false, []Column{
+			{Name: "deleted_at", Type: "int"},
+		}},
+		{false, nil},
+	}
+
+	for i, test := range tests {
+		table := Table{
+			Columns: test.Columns,
+		}
+
+		if got := table.CanSoftDelete(); got != test.Can {
+			t.Errorf("%d) wrong: %t", i, got)
+		}
+	}
+}
diff --git a/main.go b/main.go
@@ -104,7 +104,7 @@ func main() {
 	rootCmd.PersistentFlags().BoolP("no-driver-templates", "", false, "Disable parsing of templates defined by the database driver")
 	rootCmd.PersistentFlags().BoolP("add-global-variants", "", false, "Enable generation for global variants")
 	rootCmd.PersistentFlags().BoolP("add-panic-variants", "", false, "Enable generation for panic variants")
-	rootCmd.PersistentFlags().BoolP("soft-deletes", "", false, "Enable soft deletion by updating deleted_at timestamp")
+	rootCmd.PersistentFlags().BoolP("add-soft-deletes", "", false, "Enable soft deletion by updating deleted_at timestamp")
 	rootCmd.PersistentFlags().BoolP("version", "", false, "Print the version")
 	rootCmd.PersistentFlags().BoolP("wipe", "", false, "Delete the output folder (rm -rf) before generation to ensure sanity")
 	rootCmd.PersistentFlags().StringP("struct-tag-casing", "", "snake", "Decides the casing for go structure tag names. camel, title or snake (default snake)")
@@ -170,7 +170,7 @@ func preRun(cmd *cobra.Command, args []string) error {
 		Debug:             viper.GetBool("debug"),
 		AddGlobal:         viper.GetBool("add-global-variants"),
 		AddPanic:          viper.GetBool("add-panic-variants"),
-		SoftDeletes:       viper.GetBool("soft-deletes"),
+		AddSoftDeletes:    viper.GetBool("add-soft-deletes"),
 		NoContext:         viper.GetBool("no-context"),
 		NoTests:           viper.GetBool("no-tests"),
 		NoHooks:           viper.GetBool("no-hooks"),
diff --git a/randomize/randomize.go b/randomize/randomize.go
@@ -60,6 +60,7 @@ func Struct(s *Seed, str interface{}, colTypes map[string]string, canBeNull bool
 	copyBlacklist := make([]string, len(blacklist))
 	copy(copyBlacklist, blacklist)
 	blacklist = copyBlacklist
+	blacklist = append(blacklist, "deleted_at")
 
 	sort.Strings(blacklist)
 
diff --git a/templatebin/bindata.go b/templatebin/bindata.go
diff --git a/templates/04_relationship_to_one.go.tpl b/templates/04_relationship_to_one.go.tpl
@@ -9,7 +9,7 @@
 func (o *{{$ltable.UpSingular}}) {{$rel.Foreign}}(mods ...qm.QueryMod) ({{$ftable.DownSingular}}Query) {
 	queryMods := []qm.QueryMod{
 		qm.Where("{{$fkey.ForeignColumn | $.Quotes}} = ?", o.{{$ltable.Column $fkey.Column}}),
-		{{if and $.SoftDeletes $canSoftDelete -}}
+		{{if and $.AddSoftDeletes $canSoftDelete -}}
 		qmhelper.WhereIsNull("deleted_at"),
 		{{- end}}
 	}
diff --git a/templates/05_relationship_one_to_one.go.tpl b/templates/05_relationship_one_to_one.go.tpl
@@ -9,7 +9,7 @@
 func (o *{{$ltable.UpSingular}}) {{$relAlias.Local}}(mods ...qm.QueryMod) ({{$ftable.DownSingular}}Query) {
 	queryMods := []qm.QueryMod{
 		qm.Where("{{$rel.ForeignColumn | $.Quotes}} = ?", o.{{$ltable.Column $rel.Column}}),
-        {{if and $.SoftDeletes $canSoftDelete -}}
+        {{if and $.AddSoftDeletes $canSoftDelete -}}
         qmhelper.WhereIsNull("deleted_at"),
         {{- end}}
 	}
diff --git a/templates/06_relationship_to_many.go.tpl b/templates/06_relationship_to_many.go.tpl
@@ -23,7 +23,7 @@ func (o *{{$ltable.UpSingular}}) {{$relAlias.Local}}(mods ...qm.QueryMod) {{$fta
 		{{else -}}
 	queryMods = append(queryMods,
 		qm.Where("{{$schemaForeignTable}}.{{$rel.ForeignColumn | $.Quotes}}=?", o.{{$ltable.Column $rel.Column}}),
-		{{if and $.SoftDeletes $canSoftDelete -}}
+		{{if and $.AddSoftDeletes $canSoftDelete -}}
 		qmhelper.WhereIsNull("{{$schemaForeignTable}}.{{"deleted_at" | $.Quotes}}"),
 		{{- end}}
 	)
diff --git a/templates/07_relationship_to_one_eager.go.tpl b/templates/07_relationship_to_one_eager.go.tpl
@@ -67,7 +67,7 @@ func ({{$ltable.DownSingular}}L) Load{{$rel.Foreign}}({{if $.NoContext}}e boil.E
 	query := NewQuery(
 	    qm.From(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}`),
 	    qm.WhereIn(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.{{.ForeignColumn}} in ?`, args...),
-	    {{if and $.SoftDeletes $canSoftDelete -}}
+	    {{if and $.AddSoftDeletes $canSoftDelete -}}
 	    qmhelper.WhereIsNull(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.deleted_at`),
 	    {{- end}}
     )
diff --git a/templates/08_relationship_one_to_one_eager.go.tpl b/templates/08_relationship_one_to_one_eager.go.tpl
@@ -55,7 +55,7 @@ func ({{$ltable.DownSingular}}L) Load{{$relAlias.Local}}({{if $.NoContext}}e boi
 	query := NewQuery(
 	    qm.From(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}`),
         qm.WhereIn(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.{{.ForeignColumn}} in ?`, args...),
-	    {{if and $.SoftDeletes $canSoftDelete -}}
+	    {{if and $.AddSoftDeletes $canSoftDelete -}}
 	    qmhelper.WhereIsNull(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.deleted_at`),
 	    {{- end}}
     )
diff --git a/templates/09_relationship_to_many_eager.go.tpl b/templates/09_relationship_to_many_eager.go.tpl
@@ -60,15 +60,15 @@ func ({{$ltable.DownSingular}}L) Load{{$relAlias.Local}}({{if $.NoContext}}e boi
 		qm.From("{{$schemaForeignTable}}"),
 		qm.InnerJoin("{{$schemaJoinTable}} as {{id 0 | $.Quotes}} on {{$schemaForeignTable}}.{{.ForeignColumn | $.Quotes}} = {{id 0 | $.Quotes}}.{{.JoinForeignColumn | $.Quotes}}"),
 		qm.WhereIn("{{id 0 | $.Quotes}}.{{.JoinLocalColumn | $.Quotes}} in ?", args...),
-		{{if and $.SoftDeletes $canSoftDelete -}}
+		{{if and $.AddSoftDeletes $canSoftDelete -}}
 		qmhelper.WhereIsNull("{{$schemaForeignTable}}.{{"deleted_at" | $.Quotes}}"),
 		{{- end}}
 	)
 		{{else -}}
 	query := NewQuery(
 	    qm.From(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}`),
 	    qm.WhereIn(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.{{.ForeignColumn}} in ?`, args...),
-	    {{if and $.SoftDeletes $canSoftDelete -}}
+	    {{if and $.AddSoftDeletes $canSoftDelete -}}
 	    qmhelper.WhereIsNull(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.deleted_at`),
 	    {{- end}}
     )
diff --git a/templates/13_all.go.tpl b/templates/13_all.go.tpl
@@ -3,7 +3,7 @@
 {{- $canSoftDelete := .Table.CanSoftDelete }}
 // {{$alias.UpPlural}} retrieves all the records using an executor.
 func {{$alias.UpPlural}}(mods ...qm.QueryMod) {{$alias.DownSingular}}Query {
-    {{if and .SoftDeletes $canSoftDelete -}}
+    {{if and .AddSoftDeletes $canSoftDelete -}}
     mods = append(mods, qm.From("{{$schemaTable}}"), qmhelper.WhereIsNull("{{$schemaTable}}.{{"deleted_at" | $.Quotes}}"))
     {{else -}}
 	mods = append(mods, qm.From("{{$schemaTable}}"))
diff --git a/templates/14_find.go.tpl b/templates/14_find.go.tpl
@@ -47,7 +47,7 @@ func Find{{$alias.UpSingular}}({{if .NoContext}}exec boil.Executor{{else}}ctx co
 		sel = strings.Join(strmangle.IdentQuoteSlice(dialect.LQ, dialect.RQ, selectCols), ",")
 	}
 	query := fmt.Sprintf(
-		"select %s from {{.Table.Name | .SchemaTable}} where {{if .Dialect.UseIndexPlaceholders}}{{whereClause .LQ .RQ 1 .Table.PKey.Columns}}{{else}}{{whereClause .LQ .RQ 0 .Table.PKey.Columns}}{{end}}{{if and .SoftDeletes $canSoftDelete}} and {{"deleted_at" | $.Quotes}} is null{{end}}", sel,
+		"select %s from {{.Table.Name | .SchemaTable}} where {{if .Dialect.UseIndexPlaceholders}}{{whereClause .LQ .RQ 1 .Table.PKey.Columns}}{{else}}{{whereClause .LQ .RQ 0 .Table.PKey.Columns}}{{end}}{{if and .AddSoftDeletes $canSoftDelete}} and {{"deleted_at" | $.Quotes}} is null{{end}}", sel,
 	)
 
 	q := queries.Raw(query, {{$pkNames | join ", "}})
diff --git a/templates/18_delete.go.tpl b/templates/18_delete.go.tpl
diff --git a/templates/19_reload.go.tpl b/templates/19_reload.go.tpl
diff --git a/templates/20_exists.go.tpl b/templates/20_exists.go.tpl
diff --git a/templates_test/delete.go.tpl b/templates_test/delete.go.tpl
diff --git a/templates_test/relationship_one_to_one_setops.go.tpl b/templates_test/relationship_one_to_one_setops.go.tpl
diff --git a/templates_test/singleton/boil_suites_test.go.tpl b/templates_test/singleton/boil_suites_test.go.tpl

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`func (o *{{$ltable.UpSingular}}) {{$rel.Foreign}}(mods ...qm.QueryMod) ({{$ftable.DownSingular}}Query) {`
`10`	`10`	`queryMods := []qm.QueryMod{`
`11`	`11`	`qm.Where("{{$fkey.ForeignColumn \| $.Quotes}} = ?", o.{{$ltable.Column $fkey.Column}}),`
`12`		`- {{if and $.SoftDeletes $canSoftDelete -}}`
	`12`	`+ {{if and $.AddSoftDeletes $canSoftDelete -}}`
`13`	`13`	`qmhelper.WhereIsNull("deleted_at"),`
`14`	`14`	`{{- end}}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ func (o *{{$ltable.UpSingular}}) {{$relAlias.Local}}(mods ...qm.QueryMod) {{$fta`
`23`	`23`	`{{else -}}`
`24`	`24`	`queryMods = append(queryMods,`
`25`	`25`	`qm.Where("{{$schemaForeignTable}}.{{$rel.ForeignColumn \| $.Quotes}}=?", o.{{$ltable.Column $rel.Column}}),`
`26`		`- {{if and $.SoftDeletes $canSoftDelete -}}`
	`26`	`+ {{if and $.AddSoftDeletes $canSoftDelete -}}`
`27`	`27`	`qmhelper.WhereIsNull("{{$schemaForeignTable}}.{{"deleted_at" \| $.Quotes}}"),`
`28`	`28`	`{{- end}}`
`29`	`29`	`)`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ func ({{$ltable.DownSingular}}L) Load{{$rel.Foreign}}({{if $.NoContext}}e boil.E`
`67`	`67`	`query := NewQuery(`
`68`	`68`	qm.From(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}`),
`69`	`69`	qm.WhereIn(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.{{.ForeignColumn}} in ?`, args...),
`70`		`- {{if and $.SoftDeletes $canSoftDelete -}}`
	`70`	`+ {{if and $.AddSoftDeletes $canSoftDelete -}}`
`71`	`71`	qmhelper.WhereIsNull(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.deleted_at`),
`72`	`72`	`{{- end}}`
`73`	`73`	`)`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ func ({{$ltable.DownSingular}}L) Load{{$relAlias.Local}}({{if $.NoContext}}e boi`
`55`	`55`	`query := NewQuery(`
`56`	`56`	qm.From(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}`),
`57`	`57`	qm.WhereIn(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.{{.ForeignColumn}} in ?`, args...),
`58`		`- {{if and $.SoftDeletes $canSoftDelete -}}`
	`58`	`+ {{if and $.AddSoftDeletes $canSoftDelete -}}`
`59`	`59`	qmhelper.WhereIsNull(`{{if $.Dialect.UseSchema}}{{$.Schema}}.{{end}}{{.ForeignTable}}.deleted_at`),
`60`	`60`	`{{- end}}`
`61`	`61`	`)`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func Find{{$alias.UpSingular}}({{if .NoContext}}exec boil.Executor{{else}}ctx co`
`47`	`47`	`sel = strings.Join(strmangle.IdentQuoteSlice(dialect.LQ, dialect.RQ, selectCols), ",")`
`48`	`48`	`}`
`49`	`49`	`query := fmt.Sprintf(`
`50`		`- "select %s from {{.Table.Name \| .SchemaTable}} where {{if .Dialect.UseIndexPlaceholders}}{{whereClause .LQ .RQ 1 .Table.PKey.Columns}}{{else}}{{whereClause .LQ .RQ 0 .Table.PKey.Columns}}{{end}}{{if and .SoftDeletes $canSoftDelete}} and {{"deleted_at" \| $.Quotes}} is null{{end}}", sel,`
	`50`	`+ "select %s from {{.Table.Name \| .SchemaTable}} where {{if .Dialect.UseIndexPlaceholders}}{{whereClause .LQ .RQ 1 .Table.PKey.Columns}}{{else}}{{whereClause .LQ .RQ 0 .Table.PKey.Columns}}{{end}}{{if and .AddSoftDeletes $canSoftDelete}} and {{"deleted_at" \| $.Quotes}} is null{{end}}", sel,`
`51`	`51`	`)`
`52`	`52`
`53`	`53`	`q := queries.Raw(query, {{$pkNames \| join ", "}})`