package filters import ( "fmt" "math/rand" "strings" "testing" "time" "github.com/osteele/gojekyll/config" "github.com/osteele/liquid" "github.com/stretchr/testify/require" ) var filterTests = []struct{ in, expected string }{ // dates // TODO date_to_xmlschema should use local timezone? {`{{ time | date_to_xmlschema }}`, "2008-11-07T13:07:54+00:00"}, {`{{ time | date_to_rfc822 }}`, "07 Nov 08 13:07 UTC"}, {`{{ time | date_to_string }}`, "07 Nov 2008"}, {`{{ time | date_to_long_string }}`, "07 November 2008"}, // arrays // TODO group_by group_by_exp sample pop shift // pop and shift are challenging because they require lvalues {`{{ array | array_to_sentence_string }}`, "first, second, and third"}, {`{{ array | sample }}`, "third"}, {`{{ site.members | group_by: "graduation_year" | map: "name" | sort | join }}`, "2013, 2014, 2015"}, // TODO what is the default for nil first? {`{{ animals | sort | join: ", " }}`, "Sally Snake, giraffe, octopus, zebra"}, {`{{ site.pages | sort: "weight" | map: "name" | join }}`, "b, a, d, c"}, {`{{ site.pages | sort: "weight", true | map: "name" | join }}`, "b, a, d, c"}, {`{{ site.pages | sort: "weight", false | map: "name" | join }}`, "a, d, c, b"}, {`{{ site.members | where: "graduation_year", "2014" | map: "name" }}`, "Alan"}, {`{{ site.members | where_exp: "item", "item.graduation_year == 2014" | map: "name" }}`, "Alan"}, {`{{ site.members | where_exp: "item", "item.graduation_year < 2014" | map: "name" }}`, "Alonzo"}, {`{{ site.members | where_exp: "item", "item.name contains 'Al'" | map: "name" | join }}`, "Alonzo, Alan"}, {`{{ page.tags | push: 'Spokane' | join }}`, "Seattle, Tacoma, Spokane"}, // {`{{ page.tags | pop }}`, "Seattle"}, // {`{{ page.tags | shift }}`, "Tacoma"}, {`{{ page.tags | unshift: "Olympia" | join }}`, "Olympia, Seattle, Tacoma"}, // strings // TODO cgi_escape uri_escape scssify smartify slugify normalize_whitespace {`{{ "/assets/style.css" | relative_url }}`, "/my-baseurl/assets/style.css"}, {`{{ "/assets/style.css" | absolute_url }}`, "http://example.com/my-baseurl/assets/style.css"}, {`{{ "Markdown with _emphasis_ and *bold*." | markdownify }}`, "
Markdown with emphasis and bold.
"}, {`{{ obj | jsonify }}`, `{"a":[1,2,3,4]}`}, {`{{ site.pages | map: "name" | join }}`, "a, b, c, d"}, {`{{ site.pages | filter: "weight" | map: "name" | join }}`, "a, c, d"}, {"{{ ws | normalize_whitespace }}", "a b c"}, {`{{ "123" | to_integer | type }}`, "int"}, {`{{ false | to_integer }}`, "0"}, {`{{ true | to_integer }}`, "1"}, {`{{ "here are some words" | number_of_words}}`, "4"}, {`{{ "The _config.yml file" | slugify }}`, "the-config-yml-file"}, {`{{ "The _config.yml file" | slugify: 'none' }}`, "the _config.yml file"}, {`{{ "The _config.yml file" | slugify: 'raw' }}`, "the-_config.yml-file"}, {`{{ "The _config.yml file" | slugify: 'default' }}`, "the-config-yml-file"}, {`{{ "The _config.yml file" | slugify: 'pretty' }}`, "the-_config.yml-file"}, {`{{ "1 < 2 & 3" | xml_escape }}`, "1 < 2 & 3"}, // {`{{ "http://foo.com/?q=foo, \bar?" | uri_escape }}`, "http://foo.com/?q=foo,%20%5Cbar?"}, } var filterTestScope = map[string]interface{}{ "animals": []string{"zebra", "octopus", "giraffe", "Sally Snake"}, "array": []string{"first", "second", "third"}, "obj": map[string]interface{}{ "a": []int{1, 2, 3, 4}, }, "page": map[string]interface{}{ "tags": []string{"Seattle", "Tacoma"}, }, "site": map[string]interface{}{ "members": []map[string]interface{}{ {"name": "Alonzo", "graduation_year": 2013}, {"name": "Alan", "graduation_year": 2014}, {"name": "Moses", "graduation_year": 2015}, {"name": "Haskell"}, }, "pages": []map[string]interface{}{ {"name": "a", "weight": 10}, {"name": "b"}, {"name": "c", "weight": 50}, {"name": "d", "weight": 30}, }, }, "time": timeMustParse("2008-11-07T13:07:54Z"), "ws": "a b\n\t c", } func timeMustParse(s string) time.Time { t, err := time.Parse(time.RFC3339, s) if err != nil { panic(err) } return t } func TestFilters(t *testing.T) { rand.Seed(1) for i, test := range filterTests { t.Run(fmt.Sprintf("%02d", i+1), func(t *testing.T) { requireTemplateRender(t, test.in, filterTestScope, test.expected) }) } } func requireTemplateRender(t *testing.T, tmpl string, bindings map[string]interface{}, expected string) { engine := liquid.NewEngine() c := config.Default() c.BaseURL = "/my-baseurl" c.AbsoluteURL = "http://example.com" AddJekyllFilters(engine, c) data, err := engine.ParseAndRender([]byte(tmpl), liquid.NewContext(bindings)) require.NoErrorf(t, err, tmpl) require.Equalf(t, expected, strings.TrimSpace(string(data)), tmpl) } // func TestXMLEscapeFilter(t *testing.T) { // data := map[string]interface{}{ // "obj": map[string]interface{}{ // "a": []int{1, 2, 3, 4}, // }, // } // requireTemplateRender(t, `{{obj | xml_escape }}`, data, `{"ak":[1,2,3,4]}`) // } func TestWhereExpFilter(t *testing.T) { var tmpl = ` {% assign filtered = array | where_exp: "n", "n > 2" %} {% for item in filtered %}{{item}}{% endfor %} ` data := map[string]interface{}{ "array": []int{1, 2, 3, 4}, } requireTemplateRender(t, tmpl, data, "34") } func TestWhereExpFilterObjects(t *testing.T) { var tmpl = ` {% assign filtered = array | where_exp: "item", "item.flag == true" %} {% for item in filtered %}{{item.name}}{% endfor %} ` data := map[string]interface{}{ "array": []map[string]interface{}{ { "name": "A", "flag": true, }, { "name": "B", "flag": false, }, }} requireTemplateRender(t, tmpl, data, "A") }