Skip to content

struct: escape delimiter in string slices on ReflectFrom #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
team-humaki wants to merge 1 commit into
base: main
Choose a base branch
from
Open

struct: escape delimiter in string slices on ReflectFrom #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions key.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,16 @@ func (k *Key) RangeTime(defaultVal, min, max time.Time) time.Time {
return k.RangeTimeFormat(time.RFC3339, defaultVal, min, max)
}

// escapeDelimited prepares a slice element for joining with delim.
// Backslashes are escaped first, then occurrences of delim, matching Strings().
func escapeDelimited(val, delim string) string {
if delim == "" {
return val
}
val = strings.ReplaceAll(val, `\`, `\\`)
return strings.ReplaceAll(val, delim, `\`+delim)
}

// Strings returns list of string divided by given delimiter.
func (k *Key) Strings(delim string) []string {
str := k.String()
Expand Down
2 changes: 1 addition & 1 deletion struct.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ func reflectSliceWithProperType(key *Key, field reflect.Value, delim string, all
for i := 0; i < field.Len(); i++ {
switch sliceOf {
case reflect.String:
buf.WriteString(slice.Index(i).String())
buf.WriteString(escapeDelimited(slice.Index(i).String(), delim))
case reflect.Int, reflect.Int64:
fmt.Fprint(&buf, slice.Index(i).Int())
case reflect.Uint, reflect.Uint64:
Expand Down
43 changes: 38 additions & 5 deletions struct_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,12 +639,12 @@ func Test_ReflectFromStructNonUniqueSections(t *testing.T) {
{
PublicKey: "pubClientKey",
PresharedKey: "psKey",
AllowedIPs: []string{"10.2.0.2/32,fd00:2::2/128"},
AllowedIPs: []string{"10.2.0.2/32", "fd00:2::2/128"},
},
{
PublicKey: "pubClientKey2",
PresharedKey: "psKey2",
AllowedIPs: []string{"10.2.0.3/32,fd00:2::3/128"},
AllowedIPs: []string{"10.2.0.3/32", "fd00:2::3/128"},
},
},
}
Expand All @@ -665,12 +665,12 @@ func Test_ReflectFromStructNonUniqueSections(t *testing.T) {
{
PublicKey: "pubClientKey3",
PresharedKey: "psKey3",
AllowedIPs: []string{"10.2.0.4/32,fd00:2::4/128"},
AllowedIPs: []string{"10.2.0.4/32", "fd00:2::4/128"},
},
{
PublicKey: "pubClientKey4",
PresharedKey: "psKey4",
AllowedIPs: []string{"10.2.0.5/32,fd00:2::5/128"},
AllowedIPs: []string{"10.2.0.5/32", "fd00:2::5/128"},
},
})

Expand Down Expand Up @@ -701,7 +701,7 @@ AllowedIPs = 10.2.0.5/32,fd00:2::5/128
err = cfg.Section("Peer").ReflectFrom(&testPeer{
PublicKey: "pubClientKey5",
PresharedKey: "psKey5",
AllowedIPs: []string{"10.2.0.6/32,fd00:2::6/128"},
AllowedIPs: []string{"10.2.0.6/32", "fd00:2::6/128"},
})

require.NoError(t, err)
Expand Down Expand Up @@ -857,6 +857,39 @@ func Test_Duration(t *testing.T) {
})
}

// https://github.com/go-ini/ini/issues/348
func Test_ReflectFromStringSliceWithComma(t *testing.T) {
type C struct {
Scale float32
History []string
}
in := C{
Scale: 1.5,
History: []string{
"Test One",
"Test Two",
"Test with comma, Three",
"Test Four",
},
}

f := Empty()
require.NoError(t, f.ReflectFrom(&in))

var buf bytes.Buffer
_, err := f.WriteTo(&buf)
require.NoError(t, err)
assert.Contains(t, buf.String(), `Test with comma\, Three`)

got := f.Section("").Key("History").Strings(",")
assert.Equal(t, in.History, got)

var out C
require.NoError(t, MapTo(&out, buf.Bytes()))
assert.Equal(t, in.History, out.History)
assert.Equal(t, float32(1.5), out.Scale)
}

type Employer struct {
Name string
Title string
Expand Down