Add default value option.

andreiavrammsd · Jan 6, 2020 · 56beaf0 · 56beaf0
1 parent 7a610b3
commit 56beaf0
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ import (
 
 type Config struct {
 	Username string `env:"USERNAME"`
+	Tag      string `env:"TAG" default:"none"`
 }
 
 func main() {
@@ -33,6 +34,7 @@ func main() {
 	}
 
 	fmt.Println(cfg.Username)
+	fmt.Println(cfg.Tag)
 }
 ```
 

diff --git a/config.go b/config.go
@@ -17,7 +17,6 @@ import (
 	"os"
 )
 
-const tag = "env"
 const dotEnvFile = ".env"
 
 // Loader provides methods to load configuration values into a struct

diff --git a/config_test.go b/config_test.go
@@ -28,7 +28,7 @@ type Config struct {
 			Port int `env:"REDIS_PORT"`
 		}
 	}
-	String       string `env:"ABC"`
+	String       string `env:"ABC" default:"ignored"`
 	Struct       Struct
 	StructPtr    *Struct
 	D            int64
@@ -47,6 +47,7 @@ type Config struct {
 	UA           uint8
 	IsSet        bool
 	Interpolated string
+	Default      string `default:"default value"`
 }
 
 type Struct struct {
@@ -185,7 +186,8 @@ func TestJson(t *testing.T) {
 	   "Struct":{
 		  "Field":"Value"
 	   },
-	   "Interpolated":"$B env_1 $ $B \\3 6379 + $"
+	   "Interpolated":"$B env_1 $ $B \\3 6379 + $",
+	   "Default":"default value"
 	}`)
 
 	_, expected, err := testdata()
@@ -372,6 +374,7 @@ func testdata() ([]byte, Config, error) {
 			},
 		}},
 		Interpolated: "$B env_1 $ $B \\3 6379 + $",
+		Default:      "default value",
 	}
 
 	return input, expected, nil

diff --git a/examples_test.go b/examples_test.go
@@ -10,6 +10,7 @@ import (
 
 type Config struct {
 	Username string `env:"USERNAME"`
+	Tag      string `env:"TAG" default:"none"`
 }
 
 func ExampleLoader_Env() {
@@ -23,9 +24,11 @@ func ExampleLoader_Env() {
 	}
 
 	fmt.Println(cfg.Username)
+	fmt.Println(cfg.Tag)
 
 	// Output:
 	// msd
+	// none
 }
 
 func ExampleLoader_Bytes() {

diff --git a/parser.go b/parser.go
@@ -8,6 +8,11 @@ import (
 	"strings"
 )
 
+const (
+	tag             = "env"
+	defaultValueTag = "default"
+)
+
 type getValue func(string) string
 
 func parseIntoStruct(i interface{}, data getValue) error {
@@ -51,6 +56,10 @@ func parse(typ reflect.Type, val reflect.Value, getValue getValue, path string)
 
 		value := value(&field, getValue, path)
 
+		if value == "" {
+			value = defaultValue(&field)
+		}
+
 		if value == "" {
 			continue
 		}
@@ -81,6 +90,10 @@ func key(field *reflect.StructField, path string) string {
 	return key
 }
 
+func defaultValue(field *reflect.StructField) string {
+	return field.Tag.Get(defaultValueTag)
+}
+
 func setFieldValue(field *reflect.StructField, fieldValue reflect.Value, value string) error {
 	switch field.Type.Kind() {
 	case reflect.String: