mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-19 21:21:39 +02:00
tpl/transform: Add template func for TOML/JSON/YAML docs examples conversion
Usage: ```html {{ "title = \"Hello World\"" | transform.Remarshal "json" | safeHTML }} ``` Fixes #4389
This commit is contained in:
154
tpl/transform/remarshal_test.go
Normal file
154
tpl/transform/remarshal_test.go
Normal file
@@ -0,0 +1,154 @@
|
||||
// Copyright 2018 The Hugo Authors. All rights reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package transform
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/gohugoio/hugo/helpers"
|
||||
"github.com/spf13/viper"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestRemarshal(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ns := New(newDeps(viper.New()))
|
||||
assert := require.New(t)
|
||||
|
||||
tomlExample := `title = "Test Metadata"
|
||||
|
||||
[[resources]]
|
||||
src = "**image-4.png"
|
||||
title = "The Fourth Image!"
|
||||
[resources.params]
|
||||
byline = "picasso"
|
||||
|
||||
[[resources]]
|
||||
name = "my-cool-image-:counter"
|
||||
src = "**.png"
|
||||
title = "TOML: The Image #:counter"
|
||||
[resources.params]
|
||||
byline = "bep"
|
||||
`
|
||||
|
||||
yamlExample := `resources:
|
||||
- params:
|
||||
byline: picasso
|
||||
src: '**image-4.png'
|
||||
title: The Fourth Image!
|
||||
- name: my-cool-image-:counter
|
||||
params:
|
||||
byline: bep
|
||||
src: '**.png'
|
||||
title: 'TOML: The Image #:counter'
|
||||
title: Test Metadata
|
||||
`
|
||||
|
||||
jsonExample := `{
|
||||
"resources": [
|
||||
{
|
||||
"params": {
|
||||
"byline": "picasso"
|
||||
},
|
||||
"src": "**image-4.png",
|
||||
"title": "The Fourth Image!"
|
||||
},
|
||||
{
|
||||
"name": "my-cool-image-:counter",
|
||||
"params": {
|
||||
"byline": "bep"
|
||||
},
|
||||
"src": "**.png",
|
||||
"title": "TOML: The Image #:counter"
|
||||
}
|
||||
],
|
||||
"title": "Test Metadata"
|
||||
}
|
||||
`
|
||||
|
||||
variants := []struct {
|
||||
format string
|
||||
data string
|
||||
}{
|
||||
{"yaml", yamlExample},
|
||||
{"json", jsonExample},
|
||||
{"toml", tomlExample},
|
||||
{"TOML", tomlExample},
|
||||
{"Toml", tomlExample},
|
||||
{" TOML ", tomlExample},
|
||||
}
|
||||
|
||||
for _, v1 := range variants {
|
||||
for _, v2 := range variants {
|
||||
// Both from and to may be the same here, but that is fine.
|
||||
fromTo := fmt.Sprintf("%s => %s", v2.format, v1.format)
|
||||
|
||||
converted, err := ns.Remarshal(v1.format, v2.data)
|
||||
assert.NoError(err, fromTo)
|
||||
diff := helpers.DiffStrings(v1.data, converted)
|
||||
if len(diff) > 0 {
|
||||
t.Errorf("[%s] Expected \n%v\ngot\n%v\ndiff:\n%v", fromTo, v1.data, converted, diff)
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestTestRemarshalError(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ns := New(newDeps(viper.New()))
|
||||
assert := require.New(t)
|
||||
|
||||
_, err := ns.Remarshal("asdf", "asdf")
|
||||
assert.Error(err)
|
||||
|
||||
_, err = ns.Remarshal("json", "asdf")
|
||||
assert.Error(err)
|
||||
|
||||
}
|
||||
|
||||
func TestRemarshalDetectFormat(t *testing.T) {
|
||||
t.Parallel()
|
||||
assert := require.New(t)
|
||||
|
||||
for i, test := range []struct {
|
||||
data string
|
||||
expect interface{}
|
||||
}{
|
||||
{`foo = "bar"`, "toml"},
|
||||
{` foo = "bar"`, "toml"},
|
||||
{`foo="bar"`, "toml"},
|
||||
{`foo: "bar"`, "yaml"},
|
||||
{`foo:"bar"`, "yaml"},
|
||||
{`{ "foo": "bar"`, "json"},
|
||||
{`asdfasdf`, false},
|
||||
{``, false},
|
||||
} {
|
||||
errMsg := fmt.Sprintf("[%d] %s", i, test.data)
|
||||
|
||||
result, err := detectFormat(test.data)
|
||||
|
||||
if b, ok := test.expect.(bool); ok && !b {
|
||||
assert.Error(err, errMsg)
|
||||
continue
|
||||
}
|
||||
|
||||
assert.NoError(err, errMsg)
|
||||
assert.Equal(test.expect, result, errMsg)
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user