expand variables with flair

README.md

@@ -238,6 +238,52 @@ if err := env.Unmarshal(&cfg); err != nil {
 // { "Username": "test", "Password": "password123" }
 ```
 
+### Expand variables
+
+The `expand` tag option can be used to indicate that the value of the variable
+should be expanded (in either `${var}` or `$var` format) before being set.
+
+```go
+type Config struct {
+    Username string `env:"USERNAME,expand"`
+    Password string `env:"PASSWORD,expand"`
+}
+```
+
+This works great with the `default` tag option:
+
+```go
+type Config struct {
+    Address string `env:"ADDRESS,expand,default=${HOST}:${PORT}"`
+}
+```
+
+Which results in:
+
+```bash
+HOST=localhost PORT=8080 go run main.go
+{Address:localhost:8080}
+```
+
+Additionally, default values can be referenced from other struct fields.
+Allowing you to chain default values rather than falling back to an empty value
+when an environment variable is not set:
+
+```go
+type Config struct {
+    Host string `env:"HOST,default=localhost"`
+    Port string `env:"PORT,default=8080"`
+    Address string `env:"ADDRESS,expand,default=${Host}:${Port}"`
+}
+```
+
+Which results in:
+
+```bash
+go run main.go
+{Host:localhost Port:8080 Address:localhost:8080}
+```
+
 ## Contributing
 
 Feel free to open issues or contribute to the project. Contributions are always

example/main.go

@@ -29,7 +29,9 @@ type DatabaseConfig struct {
 
 type Config struct {
 	Debug    bool           `env:"DEBUG"`
+	Host     string         `env:"HOST,default=localhost"`
 	Port     string         `env:"PORT,default=8080"`
+	Address  string         `env:"ADDRESS,default=${HOST}:$PORT,expand"`
 	Roles    []string       `env:"ROLES,default=[admin,editor]"`
 	Database DatabaseConfig `env:"DATABASE"`
 	Redis    RedisConfig

unmarshal.go

@@ -36,7 +36,7 @@ func unmarshalWithPrefix(data interface{}, prefix string) error {
 			continue
 		}
 
-		if err := unmarshalField(field, tag, prefix); err != nil {
+		if err := unmarshalField(field, tag, prefix, data); err != nil {
 			return err
 		}
 	}
@@ -54,7 +54,7 @@ func unmarshalStruct(data interface{}, prefix, tag string) error {
 }
 
 // unmarshalField handles unmarshaling individual fields based on tags
-func unmarshalField(field reflect.Value, tag string, prefix string) error {
+func unmarshalField(field reflect.Value, tag string, prefix string, structPtr interface{}) error {
 	tagOpts := parseTag(tag)
 	value, found := findFieldValue(tagOpts.keys, prefix)
 
@@ -67,10 +67,14 @@ func unmarshalField(field reflect.Value, tag string, prefix string) error {
 		found = true
 	}
 
-	if !found {
+	if !found && tagOpts.fallback != "" {
 		value = tagOpts.fallback
 	}
 
+	if tagOpts.expand {
+		value = expandVariables(value, structPtr)
+	}
+
 	if tagOpts.required && value == "" {
 		return fmt.Errorf("required environment variable %s is not set", tagOpts.keys[0])
 	}
@@ -82,6 +86,58 @@ func unmarshalField(field reflect.Value, tag string, prefix string) error {
 	return nil
 }
 
+// expandVariables replaces placeholders with actual environment variable values or defaults if not set.
+func expandVariables(value string, structPtr interface{}) string {
+	// Handle both ${var} and $var syntax
+	re := regexp.MustCompile(`\$\{([^}]+)\}|\$([A-Za-z_][A-Za-z0-9_]*)`)
+	matches := re.FindAllStringSubmatch(value, -1)
+
+	for _, match := range matches {
+		var envVar string
+		if match[1] != "" {
+			envVar = match[1] // ${var} syntax
+		} else {
+			envVar = match[2] // $var syntax
+		}
+
+		envValue, ok := Lookup(envVar) // Lookup the environment variable; use default if not set
+		if !ok {
+			envValue = getDefaultFromStruct(envVar, structPtr)
+		}
+		value = strings.Replace(value, match[0], envValue, -1)
+	}
+
+	return value
+}
+
+// getDefaultFromStruct retrieves the default value from the struct if available
+func getDefaultFromStruct(fieldName string, structPtr interface{}) string {
+	v := reflect.ValueOf(structPtr).Elem()
+	t := v.Type()
+
+	for i := 0; i < v.NumField(); i++ {
+		fieldType := t.Field(i)
+		tag := fieldType.Tag.Get("env")
+		tagOpts := parseTag(tag)
+
+		if tagOpts.keys[0] == fieldName {
+			if tagOpts.fallback != "" {
+				return tagOpts.fallback
+			}
+		}
+		// Handle nested structs
+		if fieldType.Type.Kind() == reflect.Struct {
+			nestedStructPtr := v.Field(i).Addr().Interface()
+			nestedValue := getDefaultFromStruct(fieldName, nestedStructPtr)
+			if nestedValue != "" {
+				return nestedValue
+			}
+		}
+	}
+
+	return ""
+}
+
 // Helper function to read file content
 func readFileContent(filePath string) (string, error) {
 	content, err := os.ReadFile(filePath)
@@ -108,6 +164,7 @@ type tagOptions struct {
 	fallback string
 	required bool
 	file     bool
+	expand   bool
 }
 
 // parseTag parses the struct tag into tagOptions
@@ -117,6 +174,7 @@ func parseTag(tag string) tagOptions {
 	var fallbackValue string
 	required := false
 	file := false
+	expand := false
 
 	if len(parts) > 1 {
 		extraParts := parts[1]
@@ -132,23 +190,24 @@ func parseTag(tag string) tagOptions {
 				if !inBrackets {
 					part := extraParts[start:i]
 					start = i + 1
-					parsePart(part, &fallbackValue, &required, &file)
+					parsePart(part, &fallbackValue, &required, &file, &expand)
 				}
 			}
 		}
 		part := extraParts[start:]
-		parsePart(part, &fallbackValue, &required, &file)
+		parsePart(part, &fallbackValue, &required, &file, &expand)
 	}
 
 	return tagOptions{
 		keys:     keys,
 		fallback: fallbackValue,
 		required: required,
 		file:     file,
+		expand:   expand,
 	}
 }
 
-func parsePart(part string, fallbackValue *string, required *bool, file *bool) {
+func parsePart(part string, fallbackValue *string, required *bool, file *bool, expand *bool) {
 	if strings.Contains(part, "default=[") || strings.Contains(part, "fallback=[") {
 		re := regexp.MustCompile(`(?:default|fallback)=\[(.*?)]`)
 		matches := re.FindStringSubmatch(part)
@@ -165,6 +224,8 @@ func parsePart(part string, fallbackValue *string, required *bool, file *bool) {
 		*required = true
 	} else if strings.TrimSpace(part) == "file" {
 		*file = true
+	} else if strings.TrimSpace(part) == "expand" {
+		*expand = true
 	}
 }
 

unmarshal_test.go

@@ -663,3 +663,117 @@ func TestReadFileContentError(t *testing.T) {
 		t.Errorf("expected error to start with %s, got %s", expectedErrPrefix, err.Error())
 	}
 }
+
+func TestUnmarshalExpand(t *testing.T) {
+	setEnvForTest(t, "HOST", "localhost")
+	setEnvForTest(t, "PORT", "8080")
+	setEnvForTest(t, "BASE_URL", "http://${HOST}:${PORT}")
+
+	type Config struct {
+		BaseURL string `env:"BASE_URL,expand"`
+	}
+
+	var cfg Config
+	err := Unmarshal(&cfg)
+	assertNoError(t, err, "Unmarshal with expand")
+
+	expected := Config{
+		BaseURL: "http://localhost:8080",
+	}
+
+	assertEqual(t, expected, cfg, "UnmarshalExpand")
+}
+
+func TestUnmarshalExpandWithDefault(t *testing.T) {
+	setEnvForTest(t, "HOST", "localhost")
+	setEnvForTest(t, "PORT", "8080")
+
+	type Config struct {
+		BaseURL string `env:"BASE_URL,default=http://${HOST}:${PORT}/api,expand"`
+	}
+
+	var cfg Config
+	err := Unmarshal(&cfg)
+	assertNoError(t, err, "Unmarshal with expand and default")
+
+	expected := Config{
+		BaseURL: "http://localhost:8080/api",
+	}
+
+	assertEqual(t, expected, cfg, "UnmarshalExpandWithDefault")
+}
+
+func TestUnmarshalExpandWithMissingEnv(t *testing.T) {
+	type Config struct {
+		BaseURL string `env:"BASE_URL,default=http://${HOST}:${PORT}/api,expand"`
+	}
+
+	var cfg Config
+	err := Unmarshal(&cfg)
+	assertNoError(t, err, "Unmarshal with expand and missing env variables")
+
+	expected := Config{
+		BaseURL: "http://:/api", // Expanded with empty strings for missing HOST and PORT
+	}
+
+	assertEqual(t, expected, cfg, "UnmarshalExpandWithMissingEnv")
+}
+
+func TestGetDefaultFromStructWithFallback(t *testing.T) {
+	type Config struct {
+		Host    string `env:"HOST,default=localhost"`
+		Port    string `env:"PORT,default=8080"`
+		Address string `env:"ADDRESS,default=${HOST}:${PORT},expand"`
+	}
+
+	var cfg Config
+	defaultHost := getDefaultFromStruct("HOST", &cfg)
+	defaultPort := getDefaultFromStruct("PORT", &cfg)
+
+	if defaultHost != "localhost" {
+		t.Errorf("expected default host to be 'localhost', got '%s'", defaultHost)
+	}
+
+	if defaultPort != "8080" {
+		t.Errorf("expected default port to be '8080', got '%s'", defaultPort)
+	}
+}
+
+func TestGetDefaultFromStructWithNestedStruct(t *testing.T) {
+	type NestedConfig struct {
+		NestedField string `env:"NESTED_FIELD,default=nested_default"`
+	}
+
+	type Config struct {
+		Host   string       `env:"HOST,default=localhost"`
+		Nested NestedConfig `env:"NESTED"`
+	}
+
+	var cfg Config
+	defaultNestedField := getDefaultFromStruct("NESTED_FIELD", &cfg)
+
+	if defaultNestedField != "nested_default" {
+		t.Errorf("expected default nested field to be 'nested_default', got '%s'", defaultNestedField)
+	}
+}
+
+func TestExpandVariables(t *testing.T) {
+	setEnvForTest(t, "HOST", "localhost")
+	setEnvForTest(t, "PORT", "8080")
+
+	type Config struct {
+		BaseURL1 string `env:"BASE_URL1,default=http://${HOST}:${PORT}/api,expand"`
+		BaseURL2 string `env:"BASE_URL2,default=http://$HOST:$PORT/api,expand"`
+	}
+
+	var cfg Config
+	err := Unmarshal(&cfg)
+	assertNoError(t, err, "Unmarshal with expand and default")
+
+	expected := Config{
+		BaseURL1: "http://localhost:8080/api",
+		BaseURL2: "http://localhost:8080/api",
+	}
+
+	assertEqual(t, expected, cfg, "ExpandVariables")
+}