Commit graph

207 commits

Author SHA1 Message Date
Matt Surabian
1967d93db7 Fixed #36: Changed Marshal to Unmarshal throughout. 2015-09-08 08:24:57 -04:00
akutz
0a4a93b685 [110] Default Values Specify Type
This patch adds a feature, if enabled, will infer a value's type from
its default value no matter from where else the value is set. This is
particularly important when working with environment variables. For
example:

    package main

    import (
      "fmt"
      "os"

      "github.com/spf13/viper"
    )

    func print(name string, val interface{}) {
      fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val)
    }

    func main() {
      viper.BindEnv("mykey", "MYPREFIX_MYKEY")
      viper.SetDefault("mykey", []string{})
      os.Setenv("MYPREFIX_MYKEY", "a b c")

      v1 := viper.GetStringSlice("mykey")
      v2 := viper.Get("mykey")

      print("v1", v1)
      print("v2", v2)
    }

When this program is executed the following is emitted:

    [0]akutz@pax:ex$ ./ex1
    v1             []string       [a b c]
    v2             string         a b c
    [0]akutz@pax:ex$

You may wonder, why is this important? Just use the GetStringSlice
function. Well, it *becomes* important when dealing with marshaling.
If we update the above program to this:

    package main

    import (
      "fmt"
      "os"

      "github.com/spf13/viper"
    )

    type Data struct {
      MyKey []string
    }

    func print(name string, val interface{}) {
      fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val)
    }

    func main() {
      viper.BindEnv("mykey", "MYPREFIX_MYKEY")
      viper.SetDefault("mykey", []string{})
      os.Setenv("MYPREFIX_MYKEY", "a b c")

      v1 := viper.GetStringSlice("mykey")
      v2 := viper.Get("mykey")

      print("v1", v1)
      print("v2", v2)

      d := &Data{}
      viper.Marshal(d)
      print("d.MyKey", d.MyKey)
    }

Now we can see the issue when we execute the updated program:

    [0]akutz@pax:ex$ ./ex2
    v1             []string       [a b c]
    v2             string         a b c
    d.MyKey        []string       []
    [0]akutz@pax:ex$

The marshalled data structure's field MyKey is empty when in fact it
should have a string slice equal to, in value, []string {"a", "b",
"c"}.

The problem is that viper's Marshal function calls AllSettings which
ultimately uses the Get function. The Get function does try to infer
the value's type, but it does so using the type of the value retrieved
using this logic:

    Get has the behavior of returning the value associated with the
    first place from where it is set. Viper will check in the
    following order:

      * override
      * flag
      * env
      * config file
      * key/value store
      * default

While the above order is the one we want when retrieving the values,
this patch enables users to decide if it's the order they want to be
used when inferring a value's type. To that end the function
SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true)
is called, a call to the Get function will now first check a key's
default value, if set, when inferring a value's type. This is
demonstrated using a modified version of the same program above:

    package main

    import (
      "fmt"
      "os"

      "github.com/spf13/viper"
    )

    type Data struct {
      MyKey []string
    }

    func print(name string, val interface{}) {
      fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val)
    }

    func main() {
      viper.BindEnv("mykey", "MYPREFIX_MYKEY")
      viper.SetDefault("mykey", []string{})
      os.Setenv("MYPREFIX_MYKEY", "a b c")

      v1 := viper.GetStringSlice("mykey")
      v2 := viper.Get("mykey")

      print("v1", v1)
      print("v2", v2)

      d1 := &Data{}
      viper.Marshal(d1)
      print("d1.MyKey", d1.MyKey)

      viper.SetTypeByDefaultValue(true)

      d2 := &Data{}
      viper.Marshal(d2)
      print("d2.MyKey", d2.MyKey)
    }

Now the following is emitted:

    [0]akutz@pax:ex$ ./ex3
    v1             []string       [a b c]
    v2             string         a b c
    d1.MyKey       []string       []
    d2.MyKey       []string       [a b c]
    [0]akutz@pax:ex$
2015-09-08 08:23:06 -04:00
jackspirou
3c0ff861e3 running tests again 2015-08-26 08:50:40 -04:00
jackspirou
09ba0a6954 fixing second slice type needed 2015-08-26 08:50:40 -04:00
jackspirou
d028fd65ba changing import statements back 2015-08-26 08:50:40 -04:00
jackspirou
cc1c9a82a5 typo: slice type needed 2015-08-26 08:50:40 -04:00
jackspirou
0a12778a8c using my own version of github.com/spf13/cast for now 2015-08-26 08:50:40 -04:00
jackspirou
b9316c3299 adding GetStringMapStringSlice method 2015-08-26 08:50:40 -04:00
Vlad Didenko
9fca10189b Fixed #73 2015-08-17 00:11:40 -05:00
Vlad Didenko
fa137328f6 Fixed #68 2015-08-17 00:09:59 -05:00
jackspirou
2abb1bebfd Readme fixes and small edits 2015-07-30 10:46:19 -07:00
Vlad Didenko
f14e1baa25 Fixes #83 2015-07-30 10:35:06 -07:00
Maxime Horcholle
1e6a237e05 Syntax highlighting 2015-07-30 10:28:50 -07:00
Kiril Zvezdarov
db7ff930a1 AddSecureRemoteProvider adds the secret keyring to the default provider struct 2015-06-21 19:19:00 -04:00
Kiril Zvezdarov
8e930a9714 Revert "The AddSecureRemoteProvider function didn't add secretKeyring to the remoteProvider struct."
This reverts commit ca00a9b4f7.
2015-06-21 19:13:01 -04:00
chalupaul
ca00a9b4f7 The AddSecureRemoteProvider function didn't add secretKeyring to the remoteProvider struct. 2015-06-21 19:09:06 -04:00
Vlad Didenko
12f7ec6566 Fixes #87 2015-06-21 18:58:48 -04:00
Dotan Nahum
28ada1e5b0 Nested keys properly recurse on map[interface{}]interface{} 2015-06-21 18:51:43 -04:00
bep
be5ff3e484 Make the remote features optional 2015-05-30 21:28:45 +02:00
Bjørn Erik Pedersen
d62d4bb4c6 Merge pull request #72 from kzvezdarov/cwd-fix
Removed CWD from default search path
2015-05-22 23:30:46 +02:00
Kiril Zvezdarov
79ee5adf46 Removed CWD from default search path 2015-05-22 17:19:48 -04:00
oliveagle
0d75ecea1c update README.md
[close #66]
2015-05-19 10:07:30 -04:00
oliveagle
f3482afcd0 replace bytes.Buffer with io.Reader 2015-05-19 10:07:21 -04:00
oliveagle
2a7f7f40fc add README.md, and fix strings.ToLower(configType) 2015-05-19 10:07:21 -04:00
oliveagle
4aa8f94511 clean a little: added watch and ReadBufConf 2015-05-19 10:07:21 -04:00
oliveagle
3492885e84 ReadBufConfig 2015-05-19 10:07:21 -04:00
bep
be782f3fee Revert "Recursively insensitivize the configuration structures"
This reverts commit 8d9577a72e.

The commit is reasonable enough, but this is a major breaking change for Hugo.

We have to figure out how to handle this before we introduce this one.

See https://github.com/spf13/hugo/issues/1129
2015-05-11 23:36:48 +02:00
Kiril Zvezdarov
2e47d9ed4a Added doc entry on nested key access 2015-05-02 14:20:33 -04:00
Kiril Zvezdarov
8d9577a72e Recursively insensitivize the configuration structures 2015-05-01 22:52:16 -04:00
Kiril Zvezdarov
47b5435941 Added test coverage for searching for deeply nested values 2015-05-01 22:52:16 -04:00
Kiril Zvezdarov
b22fa2b439 Reordered the debug dump of configs to print them in order of precedence 2015-05-01 22:52:16 -04:00
Kiril Zvezdarov
c174e2427c Added accessing deep keys by recursive hierarchical search 2015-05-01 22:52:16 -04:00
Steve Francia
2578450e4a Merge pull request #64 from gitter-badger/gitter-badge
Add a Gitter chat badge to README.md
2015-05-01 16:03:55 -04:00
The Gitter Badger
2763b90eff Added Gitter badge 2015-05-01 20:02:50 +00:00
Kiril Zvezdarov
54e585af54 Clean config register before reading in from file in order to avoid stale values 2015-04-26 15:08:10 -04:00
Wayne Walker
ba3382dd23 59 - add properties file support to viper 2015-04-14 13:15:02 -05:00
Kiril Zvezdarov
39ab3ca72e Noted that ReadInConfig returns errors that can be handled 2015-04-02 17:07:32 -04:00
Kiril Zvezdarov
40762f7541 Current working directory is added to the config search paths by default 2015-04-02 17:07:32 -04:00
Kiril Zvezdarov
c861bdefb7 Set default values when binding the whole flagset 2015-04-02 17:04:19 -04:00
Kiril Zvezdarov
19ed496472 Added the pflags register to the debug output 2015-04-02 17:04:19 -04:00
Kiril Zvezdarov
24dd877ad7 Added BindPFlags function which binds all flags in a given flag set to the pflags register 2015-04-02 17:04:19 -04:00
Kiril Zvezdarov
9a0a6692b7 Added docstrings to all exported functions 2015-04-01 21:00:19 -04:00
Eran Chetz
ac722f39d3 Change small syntax error in Env Example 2015-03-26 15:24:28 +02:00
Kiril Zvezdarov
2e2f3b2643 Marshal now gets the map via the AllSettings method
Conflicts:
	viper.go
2015-03-12 22:33:19 -04:00
Kiril Zvezdarov
700eefa74b Exported the Viper type in order to better support multiple Vipers
Conflicts:
	viper.go
2015-03-12 22:27:14 -04:00
Daniel Eloff
e133904c4f Add GetSizeInBytes.
Useful to parse strings like 1GB or 12 mb into an unsigned integer number of bytes.
2015-03-12 22:19:13 -04:00
Anthony Fok
5b0b926e3d :%s/insensativiseMap/insensitiviseMap/g 2015-03-07 04:04:19 -07:00
Anthony Fok
8b99f53550 Avoid searching for config file in executable's path
Viper should not be searching for config.{json,toml,yaml,yml}
in the directory where the `hugo` executable binary is located,
i.e. do not try to look for e.g. $GOPATH/bin/config.toml or
/usr/local/bin/config.toml
2015-03-07 04:01:22 -07:00
Anthony Fok
0c5f3e2462 Minor revisions to README.md
* Change the order to "JSON, TOML and YAML" because that is
   the order that Viper attempts to find the config file,
   as listed in SupportedExts string array

 * Rename "Indexes" to "Taxonomies" (re: Hugo)

 * GitHub now forces https, so update GitHub URLs accordingly

 * Add links to Wikipedia pages about Viper and Cobra Commander
   in case the users do not know the G.I. Joe reference

 * Other minor copyediting
2015-03-07 03:52:13 -07:00
Chance Zibolski
1258332127 Fix whitespace 2015-03-06 11:21:50 -08:00