Complete functional options pattern refactoring for special pluginclaude/refactor-plugins-functional-options

Agent-Logs-Url: https://github.com/Loyalsoldier/geoip/sessions/0483b641-15da-4630-a3ad-53f8d1c65fe9

Co-authored-by: Loyalsoldier <[email protected]>

7 files changed, 233 insertions, 107 deletions

diff --git a/lookup.go b/lookup.go
index cc1fed65..c672fbff 100644
--- a/lookup.go
+++ b/lookup.go
@@ -254,11 +254,9 @@ func getInputForLookup(format, name, uri, dir string) lib.InputConverter {
 }
 
 func getOutputForLookup(search string, searchList ...string) lib.OutputConverter {
-	return &special.Lookup{
-		Type:        special.TypeLookup,
-		Action:      lib.ActionOutput,
-		Description: special.DescLookup,
-		Search:      search,
-		SearchList:  searchList,
-	}
+	return special.NewLookup(
+		lib.ActionOutput,
+		special.WithLookupSearch(search),
+		special.WithLookupSearchList(searchList),
+	)
 }
diff --git a/merge.go b/merge.go
index 8e8108ed..58cbc7e5 100644
--- a/merge.go
+++ b/merge.go
@@ -41,38 +41,30 @@ var mergeCmd = &cobra.Command{
 }
 
 func getInputForMerge() lib.InputConverter {
-	return &special.Stdin{
-		Type:        special.TypeStdin,
-		Action:      lib.ActionAdd,
-		Description: special.DescStdin,
-		Name:        "temp",
-	}
+	return special.NewStdin(
+		lib.ActionAdd,
+		special.WithStdinName("temp"),
+	)
 }
 
 func getOutputForMerge(otype string) lib.OutputConverter {
 	switch lib.IPType(otype) {
 	case lib.IPv4:
-		return &special.Stdout{
-			Type:        special.TypeStdout,
-			Action:      lib.ActionOutput,
-			Description: special.DescStdout,
-			OnlyIPType:  lib.IPv4,
-		}
+		return special.NewStdout(
+			lib.ActionOutput,
+			special.WithStdoutOnlyIPType(lib.IPv4),
+		)
 
 	case lib.IPv6:
-		return &special.Stdout{
-			Type:        special.TypeStdout,
-			Action:      lib.ActionOutput,
-			Description: special.DescStdout,
-			OnlyIPType:  lib.IPv6,
-		}
+		return special.NewStdout(
+			lib.ActionOutput,
+			special.WithStdoutOnlyIPType(lib.IPv6),
+		)
 
 	default:
-		return &special.Stdout{
-			Type:        special.TypeStdout,
-			Action:      lib.ActionOutput,
-			Description: special.DescStdout,
-		}
+		return special.NewStdout(
+			lib.ActionOutput,
+		)
 	}
 
 }
diff --git a/plugin/special/cutter.go b/plugin/special/cutter.go
index 509cddbb..0ef88ea5 100644
--- a/plugin/special/cutter.go
+++ b/plugin/special/cutter.go
@@ -15,14 +15,48 @@ const (
 
 func init() {
 	lib.RegisterInputConfigCreator(TypeCutter, func(action lib.Action, data json.RawMessage) (lib.InputConverter, error) {
-		return newCutter(action, data)
+		return NewCutterFromBytes(action, data)
 	})
-	lib.RegisterInputConverter(TypeCutter, &Cutter{
+	lib.RegisterInputConverter(TypeCutter, &cutter{
 		Description: DescCutter,
 	})
 }
 
-func newCutter(action lib.Action, data json.RawMessage) (lib.InputConverter, error) {
+func NewCutter(action lib.Action, opts ...lib.InputOption) lib.InputConverter {
+	c := &cutter{
+		Type:        TypeCutter,
+		Action:      action,
+		Description: DescCutter,
+	}
+
+	for _, opt := range opts {
+		if opt != nil {
+			opt(c)
+		}
+	}
+
+	return c
+}
+
+func WithCutterWantedList(lists []string) lib.InputOption {
+	return func(c lib.InputConverter) {
+		wantList := make(map[string]bool)
+		for _, want := range lists {
+			if want = strings.ToUpper(strings.TrimSpace(want)); want != "" {
+				wantList[want] = true
+			}
+		}
+		c.(*cutter).Want = wantList
+	}
+}
+
+func WithCutterOnlyIPType(onlyIPType lib.IPType) lib.InputOption {
+	return func(c lib.InputConverter) {
+		c.(*cutter).OnlyIPType = onlyIPType
+	}
+}
+
+func NewCutterFromBytes(action lib.Action, data []byte) (lib.InputConverter, error) {
 	var tmp struct {
 		Want       []string   `json:"wantedList"`
 		OnlyIPType lib.IPType `json:"onlyIPType"`
@@ -50,16 +84,14 @@ func newCutter(action lib.Action, data json.RawMessage) (lib.InputConverter, err
 		return nil, fmt.Errorf("❌ [type %s] wantedList must be specified", TypeCutter)
 	}
 
-	return &Cutter{
-		Type:        TypeCutter,
-		Action:      action,
-		Description: DescCutter,
-		Want:        wantList,
-		OnlyIPType:  tmp.OnlyIPType,
-	}, nil
+	return NewCutter(
+		action,
+		WithCutterWantedList(tmp.Want),
+		WithCutterOnlyIPType(tmp.OnlyIPType),
+	), nil
 }
 
-type Cutter struct {
+type cutter struct {
 	Type        string
 	Action      lib.Action
 	Description string
@@ -67,19 +99,19 @@ type Cutter struct {
 	OnlyIPType  lib.IPType
 }
 
-func (c *Cutter) GetType() string {
+func (c *cutter) GetType() string {
 	return c.Type
 }
 
-func (c *Cutter) GetAction() lib.Action {
+func (c *cutter) GetAction() lib.Action {
 	return c.Action
 }
 
-func (c *Cutter) GetDescription() string {
+func (c *cutter) GetDescription() string {
 	return c.Description
 }
 
-func (c *Cutter) Input(container lib.Container) (lib.Container, error) {
+func (c *cutter) Input(container lib.Container) (lib.Container, error) {
 	ignoreIPType := lib.GetIgnoreIPType(c.OnlyIPType)
 
 	for entry := range container.Loop() {
diff --git a/plugin/special/lookup.go b/plugin/special/lookup.go
index 96735146..25dd2521 100644
--- a/plugin/special/lookup.go
+++ b/plugin/special/lookup.go
@@ -18,14 +18,42 @@ const (
 
 func init() {
 	lib.RegisterOutputConfigCreator(TypeLookup, func(action lib.Action, data json.RawMessage) (lib.OutputConverter, error) {
-		return newLookup(action, data)
+		return NewLookupFromBytes(action, data)
 	})
-	lib.RegisterOutputConverter(TypeLookup, &Lookup{
+	lib.RegisterOutputConverter(TypeLookup, &lookup{
 		Description: DescLookup,
 	})
 }
 
-func newLookup(action lib.Action, data json.RawMessage) (lib.OutputConverter, error) {
+func NewLookup(action lib.Action, opts ...lib.OutputOption) lib.OutputConverter {
+	l := &lookup{
+		Type:        TypeLookup,
+		Action:      action,
+		Description: DescLookup,
+	}
+
+	for _, opt := range opts {
+		if opt != nil {
+			opt(l)
+		}
+	}
+
+	return l
+}
+
+func WithLookupSearch(search string) lib.OutputOption {
+	return func(l lib.OutputConverter) {
+		l.(*lookup).Search = strings.TrimSpace(search)
+	}
+}
+
+func WithLookupSearchList(searchList []string) lib.OutputOption {
+	return func(l lib.OutputConverter) {
+		l.(*lookup).SearchList = searchList
+	}
+}
+
+func NewLookupFromBytes(action lib.Action, data []byte) (lib.OutputConverter, error) {
 	var tmp struct {
 		Search     string   `json:"search"`
 		SearchList []string `json:"searchList"`
@@ -42,16 +70,14 @@ func newLookup(action lib.Action, data json.RawMessage) (lib.OutputConverter, er
 		return nil, fmt.Errorf("❌ [type %s | action %s] please specify an IP or a CIDR as search target", TypeLookup, action)
 	}
 
-	return &Lookup{
-		Type:        TypeLookup,
-		Action:      action,
-		Description: DescLookup,
-		Search:      tmp.Search,
-		SearchList:  tmp.SearchList,
-	}, nil
+	return NewLookup(
+		action,
+		WithLookupSearch(tmp.Search),
+		WithLookupSearchList(tmp.SearchList),
+	), nil
 }
 
-type Lookup struct {
+type lookup struct {
 	Type        string
 	Action      lib.Action
 	Description string
@@ -59,19 +85,19 @@ type Lookup struct {
 	SearchList  []string
 }
 
-func (l *Lookup) GetType() string {
+func (l *lookup) GetType() string {
 	return l.Type
 }
 
-func (l *Lookup) GetAction() lib.Action {
+func (l *lookup) GetAction() lib.Action {
 	return l.Action
 }
 
-func (l *Lookup) GetDescription() string {
+func (l *lookup) GetDescription() string {
 	return l.Description
 }
 
-func (l *Lookup) Output(container lib.Container) error {
+func (l *lookup) Output(container lib.Container) error {
 	switch strings.Contains(l.Search, "/") {
 	case true: // CIDR
 		if _, err := netip.ParsePrefix(l.Search); err != nil {
diff --git a/plugin/special/private.go b/plugin/special/private.go
index 1bc170bc..74dc1f44 100644
--- a/plugin/special/private.go
+++ b/plugin/special/private.go
@@ -38,14 +38,36 @@ var privateCIDRs = []string{
 
 func init() {
 	lib.RegisterInputConfigCreator(TypePrivate, func(action lib.Action, data json.RawMessage) (lib.InputConverter, error) {
-		return newPrivate(action, data)
+		return NewPrivateFromBytes(action, data)
 	})
-	lib.RegisterInputConverter(TypePrivate, &Private{
+	lib.RegisterInputConverter(TypePrivate, &private{
 		Description: DescPrivate,
 	})
 }
 
-func newPrivate(action lib.Action, data json.RawMessage) (lib.InputConverter, error) {
+func NewPrivate(action lib.Action, opts ...lib.InputOption) lib.InputConverter {
+	p := &private{
+		Type:        TypePrivate,
+		Action:      action,
+		Description: DescPrivate,
+	}
+
+	for _, opt := range opts {
+		if opt != nil {
+			opt(p)
+		}
+	}
+
+	return p
+}
+
+func WithPrivateOnlyIPType(onlyIPType lib.IPType) lib.InputOption {
+	return func(p lib.InputConverter) {
+		p.(*private).OnlyIPType = onlyIPType
+	}
+}
+
+func NewPrivateFromBytes(action lib.Action, data []byte) (lib.InputConverter, error) {
 	var tmp struct {
 		OnlyIPType lib.IPType `json:"onlyIPType"`
 	}
@@ -56,34 +78,32 @@ func newPrivate(action lib.Action, data json.RawMessage) (lib.InputConverter, er
 		}
 	}
 
-	return &Private{
-		Type:        TypePrivate,
-		Action:      action,
-		Description: DescPrivate,
-		OnlyIPType:  tmp.OnlyIPType,
-	}, nil
+	return NewPrivate(
+		action,
+		WithPrivateOnlyIPType(tmp.OnlyIPType),
+	), nil
 }
 
-type Private struct {
+type private struct {
 	Type        string
 	Action      lib.Action
 	Description string
 	OnlyIPType  lib.IPType
 }
 
-func (p *Private) GetType() string {
+func (p *private) GetType() string {
 	return p.Type
 }
 
-func (p *Private) GetAction() lib.Action {
+func (p *private) GetAction() lib.Action {
 	return p.Action
 }
 
-func (p *Private) GetDescription() string {
+func (p *private) GetDescription() string {
 	return p.Description
 }
 
-func (p *Private) Input(container lib.Container) (lib.Container, error) {
+func (p *private) Input(container lib.Container) (lib.Container, error) {
 	entry, found := container.GetEntry(entryNamePrivate)
 	if !found {
 		entry = lib.NewEntry(entryNamePrivate)
diff --git a/plugin/special/stdin.go b/plugin/special/stdin.go
index f2f9cf9c..8e4a2e28 100644
--- a/plugin/special/stdin.go
+++ b/plugin/special/stdin.go
@@ -17,14 +17,42 @@ const (
 
 func init() {
 	lib.RegisterInputConfigCreator(TypeStdin, func(action lib.Action, data json.RawMessage) (lib.InputConverter, error) {
-		return newStdin(action, data)
+		return NewStdinFromBytes(action, data)
 	})
-	lib.RegisterInputConverter(TypeStdin, &Stdin{
+	lib.RegisterInputConverter(TypeStdin, &stdin{
 		Description: DescStdin,
 	})
 }
 
-func newStdin(action lib.Action, data json.RawMessage) (lib.InputConverter, error) {
+func NewStdin(action lib.Action, opts ...lib.InputOption) lib.InputConverter {
+	s := &stdin{
+		Type:        TypeStdin,
+		Action:      action,
+		Description: DescStdin,
+	}
+
+	for _, opt := range opts {
+		if opt != nil {
+			opt(s)
+		}
+	}
+
+	return s
+}
+
+func WithStdinName(name string) lib.InputOption {
+	return func(s lib.InputConverter) {
+		s.(*stdin).Name = name
+	}
+}
+
+func WithStdinOnlyIPType(onlyIPType lib.IPType) lib.InputOption {
+	return func(s lib.InputConverter) {
+		s.(*stdin).OnlyIPType = onlyIPType
+	}
+}
+
+func NewStdinFromBytes(action lib.Action, data []byte) (lib.InputConverter, error) {
 	var tmp struct {
 		Name       string     `json:"name"`
 		OnlyIPType lib.IPType `json:"onlyIPType"`
@@ -40,16 +68,14 @@ func newStdin(action lib.Action, data json.RawMessage) (lib.InputConverter, erro
 		return nil, fmt.Errorf("❌ [type %s | action %s] missing name", TypeStdin, action)
 	}
 
-	return &Stdin{
-		Type:        TypeStdin,
-		Action:      action,
-		Description: DescStdin,
-		Name:        tmp.Name,
-		OnlyIPType:  tmp.OnlyIPType,
-	}, nil
+	return NewStdin(
+		action,
+		WithStdinName(tmp.Name),
+		WithStdinOnlyIPType(tmp.OnlyIPType),
+	), nil
 }
 
-type Stdin struct {
+type stdin struct {
 	Type        string
 	Action      lib.Action
 	Description string
@@ -57,19 +83,19 @@ type Stdin struct {
 	OnlyIPType  lib.IPType
 }
 
-func (s *Stdin) GetType() string {
+func (s *stdin) GetType() string {
 	return s.Type
 }
 
-func (s *Stdin) GetAction() lib.Action {
+func (s *stdin) GetAction() lib.Action {
 	return s.Action
 }
 
-func (s *Stdin) GetDescription() string {
+func (s *stdin) GetDescription() string {
 	return s.Description
 }
 
-func (s *Stdin) Input(container lib.Container) (lib.Container, error) {
+func (s *stdin) Input(container lib.Container) (lib.Container, error) {
 	entry := lib.NewEntry(s.Name)
 
 	scanner := bufio.NewScanner(os.Stdin)
diff --git a/plugin/special/stdout.go b/plugin/special/stdout.go
index 614deaac..76edde3c 100644
--- a/plugin/special/stdout.go
+++ b/plugin/special/stdout.go
@@ -18,14 +18,48 @@ const (
 
 func init() {
 	lib.RegisterOutputConfigCreator(TypeStdout, func(action lib.Action, data json.RawMessage) (lib.OutputConverter, error) {
-		return newStdout(action, data)
+		return NewStdoutFromBytes(action, data)
 	})
-	lib.RegisterOutputConverter(TypeStdout, &Stdout{
+	lib.RegisterOutputConverter(TypeStdout, &stdout{
 		Description: DescStdout,
 	})
 }
 
-func newStdout(action lib.Action, data json.RawMessage) (lib.OutputConverter, error) {
+func NewStdout(action lib.Action, opts ...lib.OutputOption) lib.OutputConverter {
+	s := &stdout{
+		Type:        TypeStdout,
+		Action:      action,
+		Description: DescStdout,
+	}
+
+	for _, opt := range opts {
+		if opt != nil {
+			opt(s)
+		}
+	}
+
+	return s
+}
+
+func WithStdoutWantedList(lists []string) lib.OutputOption {
+	return func(s lib.OutputConverter) {
+		s.(*stdout).Want = lists
+	}
+}
+
+func WithStdoutExcludedList(lists []string) lib.OutputOption {
+	return func(s lib.OutputConverter) {
+		s.(*stdout).Exclude = lists
+	}
+}
+
+func WithStdoutOnlyIPType(onlyIPType lib.IPType) lib.OutputOption {
+	return func(s lib.OutputConverter) {
+		s.(*stdout).OnlyIPType = onlyIPType
+	}
+}
+
+func NewStdoutFromBytes(action lib.Action, data []byte) (lib.OutputConverter, error) {
 	var tmp struct {
 		Want       []string   `json:"wantedList"`
 		Exclude    []string   `json:"excludedList"`
@@ -38,17 +72,15 @@ func newStdout(action lib.Action, data json.RawMessage) (lib.OutputConverter, er
 		}
 	}
 
-	return &Stdout{
-		Type:        TypeStdout,
-		Action:      action,
-		Description: DescStdout,
-		Want:        tmp.Want,
-		Exclude:     tmp.Exclude,
-		OnlyIPType:  tmp.OnlyIPType,
-	}, nil
+	return NewStdout(
+		action,
+		WithStdoutWantedList(tmp.Want),
+		WithStdoutExcludedList(tmp.Exclude),
+		WithStdoutOnlyIPType(tmp.OnlyIPType),
+	), nil
 }
 
-type Stdout struct {
+type stdout struct {
 	Type        string
 	Action      lib.Action
 	Description string
@@ -57,19 +89,19 @@ type Stdout struct {
 	OnlyIPType  lib.IPType
 }
 
-func (s *Stdout) GetType() string {
+func (s *stdout) GetType() string {
 	return s.Type
 }
 
-func (s *Stdout) GetAction() lib.Action {
+func (s *stdout) GetAction() lib.Action {
 	return s.Action
 }
 
-func (s *Stdout) GetDescription() string {
+func (s *stdout) GetDescription() string {
 	return s.Description
 }
 
-func (s *Stdout) Output(container lib.Container) error {
+func (s *stdout) Output(container lib.Container) error {
 	for _, name := range s.filterAndSortList(container) {
 		entry, found := container.GetEntry(name)
 		if !found {
@@ -89,7 +121,7 @@ func (s *Stdout) Output(container lib.Container) error {
 	return nil
 }
 
-func (s *Stdout) filterAndSortList(container lib.Container) []string {
+func (s *stdout) filterAndSortList(container lib.Container) []string {
 	excludeMap := make(map[string]bool)
 	for _, exclude := range s.Exclude {
 		if exclude = strings.ToUpper(strings.TrimSpace(exclude)); exclude != "" {
@@ -125,7 +157,7 @@ func (s *Stdout) filterAndSortList(container lib.Container) []string {
 	return list
 }
 
-func (s *Stdout) generateCIDRList(entry *lib.Entry) ([]string, error) {
+func (s *stdout) generateCIDRList(entry *lib.Entry) ([]string, error) {
 	entryList, err := entry.MarshalText(lib.GetIgnoreIPType(s.OnlyIPType))
 	if err != nil {
 		return nil, err