refactor: rename Iface to Interface

go-kod · Feb 16, 2024 · 68a0998 · 68a0998
1 parent a096105
commit 68a0998
Show file tree

Hide file tree

Showing 14 changed files with 162 additions and 161 deletions.
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -17,7 +17,8 @@ tasks:
       - task: test
 
   build:gowork:
-    sources: 
+    run: once
+    sources:
       - "**/**.go"
     generates:
       - go.work

diff --git a/cmd/kod/internal/generate_generator.go b/cmd/kod/internal/generate_generator.go
@@ -699,7 +699,7 @@ func (g *generator) generateRegisteredComponents(p printFn) {
 		// To get a reflect.Type for an interface, we have to first get a type
 		// of its pointer and then resolve the underlying type. See:
 		//   https://pkg.go.dev/reflect#example-TypeOf
-		p(`		Iface: %s((*%s)(nil)).Elem(),`, reflect.qualify("TypeOf"), g.componentRef(comp))
+		p(`		Interface: %s((*%s)(nil)).Elem(),`, reflect.qualify("TypeOf"), g.componentRef(comp))
 		p(`		Impl: %s(%s{}),`, reflect.qualify("TypeOf"), comp.implName())
 		p("		Refs: `%s`,", strings.Join(refNames, ",\n"))
 		p(`		LocalStubFn: %s,`, localStubFn)

diff --git a/examples/helloworld/kod_gen.go b/examples/helloworld/kod_gen.go
diff --git a/internal/registry/registry.go b/internal/registry/registry.go
@@ -14,7 +14,7 @@ type LocalStubFnInfo struct {
 // Registration is the registration information for a component.
 type Registration struct {
 	Name        string       // full package-prefixed component name
-	Iface       reflect.Type // interface type for the component
+	Interface   reflect.Type // interface type for the component
 	Impl        reflect.Type // implementation type (struct)
 	Refs        string
 	LocalStubFn func(context.Context, *LocalStubFnInfo) any

diff --git a/kod.go b/kod.go
@@ -254,10 +254,10 @@ type Kod struct {
 
 	hooker *hooks.Hooker
 
-	regs            []*Registration
-	registryByName  map[string]*Registration
-	registryByIface map[reflect.Type]*Registration
-	registryByImpl  map[reflect.Type]*Registration
+	regs                []*Registration
+	registryByName      map[string]*Registration
+	registryByInterface map[reflect.Type]*Registration
+	registryByImpl      map[reflect.Type]*Registration
 
 	components map[string]any
 	opts       options
@@ -282,13 +282,13 @@ func newKod(opts options) (*Kod, error) {
 			Log:             logConfig{Level: "info"},
 			ShutdownTimeout: 5 * time.Second,
 		},
-		hooker:          hooks.New(),
-		regs:            registry.All(),
-		registryByName:  make(map[string]*Registration),
-		registryByIface: make(map[reflect.Type]*Registration),
-		registryByImpl:  make(map[reflect.Type]*Registration),
-		components:      make(map[string]any),
-		opts:            opts,
+		hooker:              hooks.New(),
+		regs:                registry.All(),
+		registryByName:      make(map[string]*Registration),
+		registryByInterface: make(map[reflect.Type]*Registration),
+		registryByImpl:      make(map[reflect.Type]*Registration),
+		components:          make(map[string]any),
+		opts:                opts,
 	}
 
 	kod.register(opts.registrations)
@@ -333,7 +333,7 @@ func (k *Kod) register(regs []*Registration) {
 
 	for _, v := range k.regs {
 		k.registryByName[v.Name] = v
-		k.registryByIface[v.Iface] = v
+		k.registryByInterface[v.Interface] = v
 		k.registryByImpl[v.Impl] = v
 	}
 }

diff --git a/registry.go b/registry.go
@@ -35,7 +35,7 @@ func (k *Kod) getImpl(ctx context.Context, t reflect.Type) (any, error) {
 // getIntf returns the component for the given interface type.
 func (k *Kod) getIntf(ctx context.Context, t reflect.Type, caller string) (any, error) {
 
-	reg, ok := k.registryByIface[t]
+	reg, ok := k.registryByInterface[t]
 	if !ok {
 		return nil, fmt.Errorf("kod: no component registered for interface %v", t)
 	}
@@ -67,7 +67,7 @@ func (k *Kod) get(ctx context.Context, reg *Registration) (any, error) {
 		return c, nil
 	}
 
-	if fake, ok := k.opts.fakes[reg.Iface]; ok {
+	if fake, ok := k.opts.fakes[reg.Interface]; ok {
 		// We have a fake registered for this component.
 		return fake, nil
 	}

diff --git a/tests/case1/kod_gen.go b/tests/case1/kod_gen.go
diff --git a/tests/case2/case_test.go b/tests/case2/case_test.go
@@ -25,10 +25,10 @@ func TestRun(t *testing.T) {
 			return t.Run(ctx)
 		}, kod.WithRegistrations(
 			&kod.Registration{
-				Name:  "github.com/go-kod/kod/Main",
-				Iface: reflect.TypeOf((*kod.Main)(nil)).Elem(),
-				Impl:  reflect.TypeOf(App{}),
-				Refs:  `⟦73dc6a0b:KoDeDgE:github.com/go-kod/kod/Main→github.com/go-kod/kod/tests/case2/Test1Component⟧`,
+				Name:      "github.com/go-kod/kod/Main",
+				Interface: reflect.TypeOf((*kod.Main)(nil)).Elem(),
+				Impl:      reflect.TypeOf(App{}),
+				Refs:      `⟦73dc6a0b:KoDeDgE:github.com/go-kod/kod/Main→github.com/go-kod/kod/tests/case2/Test1Component⟧`,
 				LocalStubFn: func(ctx context.Context, info *kod.LocalStubFnInfo) any {
 					var interceptors []kod.Interceptor
 					if h, ok := info.Impl.(interface{ Interceptors() []kod.Interceptor }); ok {
@@ -43,10 +43,10 @@ func TestRun(t *testing.T) {
 				},
 			},
 			&kod.Registration{
-				Name:  "github.com/go-kod/kod/tests/case2/Test1Component",
-				Iface: reflect.TypeOf((*Test1Component)(nil)).Elem(),
-				Impl:  reflect.TypeOf(test1Component{}),
-				Refs:  `⟦3dc9f060:KoDeDgE:github.com/go-kod/kod/tests/case2/Test1Component→github.com/go-kod/kod/tests/case2/Test2Component⟧`,
+				Name:      "github.com/go-kod/kod/tests/case2/Test1Component",
+				Interface: reflect.TypeOf((*Test1Component)(nil)).Elem(),
+				Impl:      reflect.TypeOf(test1Component{}),
+				Refs:      `⟦3dc9f060:KoDeDgE:github.com/go-kod/kod/tests/case2/Test1Component→github.com/go-kod/kod/tests/case2/Test2Component⟧`,
 				LocalStubFn: func(ctx context.Context, info *kod.LocalStubFnInfo) any {
 					var interceptors []kod.Interceptor
 					if h, ok := info.Impl.(interface{ Interceptors() []kod.Interceptor }); ok {
@@ -61,10 +61,10 @@ func TestRun(t *testing.T) {
 				},
 			},
 			&kod.Registration{
-				Name:  "github.com/go-kod/kod/tests/case2/Test2Component",
-				Iface: reflect.TypeOf((*Test2Component)(nil)).Elem(),
-				Impl:  reflect.TypeOf(test2Component{}),
-				Refs:  `⟦1767cee9:KoDeDgE:github.com/go-kod/kod/tests/case2/Test2Component→github.com/go-kod/kod/tests/case2/Test1Component⟧`,
+				Name:      "github.com/go-kod/kod/tests/case2/Test2Component",
+				Interface: reflect.TypeOf((*Test2Component)(nil)).Elem(),
+				Impl:      reflect.TypeOf(test2Component{}),
+				Refs:      `⟦1767cee9:KoDeDgE:github.com/go-kod/kod/tests/case2/Test2Component→github.com/go-kod/kod/tests/case2/Test1Component⟧`,
 				LocalStubFn: func(ctx context.Context, info *kod.LocalStubFnInfo) any {
 					var interceptors []kod.Interceptor
 					if h, ok := info.Impl.(interface{ Interceptors() []kod.Interceptor }); ok {

diff --git a/tests/case2/kod_gen.go b/tests/case2/kod_gen.go