Compare commits

..

9 Commits

Author SHA1 Message Date
Mike Angell
baf21ec3cc Fix echo tag 2019-10-16 02:00:06 +10:00
Mike Angell
7f1e25005b Fix accessors 2019-10-16 01:57:42 +10:00
Mike Angell
938ca78be6 Use accessors 2019-10-16 01:54:45 +10:00
Mike Angell
03a5375c8c Sort array in test 2019-10-14 17:04:29 +10:00
Mike Angell
a46610065a Shift tag parsing into parse method 2019-10-12 06:49:13 +10:00
uchoudh
1223444738 Fix flaky tests (#1186) 2019-10-12 02:52:07 +11:00
Mike Angell
2bfeed2b00 Resolve InputIterator dropping context (#1184)
* Resolve InputIterator dropping context

* Prefer attr_reader
2019-10-09 08:00:16 +11:00
Mike Angell
04b800d768 Add support for as in Render and Include tags (#1181)
* Add support for alias

* Remove duplicate code

* Default to template name

* Improve variable matching

* Extract render_partial

* remove method
2019-10-09 07:59:52 +11:00
Mike Angell
f1d62978ef Allow default function to handle false as value (#1144)
* Allow default function to handle false as value

* Change to named parameter

* Remove redundant freeze

* add brackets to make intention clearer

* Use named param format from liquid

* Update syntax

* document default filter
2019-10-09 04:03:33 +11:00
21 changed files with 148 additions and 71 deletions

View File

@@ -7,6 +7,7 @@ module Liquid
def initialize(tag_name, markup, options)
super
@blank = true
@body = nil
end
def parse(tokens)
@@ -17,7 +18,7 @@ module Liquid
# For backwards compatibility
def render(context)
@body.render(context)
@body&.render(context)
end
def blank?

View File

@@ -421,13 +421,20 @@ module Liquid
result.is_a?(BigDecimal) ? result.to_f : result
end
def default(input, default_value = '')
if !input || input.respond_to?(:empty?) && input.empty?
Usage.increment("default_filter_received_false_value") if input == false # See https://github.com/Shopify/liquid/issues/1127
default_value
else
input
end
# Set a default value when the input is nil, false or empty
#
# Example:
# {{ product.title | default: "No Title" }}
#
# Use `allow_false` when an input should only be tested against nil or empty and not false.
#
# Example:
# {{ product.title | default: "No Title", allow_false: true }}
#
def default(input, default_value = '', options = {})
options = {} unless options.is_a?(Hash)
false_check = options['allow_false'] ? input.nil? : !input
false_check || (input.respond_to?(:empty?) && input.empty?) ? default_value : input
end
private

View File

@@ -2,7 +2,7 @@
module Liquid
class Tag
attr_reader :nodelist, :tag_name, :line_number, :parse_context
attr_reader :nodelist, :tag_name, :line_number, :parse_context, :markup
alias_method :options, :parse_context
include ParserSwitching
@@ -17,8 +17,6 @@ module Liquid
disabled_tags.push(*tags)
end
private :new
def disabled_tags
@disabled_tags ||= []
end

View File

@@ -18,8 +18,7 @@ module Liquid
attr_reader :to, :from
def initialize(tag_name, markup, options)
super
def parse(_tokens)
if markup =~ Syntax
@to = Regexp.last_match(1)
@from = Variable.new(Regexp.last_match(2), options)

View File

@@ -15,13 +15,13 @@ module Liquid
class Capture < Block
Syntax = /(#{VariableSignature}+)/o
def initialize(tag_name, markup, options)
super
def parse(_tokens)
if markup =~ Syntax
@to = Regexp.last_match(1)
else
raise SyntaxError, options[:locale].t("errors.syntax.capture")
end
super
end
def render_to_output_buffer(context, output)

View File

@@ -7,8 +7,7 @@ module Liquid
attr_reader :blocks, :left
def initialize(tag_name, markup, options)
super
def parse(tokens)
@blocks = []
if markup =~ Syntax
@@ -16,9 +15,7 @@ module Liquid
else
raise SyntaxError, options[:locale].t("errors.syntax.case")
end
end
def parse(tokens)
body = BlockBody.new
body = @blocks.last.attachment while parse_body(body, tokens)
end

View File

@@ -19,8 +19,7 @@ module Liquid
attr_reader :variables
def initialize(tag_name, markup, options)
super
def parse(_tokens)
case markup
when NamedSyntax
@variables = variables_from_string(Regexp.last_match(2))

View File

@@ -20,8 +20,7 @@ module Liquid
# Hello: -3
#
class Decrement < Tag
def initialize(tag_name, markup, options)
super
def parse(_tokens)
@variable = markup.strip
end

View File

@@ -12,13 +12,14 @@ module Liquid
# {% echo user | link %}
#
class Echo < Tag
def initialize(tag_name, markup, parse_context)
super
attr_reader :variable
def parse(_tokens)
@variable = Variable.new(markup, parse_context)
end
def render(context)
@variable.render_to_output_buffer(context, +'')
variable&.render_to_output_buffer(context, +'')
end
end

View File

@@ -50,15 +50,11 @@ module Liquid
attr_reader :collection_name, :variable_name, :limit, :from
def initialize(tag_name, markup, options)
super
def parse(tokens)
@from = @limit = nil
parse_with_selected_parser(markup)
@for_block = BlockBody.new
@else_block = nil
end
def parse(tokens)
return unless parse_body(@for_block, tokens)
parse_body(@else_block, tokens)
end

View File

@@ -18,17 +18,13 @@ module Liquid
attr_reader :blocks
def initialize(tag_name, markup, options)
super
@blocks = []
push_block('if', markup)
end
def nodelist
@blocks.map(&:attachment)
end
def parse(tokens)
@blocks = []
push_block('if', markup)
while parse_body(@blocks.last.attachment, tokens)
end
end

View File

@@ -16,18 +16,18 @@ module Liquid
# {% include 'product' for products %}
#
class Include < Tag
Syntax = /(#{QuotedFragment}+)(\s+(?:with|for)\s+(#{QuotedFragment}+))?/o
SYNTAX = /(#{QuotedFragment}+)(\s+(?:with|for)\s+(#{QuotedFragment}+))?(\s+(?:as)\s+(#{VariableSegment}+))?/o
Syntax = SYNTAX
attr_reader :template_name_expr, :variable_name_expr, :attributes
def initialize(tag_name, markup, options)
super
if markup =~ Syntax
def parse(_tokens)
if markup =~ SYNTAX
template_name = Regexp.last_match(1)
variable_name = Regexp.last_match(3)
@alias_name = Regexp.last_match(5)
@variable_name_expr = variable_name ? Expression.parse(variable_name) : nil
@template_name_expr = Expression.parse(template_name)
@attributes = {}
@@ -41,9 +41,6 @@ module Liquid
end
end
def parse(_tokens)
end
def render_to_output_buffer(context, output)
template_name = context.evaluate(@template_name_expr)
raise ArgumentError, options[:locale].t("errors.argument.include") unless template_name
@@ -54,7 +51,7 @@ module Liquid
parse_context: parse_context
)
context_variable_name = template_name.split('/').last
context_variable_name = @alias_name || template_name.split('/').last
variable = if @variable_name_expr
context.evaluate(@variable_name_expr)

View File

@@ -17,8 +17,7 @@ module Liquid
# Hello: 2
#
class Increment < Tag
def initialize(tag_name, markup, options)
super
def parse(_tokens)
@variable = markup.strip
end

View File

@@ -5,13 +5,8 @@ module Liquid
Syntax = /\A\s*\z/
FullTokenPossiblyInvalid = /\A(.*)#{TagStart}\s*(\w+)\s*(.*)?#{TagEnd}\z/om
def initialize(tag_name, markup, parse_context)
super
ensure_valid_markup(tag_name, markup, parse_context)
end
def parse(tokens)
ensure_valid_markup(tag_name, markup, parse_context)
@body = +''
while (token = tokens.shift)
if token =~ FullTokenPossiblyInvalid

View File

@@ -2,19 +2,20 @@
module Liquid
class Render < Tag
SYNTAX = /(#{QuotedString})#{QuotedFragment}*/o
SYNTAX = /(#{QuotedString}+)(\s+(?:with|for)\s+(#{QuotedFragment}+))?(\s+(?:as)\s+(#{VariableSegment}+))?/o
disable_tags "include"
attr_reader :template_name_expr, :attributes
def initialize(tag_name, markup, options)
super
def parse(_tokens)
raise SyntaxError, options[:locale].t("errors.syntax.render") unless markup =~ SYNTAX
template_name = Regexp.last_match(1)
variable_name = Regexp.last_match(3)
@alias_name = Regexp.last_match(5)
@variable_name_expr = variable_name ? Expression.parse(variable_name) : nil
@template_name_expr = Expression.parse(template_name)
@attributes = {}
@@ -38,13 +39,21 @@ module Liquid
parse_context: parse_context
)
inner_context = context.new_isolated_subcontext
inner_context.template_name = template_name
inner_context.partial = true
@attributes.each do |key, value|
inner_context[key] = context.evaluate(value)
end
partial.render_to_output_buffer(inner_context, output)
context_variable_name = @alias_name || template_name.split('/').last
render_partial_func = ->(var) {
inner_context = context.new_isolated_subcontext
inner_context.template_name = template_name
inner_context.partial = true
@attributes.each do |key, value|
inner_context[key] = context.evaluate(value)
end
inner_context[context_variable_name] = var unless var.nil?
partial.render_to_output_buffer(inner_context, output)
}
variable = @variable_name_expr ? context.evaluate(@variable_name_expr) : nil
variable.is_a?(Array) ? variable.each(&render_partial_func) : render_partial_func.call(variable)
output
end

View File

@@ -6,8 +6,7 @@ module Liquid
attr_reader :variable_name, :collection_name, :attributes
def initialize(tag_name, markup, options)
super
def parse(_tokens)
if markup =~ Syntax
@variable_name = Regexp.last_match(1)
@collection_name = Expression.parse(Regexp.last_match(2))
@@ -18,6 +17,7 @@ module Liquid
else
raise SyntaxError, options[:locale].t("errors.syntax.table_row")
end
super
end
def render_to_output_buffer(context, output)

View File

@@ -154,18 +154,18 @@ class RenderProfilingTest < Minitest::Test
assert_equal(2, t.profiler[0].children.length)
end
def test_total_time_equals_self_time_in_leaf
def test_profiling_supports_self_time
t = Template.parse("{% for item in collection %} {{ item }} {% endfor %}", profile: true)
t.render!("collection" => ["one", "two"])
leaf = t.profiler[0].children[0]
assert_equal leaf.total_time, leaf.self_time
assert_operator leaf.self_time, :>, 0
end
def test_total_time_greater_than_self_time_in_node
def test_profiling_supports_total_time
t = Template.parse("{% if true %} {% increment test %} {{ test }} {% endif %}", profile: true)
t.render!
assert_operator t.profiler[0].total_time, :>, t.profiler[0].self_time
assert_operator t.profiler[0].total_time, :>, 0
end
end

View File

@@ -685,6 +685,17 @@ class StandardFiltersTest < Minitest::Test
assert_equal("bar", @filters.default(false, "bar"))
assert_equal("bar", @filters.default([], "bar"))
assert_equal("bar", @filters.default({}, "bar"))
assert_template_result('bar', "{{ false | default: 'bar' }}")
end
def test_default_handle_false
assert_equal("foo", @filters.default("foo", "bar", "allow_false" => true))
assert_equal("bar", @filters.default(nil, "bar", "allow_false" => true))
assert_equal("bar", @filters.default("", "bar", "allow_false" => true))
assert_equal(false, @filters.default(false, "bar", "allow_false" => true))
assert_equal("bar", @filters.default([], "bar", "allow_false" => true))
assert_equal("bar", @filters.default({}, "bar", "allow_false" => true))
assert_template_result('false', "{{ false | default: 'bar', allow_false: true }}")
end
def test_cannot_access_private_methods

View File

@@ -0,0 +1,20 @@
# frozen_string_literal: true
require 'test_helper'
class TagTest < Minitest::Test
include Liquid
def test_all_tags_with_no_parse_can_render
Template.tags.each do |key, _tag|
Template.tags[key].new(key, '', ParseContext.new).render(Context.new)
assert_nil(nil)
end
end
def test_all_tags_are_registered
tags = Template.tags.map { |key, _tag| key }
expected_tags = %w(assign break capture case comment continue cycle decrement echo for if ifchanged include increment raw render tablerow unless)
assert_equal(expected_tags, tags.sort)
end
end

View File

@@ -8,6 +8,9 @@ class TestFileSystem
when "product"
"Product: {{ product.title }} "
when "product_alias"
"Product: {{ product.title }} "
when "locale_variables"
"Locale: {{echo1}} {{echo2}}"
@@ -91,6 +94,16 @@ class IncludeTagTest < Minitest::Test
"{% include 'product' with products[0] %}", "products" => [{ 'title' => 'Draft 151cm' }, { 'title' => 'Element 155cm' }])
end
def test_include_tag_with_alias
assert_template_result("Product: Draft 151cm ",
"{% include 'product_alias' with products[0] as product %}", "products" => [{ 'title' => 'Draft 151cm' }, { 'title' => 'Element 155cm' }])
end
def test_include_tag_for_alias
assert_template_result("Product: Draft 151cm Product: Element 155cm ",
"{% include 'product_alias' for products as product %}", "products" => [{ 'title' => 'Draft 151cm' }, { 'title' => 'Element 155cm' }])
end
def test_include_tag_with_default_name
assert_template_result("Product: Draft 151cm ",
"{% include 'product' %}", "product" => { 'title' => 'Draft 151cm' })

View File

@@ -165,4 +165,44 @@ class RenderTagTest < Minitest::Test
assert_template_result('include usage is not allowed in this contextinclude usage is not allowed in this context', '{% render "nested_render_with_sibling_include" %}')
end
def test_render_tag_with
Liquid::Template.file_system = StubFileSystem.new(
'product' => "Product: {{ product.title }} ",
'product_alias' => "Product: {{ product.title }} ",
)
assert_template_result("Product: Draft 151cm ",
"{% render 'product' with products[0] %}", "products" => [{ 'title' => 'Draft 151cm' }, { 'title' => 'Element 155cm' }])
end
def test_render_tag_with_alias
Liquid::Template.file_system = StubFileSystem.new(
'product' => "Product: {{ product.title }} ",
'product_alias' => "Product: {{ product.title }} ",
)
assert_template_result("Product: Draft 151cm ",
"{% render 'product_alias' with products[0] as product %}", "products" => [{ 'title' => 'Draft 151cm' }, { 'title' => 'Element 155cm' }])
end
def test_render_tag_for_alias
Liquid::Template.file_system = StubFileSystem.new(
'product' => "Product: {{ product.title }} ",
'product_alias' => "Product: {{ product.title }} ",
)
assert_template_result("Product: Draft 151cm Product: Element 155cm ",
"{% render 'product_alias' for products as product %}", "products" => [{ 'title' => 'Draft 151cm' }, { 'title' => 'Element 155cm' }])
end
def test_render_tag_for
Liquid::Template.file_system = StubFileSystem.new(
'product' => "Product: {{ product.title }} ",
'product_alias' => "Product: {{ product.title }} ",
)
assert_template_result("Product: Draft 151cm Product: Element 155cm ",
"{% render 'product' for products %}", "products" => [{ 'title' => 'Draft 151cm' }, { 'title' => 'Element 155cm' }])
end
end