mirror of
https://github.com/Shopify/liquid.git
synced 2026-09-15 08:50:45 -07:00
Update {% doc %} to no longer support nested tags (as {% comment %} does)
This commit is contained in:
Guilherme Carreiro
committed by
Guilherme Carreiro
Guilherme Carreiro
parent
16592cfb8f
commit
b439d0da53
+122
-117
@@ -3,8 +3,38 @@
|
||||
require 'test_helper'
|
||||
|
||||
class DocTagUnitTest < Minitest::Test
|
||||
def test_doc_inside_liquid_tag
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
def test_doc_tag
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
Renders loading-spinner.
|
||||
|
||||
@param {string} foo - some foo
|
||||
@param {string} [bar] - optional bar
|
||||
|
||||
@example
|
||||
{% render 'loading-spinner', foo: 'foo' %}
|
||||
{% render 'loading-spinner', foo: 'foo', bar: 'bar' %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
assert_template_result('', template)
|
||||
end
|
||||
|
||||
def test_doc_tag_inside_liquid_tag
|
||||
template = <<~LIQUID.chomp
|
||||
{% liquid
|
||||
doc
|
||||
Assigns foo to 1.
|
||||
enddoc
|
||||
assign foo = 1
|
||||
%}
|
||||
LIQUID
|
||||
|
||||
assert_template_result('', template)
|
||||
end
|
||||
|
||||
def test_doc_tag_inside_liquid_tag_with_control_flow_nodes
|
||||
template = <<~LIQUID.chomp
|
||||
{% liquid
|
||||
if 1 != 1
|
||||
doc
|
||||
@@ -14,10 +44,12 @@ class DocTagUnitTest < Minitest::Test
|
||||
endif
|
||||
%}
|
||||
LIQUID
|
||||
|
||||
assert_template_result('', template)
|
||||
end
|
||||
|
||||
def test_does_not_parse_nodes_inside_a_doc
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
def test_doc_tag_ignores_liquid_nodes
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
{% if true %}
|
||||
{% if ... %}
|
||||
@@ -29,89 +61,92 @@ class DocTagUnitTest < Minitest::Test
|
||||
{% endcase %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
assert_template_result('', template)
|
||||
end
|
||||
|
||||
def test_allows_unclosed_tags
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
def test_doc_tag_ignores_unclosed_liquid_tags
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
{% if true %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
assert_template_result('', template)
|
||||
end
|
||||
|
||||
def test_open_tags_in_doc
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
def test_doc_tag_ignores_nested_doc_tags
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
{% assign a = 123 {% doc %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
assert_raises(Liquid::SyntaxError) do
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
assert_template_result('', template)
|
||||
end
|
||||
|
||||
def test_doc_tag_does_not_allow_nested_docs
|
||||
error = assert_raises(Liquid::SyntaxError) do
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
{% doc %}
|
||||
{% doc %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
Liquid::Template.parse(template)
|
||||
end
|
||||
|
||||
exp_error = "Liquid syntax error: Syntax Error in 'doc' - Nested doc tags are not allowed"
|
||||
act_error = error.message
|
||||
|
||||
assert_equal(exp_error, act_error)
|
||||
end
|
||||
|
||||
def test_doc_tag_ignores_nested_raw_tags
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
{% raw %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
assert_template_result('', template)
|
||||
end
|
||||
|
||||
def test_doc_tag_raises_an_error_for_unclosed_assign
|
||||
error = assert_raises(Liquid::SyntaxError) do
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
{% assign foo = "1"
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
Liquid::Template.parse(template)
|
||||
end
|
||||
|
||||
assert_raises(Liquid::SyntaxError) do
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
{% doc %}
|
||||
{% doc %}
|
||||
{% invalid
|
||||
{% enddoc %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
end
|
||||
exp_error = "Liquid syntax error: 'doc' tag was never closed"
|
||||
act_error = error.message
|
||||
|
||||
assert_raises(Liquid::SyntaxError) do
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
assert_equal(exp_error, act_error)
|
||||
end
|
||||
|
||||
def test_doc_tag_raises_an_error_for_malformed_syntax
|
||||
error = assert_raises(Liquid::SyntaxError) do
|
||||
template = <<~LIQUID.chomp
|
||||
{% doc %}
|
||||
{% {{ {%- enddoc %}
|
||||
LIQUID
|
||||
|
||||
Liquid::Template.parse(template)
|
||||
end
|
||||
|
||||
exp_error = "Liquid syntax error: 'doc' tag was never closed"
|
||||
act_error = error.message
|
||||
|
||||
assert_equal(exp_error, act_error)
|
||||
end
|
||||
|
||||
def test_child_doc_tags_need_to_be_closed
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
{% doc %}
|
||||
{% doc %}
|
||||
{% doc %}{% enddoc %}
|
||||
{% enddoc %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
assert_raises(Liquid::SyntaxError) do
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
{% doc %}
|
||||
{% doc %}
|
||||
{% doc %}
|
||||
{% enddoc %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
end
|
||||
end
|
||||
|
||||
def test_child_raw_tags_need_to_be_closed
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
{% doc %}
|
||||
{% raw %}
|
||||
{% enddoc %}
|
||||
{% endraw %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
|
||||
assert_raises(Liquid::SyntaxError) do
|
||||
Liquid::Template.parse(<<~LIQUID.chomp)
|
||||
{% doc %}
|
||||
{% raw %}
|
||||
{% enddoc %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
end
|
||||
end
|
||||
|
||||
def test_error_line_number_is_correct
|
||||
def test_doc_tag_preserves_error_line_numbers
|
||||
template = Liquid::Template.parse(<<~LIQUID.chomp, line_numbers: true)
|
||||
{% doc %}
|
||||
{% if true %}
|
||||
@@ -119,73 +154,21 @@ class DocTagUnitTest < Minitest::Test
|
||||
{{ errors.standard_error }}
|
||||
LIQUID
|
||||
|
||||
output = template.render('errors' => ErrorDrop.new)
|
||||
expected = <<~TEXT.chomp
|
||||
|
||||
Liquid error (line 4): standard error
|
||||
TEXT
|
||||
|
||||
assert_equal(expected, output)
|
||||
assert_equal(expected, template.render('errors' => ErrorDrop.new))
|
||||
end
|
||||
|
||||
def test_doc_tag_delimiter_with_extra_strings
|
||||
assert_template_result(
|
||||
'',
|
||||
<<~LIQUID.chomp,
|
||||
{% doc %}
|
||||
{% doc %}
|
||||
{% enddoc
|
||||
{% if true %}
|
||||
{% endif %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
)
|
||||
end
|
||||
|
||||
def test_nested_doc_tag_with_extra_strings
|
||||
assert_template_result(
|
||||
'',
|
||||
<<~LIQUID.chomp,
|
||||
{% doc %}
|
||||
{% doc
|
||||
{% assign foo = 1 %}
|
||||
{% enddoc
|
||||
{% assign foo = 1 %}
|
||||
{% enddoc %}
|
||||
LIQUID
|
||||
)
|
||||
end
|
||||
|
||||
def test_ignores_delimiter_with_extra_strings
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
{% if true %}
|
||||
{% doc %}
|
||||
{% docEXTRA %}wut{% enddocEXTRA %}xyz
|
||||
{% enddoc %}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
end
|
||||
|
||||
def test_delimiter_can_have_extra_strings
|
||||
assert_template_result('', "{% doc %}123{% enddoc xyz %}")
|
||||
assert_template_result('', "{% doc %}123{% enddoc\txyz %}")
|
||||
assert_template_result('', "{% doc %}123{% enddoc\nxyz %}")
|
||||
assert_template_result('', "{% doc %}123{% enddoc\n xyz enddoc %}")
|
||||
assert_template_result('', "{%doc}{% assign a = 1 %}{%enddoc}{% endif %}")
|
||||
end
|
||||
|
||||
def test_with_whitespace_control
|
||||
def test_doc_tag_whitespace_control
|
||||
# Basic whitespace control
|
||||
assert_template_result("Hello!", " {%- doc -%}123{%- enddoc -%}Hello!")
|
||||
assert_template_result("Hello!", "{%- doc -%}123{%- enddoc -%} Hello!")
|
||||
assert_template_result("Hello!", " {%- doc -%}123{%- enddoc -%} Hello!")
|
||||
|
||||
assert_template_result("Hello!", <<~LIQUID.chomp)
|
||||
{%- doc %}Whitespace control!{% enddoc -%}
|
||||
Hello!
|
||||
LIQUID
|
||||
end
|
||||
|
||||
def test_dont_override_liquid_tag_whitespace_control
|
||||
# Whitespace control within liquid tags
|
||||
assert_template_result("Hello!World!", <<~LIQUID.chomp)
|
||||
Hello!
|
||||
{%- liquid
|
||||
@@ -195,5 +178,27 @@ class DocTagUnitTest < Minitest::Test
|
||||
-%}
|
||||
World!
|
||||
LIQUID
|
||||
|
||||
# Multiline whitespace control
|
||||
assert_template_result("Hello!", <<~LIQUID.chomp)
|
||||
{%- doc %}Whitespace control!{% enddoc -%}
|
||||
Hello!
|
||||
LIQUID
|
||||
end
|
||||
|
||||
def test_doc_tag_delimiter_handling
|
||||
assert_template_result('', <<~LIQUID.chomp)
|
||||
{% if true %}
|
||||
{% doc %}
|
||||
{% docEXTRA %}wut{% enddocEXTRA %}xyz
|
||||
{% enddoc %}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_template_result('', "{% doc %}123{% enddoc xyz %}")
|
||||
assert_template_result('', "{% doc %}123{% enddoc\txyz %}")
|
||||
assert_template_result('', "{% doc %}123{% enddoc\nxyz %}")
|
||||
assert_template_result('', "{% doc %}123{% enddoc\n xyz enddoc %}")
|
||||
assert_template_result('', "{%doc}{% assign a = 1 %}{%enddoc}{% endif %}")
|
||||
end
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user