Compare commits

..

11 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
uchoudh
ffadc64f28 Merge pull request #1172 from Shopify/add-liquid-profiling-attr
Add liquid profile attributes
2019-10-08 10:49:54 -04:00
uchoudh
fefee4c675 Add liquid profile attributes
Attribute testing

Add partial name support
2019-10-03 10:12:39 -04:00
22 changed files with 116 additions and 70 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

@@ -46,7 +46,7 @@ module Liquid
include Enumerable
class Timing
attr_reader :code, :partial, :line_number, :children
attr_reader :code, :partial, :line_number, :children, :total_time, :self_time
def initialize(node, partial)
@code = node.respond_to?(:raw) ? node.raw : node
@@ -65,6 +65,17 @@ module Liquid
def finish
@end_time = Time.now
@total_time = @end_time - @start_time
if @children.empty?
@self_time = @total_time
else
total_children_time = 0
@children.each do |child|
total_children_time += child.total_time
end
@self_time = @total_time - total_children_time
end
end
def render_time
@@ -98,8 +109,8 @@ module Liquid
Thread.current[:liquid_profiler]
end
def initialize
@partial_stack = ["<root>"]
def initialize(partial_name = "<root>")
@partial_stack = [partial_name]
@root_timing = Timing.new("", current_partial)
@timing_stack = [@root_timing]

View File

@@ -128,13 +128,13 @@ module Liquid
# Join elements of the array with certain character between them
def join(input, glue = ' ')
InputIterator.new(input).join(glue)
InputIterator.new(input, context).join(glue)
end
# Sort elements of the array
# provide optional property with which to sort an array of hashes or drops
def sort(input, property = nil)
ary = InputIterator.new(input)
ary = InputIterator.new(input, context)
return [] if ary.empty?
@@ -154,7 +154,7 @@ module Liquid
# Sort elements of an array ignoring case if strings
# provide optional property with which to sort an array of hashes or drops
def sort_natural(input, property = nil)
ary = InputIterator.new(input)
ary = InputIterator.new(input, context)
return [] if ary.empty?
@@ -174,7 +174,7 @@ module Liquid
# Filter the elements of an array to those with a certain property value.
# By default the target is any truthy value.
def where(input, property, target_value = nil)
ary = InputIterator.new(input)
ary = InputIterator.new(input, context)
if ary.empty?
[]
@@ -196,7 +196,7 @@ module Liquid
# Remove duplicate elements from an array
# provide optional property with which to determine uniqueness
def uniq(input, property = nil)
ary = InputIterator.new(input)
ary = InputIterator.new(input, context)
if property.nil?
ary.uniq
@@ -213,13 +213,13 @@ module Liquid
# Reverse the elements of an array
def reverse(input)
ary = InputIterator.new(input)
ary = InputIterator.new(input, context)
ary.reverse
end
# map/collect on a given property
def map(input, property)
InputIterator.new(input).map do |e|
InputIterator.new(input, context).map do |e|
e = e.call if e.is_a?(Proc)
if property == "to_liquid"
@@ -236,7 +236,7 @@ module Liquid
# Remove nils within an array
# provide optional property with which to check for nil
def compact(input, property = nil)
ary = InputIterator.new(input)
ary = InputIterator.new(input, context)
if property.nil?
ary.compact
@@ -280,7 +280,7 @@ module Liquid
unless array.respond_to?(:to_ary)
raise ArgumentError, "concat filter requires an array argument"
end
InputIterator.new(input).concat(array)
InputIterator.new(input, context).concat(array)
end
# prepend a string to another
@@ -421,17 +421,26 @@ 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
attr_reader :context
def raise_property_error(property)
raise Liquid::ArgumentError, "cannot select the property '#{property}'"
end
@@ -460,7 +469,8 @@ module Liquid
class InputIterator
include Enumerable
def initialize(input)
def initialize(input, context)
@context = context
@input = if input.is_a?(Array)
input.flatten
elsif input.is_a?(Hash)
@@ -499,6 +509,7 @@ module Liquid
def each
@input.each do |e|
e.context = @context if e.respond_to?(:context=)
yield(e.respond_to?(:to_liquid) ? e.to_liquid : e)
end
end

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

@@ -21,9 +21,7 @@ module Liquid
attr_reader :template_name_expr, :variable_name_expr, :attributes
def initialize(tag_name, markup, options)
super
def parse(_tokens)
if markup =~ SYNTAX
template_name = Regexp.last_match(1)
@@ -43,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

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

@@ -8,9 +8,7 @@ module Liquid
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)

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

@@ -254,7 +254,7 @@ module Liquid
if @profiling && !context.partial
raise "Profiler not loaded, require 'liquid/profiler' first" unless defined?(Liquid::Profiler)
@profiler = Profiler.new
@profiler = Profiler.new(context.template_name)
@profiler.start
begin

View File

@@ -179,6 +179,11 @@ class DropsTest < Minitest::Test
assert_equal(' carrot ', output)
end
def test_context_drop_array_with_map
output = Liquid::Template.parse(' {{ contexts | map: "bar" }} ').render!('contexts' => [ContextDrop.new, ContextDrop.new], 'bar' => "carrot")
assert_equal(' carrotcarrot ', output)
end
def test_nested_context_drop
output = Liquid::Template.parse(' {{ product.context.foo }} ').render!('product' => ProductDrop.new, 'foo' => "monkey")
assert_equal(' monkey ', output)

View File

@@ -153,4 +153,19 @@ class RenderProfilingTest < Minitest::Test
# Will profile each invocation of the for block
assert_equal(2, t.profiler[0].children.length)
end
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_operator leaf.self_time, :>, 0
end
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, :>, 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