Add StringConfig for all string flags

This config allows configuring to automatically trim whitespace of string value flags. This includes slices and maps. I had to plumb this down to the string flag level, because of compiler errors.
urfave · Dec 5, 2022 · 5dd5dd0 · 5dd5dd0
1 parent 21f28d7
commit 5dd5dd0
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 27 deletions.
diff --git a/flag_string.go b/flag_string.go
@@ -2,18 +2,31 @@ package cli
 
 import (
 	"fmt"
+	"strings"
 )
 
-type StringFlag = FlagBase[string, NoConfig, stringValue]
+type StringFlag = FlagBase[string, StringConfig, stringValue]
+
+// StringConfig defines the configuration for string flags
+type StringConfig struct {
+	// Whether to trim whitespace of parsed value
+	TrimSpace bool
+}
 
 // -- string Value
-type stringValue string
+type stringValue struct {
+	destination *string
+	trimSpace   bool
+}
 
 // Below functions are to satisfy the ValueCreator interface
 
-func (i stringValue) Create(val string, p *string, c NoConfig) Value {
+func (i stringValue) Create(val string, p *string, c StringConfig) Value {
 	*p = val
-	return (*stringValue)(p)
+	return &stringValue{
+		destination: p,
+		trimSpace:   c.TrimSpace,
+	}
 }
 
 func (i stringValue) ToString(b string) string {
@@ -26,13 +39,21 @@ func (i stringValue) ToString(b string) string {
 // Below functions are to satisfy the flag.Value interface
 
 func (s *stringValue) Set(val string) error {
-	*s = stringValue(val)
+	if s.trimSpace {
+		val = strings.TrimSpace(val)
+	}
+	*s.destination = val
 	return nil
 }
 
-func (s *stringValue) Get() any { return string(*s) }
+func (s *stringValue) Get() any { return *s.destination }
 
-func (s *stringValue) String() string { return string(*s) }
+func (s *stringValue) String() string {
+	if s.destination != nil {
+		return *s.destination
+	}
+	return ""
+}
 
 func (cCtx *Context) String(name string) string {
 	if v, ok := cCtx.Value(name).(string); ok {

diff --git a/flag_string_map.go b/flag_string_map.go
@@ -2,10 +2,10 @@ package cli
 
 import "flag"
 
-type StringMap = MapBase[string, NoConfig, stringValue]
-type StringMapFlag = FlagBase[map[string]string, NoConfig, StringMap]
+type StringMap = MapBase[string, StringConfig, stringValue]
+type StringMapFlag = FlagBase[map[string]string, StringConfig, StringMap]
 
-var NewStringMap = NewMapBase[string, NoConfig, stringValue]
+var NewStringMap = NewMapBase[string, StringConfig, stringValue]
 
 // StringMap looks up the value of a local StringMapFlag, returns
 // nil if not found

diff --git a/flag_string_slice.go b/flag_string_slice.go
@@ -4,10 +4,10 @@ import (
 	"flag"
 )
 
-type StringSlice = SliceBase[string, NoConfig, stringValue]
-type StringSliceFlag = FlagBase[[]string, NoConfig, StringSlice]
+type StringSlice = SliceBase[string, StringConfig, stringValue]
+type StringSliceFlag = FlagBase[[]string, StringConfig, StringSlice]
 
-var NewStringSlice = NewSliceBase[string, NoConfig, stringValue]
+var NewStringSlice = NewSliceBase[string, StringConfig, stringValue]
 
 // StringSlice looks up the value of a local StringSliceFlag, returns
 // nil if not found

diff --git a/flag_test.go b/flag_test.go
@@ -176,6 +176,10 @@ func TestFlagsFromEnv(t *testing.T) {
 		{"foobar", 0, &Uint64Flag{Name: "seconds", EnvVars: []string{"SECONDS"}}, `could not parse "foobar" as uint64 value from environment variable "SECONDS" for flag seconds: .*`},
 
 		{"foo=bar,empty=", map[string]string{"foo": "bar", "empty": ""}, &StringMapFlag{Name: "names", EnvVars: []string{"NAMES"}}, ""},
+
+		{" foo", "foo", &StringFlag{Name: "names", EnvVars: []string{"NAMES"}, Config: StringConfig{TrimSpace: true}}, ""},
+		{"foo , bar ", []string{"foo", "bar"}, &StringSliceFlag{Name: "names", EnvVars: []string{"NAMES"}, Config: StringConfig{TrimSpace: true}}, ""},
+		{"foo= bar ", map[string]string{"foo": "bar"}, &StringMapFlag{Name: "names", EnvVars: []string{"NAMES"}, Config: StringConfig{TrimSpace: true}}, ""},
 	}
 
 	for i, test := range flagTests {

diff --git a/godoc-current.txt b/godoc-current.txt
@@ -131,8 +131,8 @@ var MarkdownDocTemplate = `{{if gt .SectionNum 0}}% {{ .App.Name }} {{ .SectionN
 var NewFloat64Slice = NewSliceBase[float64, NoConfig, float64Value]
 var NewInt64Slice = NewSliceBase[int64, IntegerConfig, int64Value]
 var NewIntSlice = NewSliceBase[int, IntegerConfig, intValue]
-var NewStringMap = NewMapBase[string, NoConfig, stringValue]
-var NewStringSlice = NewSliceBase[string, NoConfig, stringValue]
+var NewStringMap = NewMapBase[string, StringConfig, stringValue]
+var NewStringSlice = NewSliceBase[string, StringConfig, stringValue]
 var NewUint64Slice = NewSliceBase[uint64, IntegerConfig, uint64Value]
 var NewUintSlice = NewSliceBase[uint, IntegerConfig, uintValue]
 var OsExiter = os.Exit
@@ -1028,15 +1028,21 @@ func (i SliceBase[T, C, VC]) ToString(t []T) string
 func (i *SliceBase[T, C, VC]) Value() []T
     Value returns the slice of values set by this flag
 
-type StringFlag = FlagBase[string, NoConfig, stringValue]
+type StringConfig struct {
+	// Whether to trim whitespace of parsed value
+	TrimSpace bool
+}
+    StringConfig defines the configuration for string flags
+
+type StringFlag = FlagBase[string, StringConfig, stringValue]
 
-type StringMap = MapBase[string, NoConfig, stringValue]
+type StringMap = MapBase[string, StringConfig, stringValue]
 
-type StringMapFlag = FlagBase[map[string]string, NoConfig, StringMap]
+type StringMapFlag = FlagBase[map[string]string, StringConfig, StringMap]
 
-type StringSlice = SliceBase[string, NoConfig, stringValue]
+type StringSlice = SliceBase[string, StringConfig, stringValue]
 
-type StringSliceFlag = FlagBase[[]string, NoConfig, StringSlice]
+type StringSliceFlag = FlagBase[[]string, StringConfig, StringSlice]
 
 type SuggestCommandFunc func(commands []*Command, provided string) string
 

diff --git a/testdata/godoc-v3.x.txt b/testdata/godoc-v3.x.txt
@@ -131,8 +131,8 @@ var MarkdownDocTemplate = `{{if gt .SectionNum 0}}% {{ .App.Name }} {{ .SectionN
 var NewFloat64Slice = NewSliceBase[float64, NoConfig, float64Value]
 var NewInt64Slice = NewSliceBase[int64, IntegerConfig, int64Value]
 var NewIntSlice = NewSliceBase[int, IntegerConfig, intValue]
-var NewStringMap = NewMapBase[string, NoConfig, stringValue]
-var NewStringSlice = NewSliceBase[string, NoConfig, stringValue]
+var NewStringMap = NewMapBase[string, StringConfig, stringValue]
+var NewStringSlice = NewSliceBase[string, StringConfig, stringValue]
 var NewUint64Slice = NewSliceBase[uint64, IntegerConfig, uint64Value]
 var NewUintSlice = NewSliceBase[uint, IntegerConfig, uintValue]
 var OsExiter = os.Exit
@@ -1028,15 +1028,21 @@ func (i SliceBase[T, C, VC]) ToString(t []T) string
 func (i *SliceBase[T, C, VC]) Value() []T
     Value returns the slice of values set by this flag
 
-type StringFlag = FlagBase[string, NoConfig, stringValue]
+type StringConfig struct {
+	// Whether to trim whitespace of parsed value
+	TrimSpace bool
+}
+    StringConfig defines the configuration for string flags
+
+type StringFlag = FlagBase[string, StringConfig, stringValue]
 
-type StringMap = MapBase[string, NoConfig, stringValue]
+type StringMap = MapBase[string, StringConfig, stringValue]
 
-type StringMapFlag = FlagBase[map[string]string, NoConfig, StringMap]
+type StringMapFlag = FlagBase[map[string]string, StringConfig, StringMap]
 
-type StringSlice = SliceBase[string, NoConfig, stringValue]
+type StringSlice = SliceBase[string, StringConfig, stringValue]
 
-type StringSliceFlag = FlagBase[[]string, NoConfig, StringSlice]
+type StringSliceFlag = FlagBase[[]string, StringConfig, StringSlice]
 
 type SuggestCommandFunc func(commands []*Command, provided string) string