Add dictionary function to be passed into a template

Allows templates to dynamically build maps.

Example usage: Creating and passing a map to a subtemplate while in a range on the parent.

diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md
index d27e450359570a814480b5fd2fbcd109a1504e98..88129aa1fd3e795155ee1e8079f84c2ee9578598 100644 (file)
--- a/docs/content/templates/functions.md
+++ b/docs/content/templates/functions.md
@@ -50,6 +50,29 @@ e.g.
 
     // Outputs Tags: tag1, tag2 and tag3
 
+### dict
+Creates a dictionary (map[string, interface{}), expects parameters added in value:object fasion.
+Invalid combinations like keys that are not strings or uneven number of parameters, will result in an exception thrown
+Useful for passing maps to partials when adding to a template.
+
+e.g. Pass into "foo.html" a map with the keys "important, content" 
+
+    {{$important := .Site.Params.SomethingImportant }}
+    {{range .Site.Params.Bar}}
+        {{partial "foo" (dict "content" . "important" $important)}}
+    {{end}}
+
+"foo.html"
+
+    Important {{.important}}
+    {{.content}}
+    
+
+or Create a map on the fly to pass into 
+
+    {{partial "foo" (dict "important" "Smiles" "content" "You should do more")}}
+    
+
 
 ### echoParam
 Prints a parameter if it is set.

diff --git a/tpl/template_funcs.go b/tpl/template_funcs.go
index 7af70b47482aab458b6c62f1dab795e756f6f363..b1ac341f60c02305da5f6899e91cfb8fe49362fe 100644 (file)
--- a/tpl/template_funcs.go
+++ b/tpl/template_funcs.go
@@ -78,6 +78,21 @@ func Lt(a, b interface{}) bool {
        return left < right
 }
 
+func Dictionary(values ...interface{}) (map[string]interface{}, error) {
+       if len(values)%2 != 0 {
+               return nil, errors.New("invalid dict call")
+       }
+       dict := make(map[string]interface{}, len(values)/2)
+       for i := 0; i < len(values); i+=2 {
+               key, ok := values[i].(string)
+               if !ok {
+                       return nil, errors.New("dict keys must be strings")
+               }
+       dict[key] = values[i+1]
+       }
+       return dict, nil
+}
+
 func compareGetFloat(a interface{}, b interface{}) (float64, float64) {
        var left, right float64
        var leftStr, rightStr *string
@@ -1356,6 +1371,7 @@ func init() {
                "ge":           Ge,
                "lt":           Lt,
                "le":           Le,
+               "dict":         Dictionary,
                "in":           In,
                "slicestr":     Slicestr,
                "substr":       Substr,

diff --git a/tpl/template_funcs_test.go b/tpl/template_funcs_test.go
index e8b91efa30579c065a3d4e5f9ec8cd7bbfe3d658..bc2515a4a2f598b5ca083543c4500913d7f6dd21 100644 (file)
--- a/tpl/template_funcs_test.go
+++ b/tpl/template_funcs_test.go
@@ -324,6 +324,30 @@ func TestAfter(t *testing.T) {
        }
 }
 
+func TestDictionary(t *testing.T) {
+       for i, this := range []struct {
+               v1     []interface{}
+               expecterr bool
+               expectedValue map[string] interface{}
+       }{
+               {[]interface{}{"a", "b"}, false, map[string]interface{}{"a":"b"}},
+               {[]interface{}{5, "b"}, true,nil},
+               {[]interface{}{"a", 12,"b",[]int{4}}, false,map[string]interface{}{"a":12,"b":[]int{4}}},
+               {[]interface{}{"a", "b", "c"}, true,nil},
+       } {
+               r,e := Dictionary(this.v1...)
+
+               if (this.expecterr && e==nil) || (!this.expecterr && e!=nil)  {
+                       t.Errorf("[%d] got an unexpected error", i, e, this.expecterr)
+               } else if !this.expecterr {
+                       if !reflect.DeepEqual(r, this.expectedValue) {
+                               t.Errorf("[%d] got %v but expected %v", i, r, this.expectedValue)
+                       }
+               }
+       }
+}
+
+
 func TestIn(t *testing.T) {
        for i, this := range []struct {
                v1     interface{}