tpl: Extend Jsonify to support options map

Add support for prefix and indent options used by json.MarshalIndent
from the Go stdlib.
This commit is contained in:
Cameron Moore 2020-03-23 21:03:52 -05:00 committed by Bjørn Erik Pedersen
parent 1bc93021e3
commit 8568928aa8
3 changed files with 23 additions and 13 deletions

View file

@ -1,4 +1,4 @@
// Copyright 2017 The Hugo Authors. All rights reserved. // Copyright 2020 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -52,8 +52,11 @@ func (ns *Namespace) Base64Encode(content interface{}) (string, error) {
return base64.StdEncoding.EncodeToString([]byte(conv)), nil return base64.StdEncoding.EncodeToString([]byte(conv)), nil
} }
// Jsonify encodes a given object to JSON. To pretty print the JSON, pass an // Jsonify encodes a given object to JSON. To pretty print the JSON, pass a map
// optional first argument of the indent string, such as " ". // or dictionary of options as the first argument. Supported options are
// "prefix" and "indent". Each JSON element in the output will begin on a new
// line beginning with prefix followed by one or more copies of indent according
// to the indentation nesting.
func (ns *Namespace) Jsonify(args ...interface{}) (template.HTML, error) { func (ns *Namespace) Jsonify(args ...interface{}) (template.HTML, error) {
var ( var (
b []byte b []byte
@ -66,14 +69,14 @@ func (ns *Namespace) Jsonify(args ...interface{}) (template.HTML, error) {
case 1: case 1:
b, err = json.Marshal(args[0]) b, err = json.Marshal(args[0])
case 2: case 2:
var indent string var opts map[string]string
indent, err = cast.ToStringE(args[0]) opts, err = cast.ToStringMapStringE(args[0])
if err != nil { if err != nil {
break break
} }
b, err = json.MarshalIndent(args[1], "", indent) b, err = json.MarshalIndent(args[1], opts["prefix"], opts["indent"])
default: default:
err = errors.New("too many arguments to jsonify") err = errors.New("too many arguments to jsonify")
} }

View file

@ -1,4 +1,4 @@
// Copyright 2017 The Hugo Authors. All rights reserved. // Copyright 2020 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -83,20 +83,27 @@ func TestJsonify(t *testing.T) {
ns := New() ns := New()
for _, test := range []struct { for _, test := range []struct {
indent []interface{} opts interface{}
v interface{} v interface{}
expect interface{} expect interface{}
}{ }{
{nil, []string{"a", "b"}, template.HTML(`["a","b"]`)}, {nil, []string{"a", "b"}, template.HTML(`["a","b"]`)},
{[]interface{}{" "}, []string{"a", "b"}, template.HTML("[\n \"a\",\n \"b\"\n]")}, {map[string]string{"indent": "<i>"}, []string{"a", "b"}, template.HTML("[\n<i>\"a\",\n<i>\"b\"\n]")},
{map[string]string{"prefix": "<p>"}, []string{"a", "b"}, template.HTML("[\n<p>\"a\",\n<p>\"b\"\n<p>]")},
{map[string]string{"prefix": "<p>", "indent": "<i>"}, []string{"a", "b"}, template.HTML("[\n<p><i>\"a\",\n<p><i>\"b\"\n<p>]")},
{nil, tstNoStringer{}, template.HTML("{}")}, {nil, tstNoStringer{}, template.HTML("{}")},
{nil, nil, template.HTML("null")}, {nil, nil, template.HTML("null")},
// errors // errors
{nil, math.NaN(), false}, {nil, math.NaN(), false},
{[]interface{}{tstNoStringer{}}, []string{"a", "b"}, false}, {tstNoStringer{}, []string{"a", "b"}, false},
} { } {
args := []interface{}{}
args := append(test.indent, test.v) if test.opts != nil {
args = append(args, test.opts)
}
args = append(args, test.v)
result, err := ns.Jsonify(args...) result, err := ns.Jsonify(args...)

View file

@ -1,4 +1,4 @@
// Copyright 2017 The Hugo Authors. All rights reserved. // Copyright 2020 The Hugo Authors. All rights reserved.
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -48,7 +48,7 @@ func init() {
[]string{"jsonify"}, []string{"jsonify"},
[][2]string{ [][2]string{
{`{{ (slice "A" "B" "C") | jsonify }}`, `["A","B","C"]`}, {`{{ (slice "A" "B" "C") | jsonify }}`, `["A","B","C"]`},
{`{{ (slice "A" "B" "C") | jsonify " "}}`, "[\n \"A\",\n \"B\",\n \"C\"\n]"}, {`{{ (slice "A" "B" "C") | jsonify (dict "indent" " ") }}`, "[\n \"A\",\n \"B\",\n \"C\"\n]"},
}, },
) )