Allow exclude to skip invalid interfaces, close #23

Author: jinzhu

examples/query.go

@@ -18,7 +18,8 @@ var _ = genconfig.Config{
 		"date": field.Time{},
 		"json": JSON{},
 	},
-	IncludeStructs: []any{},
+	IncludeStructs:    []any{},
+	ExcludeInterfaces: []any{Entity(nil)},
 }
 
 type Query[T any] interface {
@@ -72,6 +73,11 @@ type Query[T any] interface {
 	FilterWithTime(start, end time.Time) ([]T, error)
 }
 
+type Entity interface {
+	TableName() string
+	Key() any
+}
+
 type Params struct {
 	Name string
 	Age  int

internal/gen/generator.go

@@ -50,6 +50,7 @@ type (
 		IfaceName string
 		Doc       string
 		Methods   []*Method
+		err       error
 	}
 	Method struct {
 		Name      string
@@ -186,6 +187,12 @@ func (g *Generator) Gen() error {
 			}
 		}
 
+		for _, iface := range file.Interfaces {
+			if iface.err != nil {
+				return fmt.Errorf("invalid interface %s: %w", iface.Name, iface.err)
+			}
+		}
+
 		if len(file.Interfaces) == 0 && len(file.Structs) == 0 {
 			continue
 		}
@@ -621,15 +628,27 @@ func (p *File) processInterfaceType(n *ast.TypeSpec, data *ast.InterfaceType) In
 
 			if len(method.Result) == 0 {
 				if method.SQL.Where == "" && method.SQL.Select == "" || method.SQL.Raw != "" {
-					panic(fmt.Sprintf("Method %s.%s: finish method must return at least one value (last return value must be error)", n.Name.Name, method.Name))
+					if r.err == nil {
+						r.err = fmt.Errorf("Method %s.%s: finish method must return at least one value (last return value must be error)", n.Name.Name, method.Name)
+					}
+					return r
 				}
 			} else if len(method.Result) > 2 {
-				panic(fmt.Sprintf("Method %s.%s: maximum number of return values allowed is 2 (first as data, second as error)", n.Name.Name, method.Name))
+				if r.err == nil {
+					r.err = fmt.Errorf("Method %s.%s: maximum number of return values allowed is 2 (first as data, second as error)", n.Name.Name, method.Name)
+				}
+				return r
 			} else if strings.ToLower(method.Result[len(method.Result)-1].Type) != "error" {
 				if len(method.Result) == 1 {
-					panic(fmt.Sprintf("Method %s.%s: when only one return value is defined, its type must be error", n.Name.Name, method.Name))
+					if r.err == nil {
+						r.err = fmt.Errorf("Method %s.%s: when only one return value is defined, its type must be error", n.Name.Name, method.Name)
+					}
+					return r
+				}
+				if r.err == nil {
+					r.err = fmt.Errorf("Method %s.%s: when two return values are defined, the second must be error", n.Name.Name, method.Name)
 				}
-				panic(fmt.Sprintf("Method %s.%s: when two return values are defined, the second must be error", n.Name.Name, method.Name))
+				return r
 			}
 		}
 	}

internal/gen/generator_test.go

@@ -1,6 +1,7 @@
 package gen
 
 import (
+	"fmt"
 	"go/ast"
 	"go/parser"
 	"go/token"
@@ -78,6 +79,58 @@ func TestGeneratorWithQueryInterface(t *testing.T) {
 	}
 }
 
+func TestExcludeInterfacesSkipsInvalidInterfaces(t *testing.T) {
+	writeSample := func(dir string, withExclude bool) string {
+		if err := os.WriteFile(filepath.Join(dir, "go.mod"), []byte("module temp.test\n\ngo 1.21\n"), 0o644); err != nil {
+			t.Fatalf("write go.mod: %v", err)
+		}
+
+		cfg := "ExcludeInterfaces: []any{Entity(nil)},"
+		if !withExclude {
+			cfg = ""
+		}
+
+		src := fmt.Sprintf(`package sample
+
+import "gorm.io/cli/gorm/genconfig"
+
+var _ = genconfig.Config{
+	%s
+}
+
+type Entity interface {
+	TableName() string
+}
+`, cfg)
+
+		path := filepath.Join(dir, "sample.go")
+		if err := os.WriteFile(path, []byte(src), 0o644); err != nil {
+			t.Fatalf("write sample.go: %v", err)
+		}
+		return path
+	}
+
+	runGen := func(file string) error {
+		g := &Generator{Files: map[string]*File{}, outPath: filepath.Join(filepath.Dir(file), "out")}
+		if err := g.Process(file); err != nil {
+			return err
+		}
+		return g.Gen()
+	}
+
+	withExcludeDir := t.TempDir()
+	withExcludeFile := writeSample(withExcludeDir, true)
+	if err := runGen(withExcludeFile); err != nil {
+		t.Fatalf("generator should succeed when interface is excluded: %v", err)
+	}
+
+	withoutExcludeDir := t.TempDir()
+	withoutExcludeFile := writeSample(withoutExcludeDir, false)
+	if err := runGen(withoutExcludeFile); err == nil {
+		t.Fatalf("expected generator failure when interface is not excluded")
+	}
+}
+
 func TestProcessStructType(t *testing.T) {
 	fileset := token.NewFileSet()
 	file, err := parser.ParseFile(fileset, "../../examples/models/user.go", nil, parser.AllErrors)