add hex type

datatype.go

@@ -14,6 +14,7 @@ const (
 	TypeString    DataType = iota
 	TypeDirectory DataType = iota
 	TypeBool      DataType = iota
+	TypeHex       DataType = iota
 )
 
 type cValue struct {
@@ -21,6 +22,7 @@ type cValue struct {
 	intval  int64
 	durval  time.Duration
 	boolval bool
+	binval  []byte
 	strval  string
 	err     error
 }
@@ -28,7 +30,10 @@ type cValue struct {
 func (dtype DataType) parse(key string, str string) (ret cValue) {
 	info, ok := tInfo[dtype]
 	if ok {
-		return info.parser(key, str)
+		ret = info.parser(key, str)
+		if len(ret.binval) == 0 {
+			ret.binval = make([]byte, 0, 0)
+		}
 	}
 	return
 }

envconf.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"regexp"
 	"strings"
 	"time"
 	"unicode"
@@ -15,10 +16,14 @@ type cEntry struct {
 	dtype  DataType
 	unset  bool
 	empty  bool
+	defval string // The default value
+	hasdef bool   // Default value is defined
 }
+
 type Config struct {
 	parsed bool
 	env    map[string]cEntry
+	mapEnv map[string]map[string]cEntry
 }
 
 // NewConfig returns an envconf.Config that is used to read configuration from environment variables.
@@ -28,10 +33,14 @@ func NewConfig() *Config {
 	config := new(Config)
 	config.parsed = false
 	config.env = make(map[string]cEntry)
+	config.mapEnv = make(map[string]map[string]cEntry)
+
 	for _, v := range os.Environ() {
 		splitted := strings.SplitN(v, "=", 2)
 		if len(splitted) == 2 {
-			key := strings.TrimSpace(strings.ToUpper(splitted[0]))
+			key := cleanKey(splitted[0])
+			left, right, mappable := keySplit(key)
+
 			if unicode.IsLetter(getFirstRune(key)) {
 				var entry cEntry
 				entry.value = splitted[1]
@@ -39,48 +48,72 @@ func NewConfig() *Config {
 				entry.unset = false
 				entry.empty = false
 				config.env[key] = entry
+				if mappable {
+					if len(config.mapEnv[left]) == 0 {
+						config.mapEnv[left] = make(map[string]cEntry)
+					}
+
+					config.mapEnv[left][right] = entry
+				}
 			}
 		}
 	}
 	return config
 }
 
-// Define defines the type of an environment variable.
+// Define the type of an environment variable.
 // Variables without a defined type will be ignored by Parse.
 func (c *Config) Define(key string, dtype DataType) {
-	upper := strings.ToUpper(key)
-	entry, ok := c.env[upper]
+	key = cleanKey(key)
+	entry, ok := c.env[key]
 	if ok {
 		entry.dtype = dtype
-		c.env[upper] = entry
+		c.env[key] = entry
 	} else {
 		var entry cEntry
 		entry.dtype = dtype
 		entry.unset = true
 		entry.empty = true
-		c.env[upper] = entry
+		c.env[key] = entry
 	}
 }
 
-// DefineDefault defines the type and default value of an environment variable.
+// Define the type of an environment variable.
+// Variables without a defined type will be ignored by Parse.
+func (c *Config) DefineMap(key string, dtype DataType) {
+	key = cleanKey(key)
+	entries, ok := c.mapEnv[key]
+	if ok {
+		for mapKey, entry := range entries {
+			entry.dtype = dtype
+			c.mapEnv[key][mapKey] = entry
+		}
+	}
+}
+
+// Define the type and default value of an environment variable.
 // Variables without a defined type will be ignored by Parse.
 func (c *Config) DefineDefault(key string, val string, dtype DataType) {
-	upper := strings.ToUpper(key)
-	entry, ok := c.env[upper]
+	key = cleanKey(key)
+	entry, ok := c.env[key]
 	if ok {
 		if entry.unset {
 			entry.value = val
 		}
 		entry.dtype = dtype
 		entry.empty = false
-		c.env[upper] = entry
+		entry.defval = val
+		entry.hasdef = true
+		c.env[key] = entry
 	} else {
 		var entry cEntry
 		entry.dtype = dtype
 		entry.unset = true
 		entry.empty = false
 		entry.value = val
-		c.env[upper] = entry
+		entry.defval = val
+		entry.hasdef = true
+		c.env[key] = entry
 	}
 }
 
@@ -102,6 +135,14 @@ func (c *Config) Parse() {
 			c.env[k] = v
 		}
 	}
+
+	for k, v := range c.mapEnv {
+		for mk, mv := range v {
+			mv.parsed = mv.dtype.parse(k+"_"+mk, mv.value)
+			c.mapEnv[k][mk] = mv
+		}
+	}
+
 	if failed {
 		for k, v := range c.env {
 			if (v.parsed.err == nil) && v.unset {
@@ -117,27 +158,64 @@ func (c *Config) Parse() {
 	}
 }
 
-func (c *Config) Help() {
-	max := 0
+func (c *Config) help() {
+	max := make([]int, 2, 2)
+	preq := false
+	pdef := false
 	for k, v := range c.env {
 		if v.dtype != TypeNone {
-			if len(k) > max {
-				max = len(k)
+			if len(k) > max[0] {
+				max[0] = len(k)
 			}
-			if len(v.dtype.String()) > max {
-				max = len(v.dtype.String())
+			if len(v.dtype.String()) > max[1] {
+				max[1] = len(v.dtype.String())
 			}
-			if len(v.value) > max {
-				max = len(v.value)
+			if v.hasdef {
+				pdef = true
+			} else {
+				preq = true
 			}
 		}
 	}
-	for k, v := range c.env {
-		if v.dtype != TypeNone {
-			format := fmt.Sprintf("Variable %%%ds|Type %%%ds|Default %%s\n", max, max)
-			fmt.Printf(format, k, v.dtype, v.value)
+	if pdef {
+		fmt.Println()
+		for k, v := range c.env {
+			if v.dtype != TypeNone {
+				if v.hasdef {
+					format := fmt.Sprintf("Variable   %%-%ds|   Type %%-%ds|   Default %%s\n", max[0]+5, max[1]+3)
+					fmt.Printf(format, fmt.Sprintf(`"%s"`, k), v.dtype, fmt.Sprintf(`"%s"`, v.defval))
+				}
+			}
 		}
 	}
+	if preq {
+		fmt.Println()
+		for k, v := range c.env {
+			if v.dtype != TypeNone {
+				if !v.hasdef {
+					format := fmt.Sprintf("Variable   %%-%ds|   Type %%-%ds|   Required\n", max[0]+5, max[1]+3)
+					fmt.Printf(format, fmt.Sprintf(`"%s"`, k), v.dtype)
+				}
+			}
+		}
+	}
+	fmt.Println()
+}
+
+func (c *Config) StatusHelp() bool {
+	flags := make(map[string]bool)
+	flags["--help"] = true
+	flags["-help"] = true
+	flags["-h"] = true
+	if len(os.Args) > 1 {
+		key := strings.ToLower(strings.TrimSpace(os.Args[1]))
+		_, ok := flags[key]
+		if ok {
+			c.help()
+			return false
+		}
+	}
+	return c.Status()
 }
 
 // Status prints out failures that occured while parsing the environment to os.Stderr.
@@ -156,6 +234,17 @@ func (c *Config) Status() (ok bool) {
 				}
 			}
 		}
+		for _, v := range c.mapEnv {
+			for _, mv := range v {
+				err := mv.parsed.err
+				if err != nil {
+					ok = false
+					if !mv.empty {
+						fmt.Fprintln(os.Stderr, err)
+					}
+				}
+			}
+		}
 		if !ok {
 			fmt.Fprintln(os.Stderr, "")
 			for _, v := range c.env {
@@ -169,11 +258,34 @@ func (c *Config) Status() (ok bool) {
 	return
 }
 
+func cleanKey(key string) string {
+	expr := regexp.MustCompile("__+")
+	fn := func(r rune) rune {
+		if (r >= '0' && r <= '9') || (r >= 'A' && r <= 'Z') || r == '_' {
+			return r
+		}
+		return -1
+	}
+
+	key = strings.Trim(strings.Map(fn, strings.ToUpper(key)), "_")
+	return expr.ReplaceAllString(key, "_")
+}
+
+func keySplit(key string) (left string, right string, ok bool) {
+	key = cleanKey(key)
+	pos := strings.LastIndex(key, "_")
+	ok = false
+	if (pos+1 < len(key)) && (pos > 1) {
+		return cleanKey(key[:pos]), cleanKey(key[pos:]), true
+	}
+	return
+}
+
 func (c *Config) getRaw(key string, dtype DataType) (val cValue) {
 	val.dtype = TypeNone
 	if c.parsed {
-		upper := strings.ToUpper(key)
-		entry, ok := c.env[upper]
+		key = cleanKey(key)
+		entry, ok := c.env[key]
 		if ok && (entry.dtype == dtype) {
 			return entry.parsed
 		}
@@ -181,21 +293,49 @@ func (c *Config) getRaw(key string, dtype DataType) (val cValue) {
 	return
 }
 
-// GetInt returns the value of an environment variable.
+func (c *Config) getRawMap(key string, dtype DataType) (empty map[string]cValue) {
+	empty = make(map[string]cValue)
+	retval := make(map[string]cValue)
+	if c.parsed {
+		key = cleanKey(key)
+		entries, ok := c.mapEnv[key]
+
+		if ok {
+			for k, v := range entries {
+				if (v.dtype == dtype) && (v.parsed.err == nil) {
+					retval[k] = v.parsed
+				} else {
+					return
+				}
+			}
+			return retval
+		}
+	}
+	return
+}
+
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeInt the function will return 0.
 func (c *Config) GetInt(key string) int64 {
 	val := c.getRaw(key, TypeInt)
 	return val.intval
 }
 
-// GetMetric returns the value of an environment variable.
+// Returns the value of an environment variable.
+// If the variable is not defined as envconf.TypeHex the function will return []byte{}.
+func (c *Config) GetHex(key string) []byte {
+	val := c.getRaw(key, TypeHex)
+	return val.binval
+}
+
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeMetric the function will return 0.
 func (c *Config) GetMetric(key string) int64 {
 	val := c.getRaw(key, TypeMetric)
 	return val.intval
 }
 
-// GetDirectory returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeDirectory the
 // function will return the empty string.
 func (c *Config) GetDirectory(key string) string {
@@ -203,7 +343,7 @@ func (c *Config) GetDirectory(key string) string {
 	return val.strval
 }
 
-// GetString returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeString the
 // function will return the empty string.
 func (c *Config) GetString(key string) string {
@@ -211,7 +351,7 @@ func (c *Config) GetString(key string) string {
 	return val.strval
 }
 
-// GetDuration returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeDuration the
 // function will return time.Duration(0).
 func (c *Config) GetDuration(key string) time.Duration {
@@ -219,7 +359,7 @@ func (c *Config) GetDuration(key string) time.Duration {
 	return val.durval
 }
 
-// GetBool returns the value of an environment variable.
+// Returns the value of an environment variable.
 // If the variable is not defined as envconf.TypeBool the
 // function will return false.
 func (c *Config) GetBool(key string) bool {
@@ -227,6 +367,46 @@ func (c *Config) GetBool(key string) bool {
 	return val.boolval
 }
 
+func (c *Config) GetMapInt(key string) (retval map[string]int64) {
+	retval = make(map[string]int64)
+	for k, v := range c.getRawMap(key, TypeInt) {
+		retval[k] = v.intval
+	}
+	return
+}
+
+func (c *Config) GetMapDuration(key string) (retval map[string]time.Duration) {
+	retval = make(map[string]time.Duration)
+	for k, v := range c.getRawMap(key, TypeDuration) {
+		retval[k] = v.durval
+	}
+	return
+}
+
+func (c *Config) GetMapString(key string) (retval map[string]string) {
+	retval = make(map[string]string)
+	for k, v := range c.getRawMap(key, TypeString) {
+		retval[k] = v.strval
+	}
+	return
+}
+
+func (c *Config) GetMapBool(key string) (retval map[string]bool) {
+	retval = make(map[string]bool)
+	for k, v := range c.getRawMap(key, TypeBool) {
+		retval[k] = v.boolval
+	}
+	return
+}
+
+func (c *Config) GetMapHex(key string) (retval map[string][]byte) {
+	retval = make(map[string][]byte)
+	for k, v := range c.getRawMap(key, TypeHex) {
+		retval[k] = v.binval
+	}
+	return
+}
+
 func getFirstRune(str string) rune {
 	for _, v := range str {
 		return v

parsers.go

@@ -1,6 +1,7 @@
 package envconf
 
 import (
+	"encoding/hex"
 	"errors"
 	"fmt"
 	"os"
@@ -65,6 +66,16 @@ func parseBool(key string, str string) (ret cValue) {
 	return
 }
 
+func parseHex(key string, str string) (ret cValue) {
+	val, err := hex.DecodeString(str)
+	if err == nil {
+		ret.binval = val
+	} else {
+		ret.err = errors.New(fmt.Sprintf(`Environment variable "%s" is not of type hex.`, key))
+	}
+	return
+}
+
 func parseDirectory(_ string, str string) (ret cValue) {
 	wd, err := os.Getwd()
 	if err == nil {

typeinfo.go

@@ -14,6 +14,7 @@ func init() {
 	var durInfo dataTypeInfo
 	var strInfo dataTypeInfo
 	var dirInfo dataTypeInfo
+	var hexInfo dataTypeInfo
 	var boolInfo dataTypeInfo
 
 	intInfo.name = "int"
@@ -21,6 +22,7 @@ func init() {
 	durInfo.name = "duration"
 	dirInfo.name = "directory"
 	strInfo.name = "string"
+	hexInfo.name = "hex"
 	boolInfo.name = "bool"
 
 	intInfo.parser = parseInt
@@ -28,6 +30,7 @@ func init() {
 	durInfo.parser = parseDuration
 	dirInfo.parser = parseDirectory
 	strInfo.parser = parseString
+	hexInfo.parser = parseHex
 	boolInfo.parser = parseBool
 
 	tInfo[TypeInt] = intInfo
@@ -35,5 +38,6 @@ func init() {
 	tInfo[TypeDuration] = durInfo
 	tInfo[TypeString] = strInfo
 	tInfo[TypeDirectory] = dirInfo
+	tInfo[TypeHex] = hexInfo
 	tInfo[TypeBool] = boolInfo
 }