Add Map() and FilterFunc() #21
Conversation
…form properties to a map - this is useful when library makers do not want to expose any internal libraries they may be leveraging or force customers to depend on their data structures, map with filters provides more flexibility for users to filter an property in between
properties.go
Outdated
| @@ -647,6 +622,33 @@ func (p *Properties) WriteComment(w io.Writer, prefix string, enc Encoding) (n i | |||
| return | |||
| } | |||
|
|
|||
| // ToMap returns a copy of the properties as a map - useful when users of library are themselves | |||
There was a problem hiding this comment.
Pls remove the - useful ... part since you don't know what users will want to use this for.
properties.go
Outdated
| return m | ||
| } | ||
|
|
||
| /// FilterFunc returns a copy of the properties which includes the values |
There was a problem hiding this comment.
Only two slashes for the comment.
properties_test.go
Outdated
| } | ||
|
|
||
| func TestProperties_ToMapWith(t *testing.T) { | ||
| func TestFilterFunc(t *testing.T) { |
There was a problem hiding this comment.
func TestFilterFunc(t *testing.T) {
input := "key=value\nabc=def"
p := mustParse(t, input)
pp := p.FilterFunc(func(k, v string) bool {
return k != "abc"
})
m := map[string]string{"key": "value"}
assert.Equal(t, pp.ToMap(), m)
}
|
Done |
properties.go
Outdated
| @@ -622,6 +622,30 @@ func (p *Properties) WriteComment(w io.Writer, prefix string, enc Encoding) (n i | |||
| return | |||
| } | |||
|
|
|||
| // ToMap returns a copy of the properties as a map | |||
There was a problem hiding this comment.
Pls add a full stop at the end.
There was a problem hiding this comment.
name it as Map() -- it is mirror image of String( ) ?
There was a problem hiding this comment.
added full stop and pushed ...
There was a problem hiding this comment.
Let me know -- I can rename and push - thanks.
There was a problem hiding this comment.
Maybe you can do a quick dig through the stdlib to find some precedence. I don't think they have ToXXX functions there. Map could work but might be too generic.
properties_test.go
Outdated
| @@ -825,6 +825,22 @@ func TestMerge(t *testing.T) { | |||
| assert.Equal(t, p1.MustGet("key"), "another value") | |||
| assert.Equal(t, p1.GetComment("key"), "another comment") | |||
| } | |||
| func TestToMap(t *testing.T) { | |||
|
blank line - added. |
|
Please let me know if there's anything else that is needed; You may choose a better name instead of ToMap( ). Thanks for your help! |
|
The code looks good. Kids kept me busy today so I didn't get time to think about the name. Did you do any research in the stdlib by any chance? I should have time to merge this tomorrow. |
|
Seems like you have handsful - My little one is in love with slides off late; so that kept me busy as well. I'll take a look tomorrow - Thanks. |
|
There are examples for both |
* Map() exports the properties as a map[string]string. * FilterFunc() allows filtering through a boolean function.
magiconair
changed the title
|
I've merged the PR but apparently not in a way that auto-closes this one. :( Attribution is on you, though. Thanks for the change and your quick replies. |
Please review again and merge.