tpl: Extend Jsonify to support optional indent parameter
authorCameron Moore <moorereason@gmail.com>
Sat, 21 Mar 2020 15:15:12 +0000 (10:15 -0500)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 7 Apr 2020 18:01:57 +0000 (20:01 +0200)
Fixes #5040

tpl/encoding/encoding.go
tpl/encoding/encoding_test.go
tpl/encoding/init.go

index 9045acd1cfcb5a9bffa69954b0ca0098f234d0ad..48699b52def79648a76225d2cd35846a8d740051 100644 (file)
@@ -17,6 +17,7 @@ package encoding
 import (
        "encoding/base64"
        "encoding/json"
+       "errors"
        "html/template"
 
        "github.com/spf13/cast"
@@ -51,9 +52,32 @@ func (ns *Namespace) Base64Encode(content interface{}) (string, error) {
        return base64.StdEncoding.EncodeToString([]byte(conv)), nil
 }
 
-// Jsonify encodes a given object to JSON.
-func (ns *Namespace) Jsonify(v interface{}) (template.HTML, error) {
-       b, err := json.Marshal(v)
+// Jsonify encodes a given object to JSON.  To pretty print the JSON, pass an
+// optional first argument of the indent string, such as "  ".
+func (ns *Namespace) Jsonify(args ...interface{}) (template.HTML, error) {
+       var (
+               b   []byte
+               err error
+       )
+
+       switch len(args) {
+       case 0:
+               return "", nil
+       case 1:
+               b, err = json.Marshal(args[0])
+       case 2:
+               var indent string
+
+               indent, err = cast.ToStringE(args[0])
+               if err != nil {
+                       break
+               }
+
+               b, err = json.MarshalIndent(args[1], "", indent)
+       default:
+               err = errors.New("too many arguments to jsonify")
+       }
+
        if err != nil {
                return "", err
        }
index 2c1804dad9a8f51fee90dc53e02377d24700e58d..2f0988ff37d610b204ed52448439fcb308f8e526 100644 (file)
@@ -83,17 +83,22 @@ func TestJsonify(t *testing.T) {
        ns := New()
 
        for _, test := range []struct {
+               indent []interface{}
                v      interface{}
                expect interface{}
        }{
-               {[]string{"a", "b"}, template.HTML(`["a","b"]`)},
-               {tstNoStringer{}, template.HTML("{}")},
-               {nil, template.HTML("null")},
+               {nil, []string{"a", "b"}, template.HTML(`["a","b"]`)},
+               {[]interface{}{"  "}, []string{"a", "b"}, template.HTML("[\n  \"a\",\n  \"b\"\n]")},
+               {nil, tstNoStringer{}, template.HTML("{}")},
+               {nil, nil, template.HTML("null")},
                // errors
-               {math.NaN(), false},
+               {nil, math.NaN(), false},
+               {[]interface{}{tstNoStringer{}}, []string{"a", "b"}, false},
        } {
 
-               result, err := ns.Jsonify(test.v)
+               args := append(test.indent, test.v)
+
+               result, err := ns.Jsonify(args...)
 
                if b, ok := test.expect.(bool); ok && !b {
                        c.Assert(err, qt.Not(qt.IsNil))
index bad1804de8fcddc834d21912218e3202b46f76a3..8ec9f1a587e128342e8653ccdcf8a1eb7640fbfc 100644 (file)
@@ -48,11 +48,11 @@ func init() {
                        []string{"jsonify"},
                        [][2]string{
                                {`{{ (slice "A" "B" "C") | jsonify }}`, `["A","B","C"]`},
+                               {`{{ (slice "A" "B" "C") | jsonify "  "}}`, "[\n  \"A\",\n  \"B\",\n  \"C\"\n]"},
                        },
                )
 
                return ns
-
        }
 
        internal.AddTemplateFuncsNamespace(f)