Compare commits

..
Author SHA1 Message Date
Guilherme Carreiro a7c4c3ae06 * Move expression handling from variable.rb to expression.rb
* Update test suite to validate parity
* Remove parentheses handling
* Split boolean into comparison and logical expressions
2025-03-05 15:13:02 +01:00
Guilherme Carreiro a3a0cf9b81 Update the parser to use the new tokens 2025-03-05 14:49:59 +01:00
Guilherme Carreiro 5dceb83db1 Introduce support to boolean operators in the lexer 2025-03-05 14:49:10 +01:00
Albert Chu 76d628ddc7 Added a lot more boolean unit tests 2025-03-04 17:52:16 -07:00
Albert Chu 9be1b65bcc Rough support for parenthesis. Also better respect for and/or order precedence. 2025-03-04 17:19:27 -07:00
Albert Chu 19e9ba36ec Support for simple boolean comparisons and boolean assignments 2025-03-04 17:08:23 -07:00
Albert Chu a2de2dcdb6 TDD: Improved unit tests in boolean_unit_test.rb
Added tests for existing usage cases to avoid breaking important logic when introducing changes in subsequent commits.
2025-03-04 16:58:36 -07:00
Albert Chu 0667bfaa2e Removed infix operators from this PR 2025-03-04 16:33:27 -07:00
Albert Chu de669a3415 TDD: Unit tests for new liquid syntax 2025-03-04 12:59:45 -07:00
2d0442798b chore: Add RUBYOPT configuration to the tests (#1859)
Co-authored-by: Ian Ker-Seymer <[email protected]>
2025-02-26 14:28:17 -05:00
Guilherme CarreiroandGuilherme Carreiro 6453a0ea48 Implement nodelist in the Doc tag so it may be visited 2025-02-26 13:14:39 +01:00
Guilherme CarreiroandGuilherme Carreiro a398b4cc74 Fix History.md 2025-02-25 08:50:46 +01:00
Guilherme CarreiroandGuilherme Carreiro cca9fe99cf Bump version to 5.8.0 2025-02-25 08:50:46 +01:00
Guilherme CarreiroandGuilherme Carreiro 17d327988d Rename {% doc %} constant strictly validates the abscense of args 2025-02-20 12:37:09 +01:00
Guilherme CarreiroandGuilherme Carreiro f643af4bac Update the implementation to make {% doc %} as strict as {% raw %} 2025-02-20 12:37:09 +01:00
Guilherme CarreiroandGuilherme Carreiro ae8a0a86ac Remove misleading unit test (thank you, @EvilGenius13) 2025-02-20 12:37:09 +01:00
Guilherme CarreiroandGuilherme Carreiro b439d0da53 Update {% doc %} to no longer support nested tags (as {% comment %} does) 2025-02-20 12:37:09 +01:00
Guilherme CarreiroandGuilherme Carreiro 16592cfb8f Add support to LiquidDoc with the new {% doc %} tag 2025-02-20 12:37:09 +01:00
Chris AtLeeandGitHub da4afd4156 Merge pull request #1905 from Shopify/catlee/invalid_utf8
Raise SyntaxError on invalid UTF8 strings in lexer/tokenizer
2025-02-13 09:24:11 -05:00
Chris AtLeeandGitHub 1bb3091208 Merge pull request #1909 from Shopify/catlee/5.7.3
Bump version to 5.7.3
2025-02-13 09:22:47 -05:00
Max StoiberandGitHub 040801b32c Fix array has filters referring to some (#1910) 2025-02-12 17:37:49 +01:00
Chris AtLee 550135c0b9 Raise SyntaxError on invalid UTF8 strings in lexer/tokenizer 2025-02-11 14:23:15 -05:00
Chris AtLee aec966eed7 Bump version to 5.7.3 2025-02-11 14:21:14 -05:00
Michael GoandGitHub bfe29e11be Merge pull request #1907 from Shopify/nested-properties
Fix array filters to not support nested properties
2025-01-31 12:35:03 -04:00
Guilherme Carreiro f9454d8cf3 Fix array filters to not support nested properties 2025-01-31 13:53:17 +01:00
Guilherme CarreiroandGuilherme Carreiro 8dd9279265 Fix release date on History.md 2025-01-24 15:34:48 +01:00
Guilherme CarreiroandGuilherme Carreiro bf1419b8ac Apply the same fix for find_index and has 2025-01-24 08:39:01 +01:00
Guilherme CarreiroandGuilherme Carreiro 5718c4cee2 Fix the find filter to return nil when filtering empty arrays 2025-01-24 08:39:01 +01:00
Guilherme CarreiroandGitHub b0dbc62696 Fix bundle exec rake example (#1900)
* Fix `bundle exec rake example`

* Move 'webrick' from 'benchmark/test' to 'development'
2025-01-23 08:21:38 +01:00
03aafa974c Bump to 5.7.0 (#1894)
* Bump to 5.7.0

* Update 'History.md'

* Update 'Releasing' steps

* Update CONTRIBUTING.md

Co-authored-by: Gray Gilmore <[email protected]>

* Update History.md

Co-authored-by: Ian Ker-Seymer <[email protected]>

---------

Co-authored-by: Gray Gilmore <[email protected]>
Co-authored-by: Ian Ker-Seymer <[email protected]>
2025-01-17 12:10:18 +01:00
Ian Ker-SeymerandGitHub 6372289ba3 Ensure we use InputIterator#each when in join filter (#1898) 2025-01-16 11:36:36 -05:00
Ian Ker-SeymerandGitHub 0ec52a40b5 Use Liquid::Utils.to_s for join filter (#1897) 2025-01-16 11:21:58 -05:00
Ian Ker-SeymerandGitHub 74af735f0e Allow for custom < Hash classes to override #to_s (#1896) 2025-01-16 11:16:13 -05:00
24 changed files with 808 additions and 172 deletions
+15
View File
@@ -14,8 +14,21 @@ jobs:
- { ruby: 3.0, allowed-failure: false } # minimum supported - { ruby: 3.0, allowed-failure: false } # minimum supported
- { ruby: 3.2, allowed-failure: false } - { ruby: 3.2, allowed-failure: false }
- { ruby: 3.3, allowed-failure: false } - { ruby: 3.3, allowed-failure: false }
- { ruby: 3.3, allowed-failure: false }
- { ruby: 3.4, allowed-failure: false } # latest - { ruby: 3.4, allowed-failure: false } # latest
- {
ruby: 3.4,
allowed-failure: false,
rubyopt: "--enable-frozen-string-literal",
}
- { ruby: 3.4, allowed-failure: false, rubyopt: "--yjit" }
- { ruby: ruby-head, allowed-failure: false } - { ruby: ruby-head, allowed-failure: false }
- {
ruby: ruby-head,
allowed-failure: false,
rubyopt: "--enable-frozen-string-literal",
}
- { ruby: ruby-head, allowed-failure: false, rubyopt: "--yjit" }
name: Test Ruby ${{ matrix.entry.ruby }} name: Test Ruby ${{ matrix.entry.ruby }}
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
@@ -26,6 +39,8 @@ jobs:
bundler: latest bundler: latest
- run: bundle exec rake - run: bundle exec rake
continue-on-error: ${{ matrix.entry.allowed-failure }} continue-on-error: ${{ matrix.entry.allowed-failure }}
env:
RUBYOPT: ${{ matrix.entry.rubyopt }}
memory_profile: memory_profile:
runs-on: ubuntu-latest runs-on: ubuntu-latest
+1 -1
View File
@@ -1 +1 @@
3.3.6 3.4.1
+4
View File
@@ -20,6 +20,10 @@ group :benchmark, :test do
end end
end end
group :development do
gem "webrick"
end
group :test do group :test do
gem 'rubocop', '~> 1.61.0' gem 'rubocop', '~> 1.61.0'
gem 'rubocop-shopify', '~> 2.12.0', require: false gem 'rubocop-shopify', '~> 2.12.0', require: false
+25 -3
View File
@@ -1,12 +1,34 @@
# Liquid Change Log # Liquid Change Log
## 5.8.0 (unreleased) ## 5.8.1 (unreleased)
## 5.8.1
* Fix `{% doc %}` tag to be visitable [Guilherme Carreiro]
## 5.8.0
* Introduce the new `{% doc %}` tag [Guilherme Carreiro]
## 5.7.3
* Raise Liquid::SyntaxError when parsing invalidly encoded strings [Chris AtLee]
## 5.7.2 2025-01-31
* Fix array filters to not support nested properties [Guilherme Carreiro]
## 5.7.1 2025-01-24
* Fix the `find` and `find_index`filters to return `nil` when filtering empty arrays [Guilherme Carreiro]
* Fix the `has` filter to return `false` when filtering empty arrays [Guilherme Carreiro]
## 5.7.0 2025-01-16 ## 5.7.0 2025-01-16
### Features ### Features
* Add `find`, `find_index`, `has`, and `reject` filters to arrays
* Compatibility with Ruby 3.4 * Add `find`, `find_index`, `has`, and `reject` filters to arrays [Guilherme Carreiro]
* Compatibility with Ruby 3.4 [Ian Ker-Seymer]
## 5.6.4 2025-01-14 ## 5.6.4 2025-01-14
+2
View File
@@ -80,6 +80,8 @@ require 'liquid/variable_lookup'
require 'liquid/range_lookup' require 'liquid/range_lookup'
require 'liquid/resource_limits' require 'liquid/resource_limits'
require 'liquid/expression' require 'liquid/expression'
require 'liquid/expression/comparison_expression'
require 'liquid/expression/logical_expression'
require 'liquid/template' require 'liquid/template'
require 'liquid/condition' require 'liquid/condition'
require 'liquid/utils' require 'liquid/utils'
+3
View File
@@ -51,6 +51,9 @@ module Liquid
end end
def inner_parse(markup, ss, cache) def inner_parse(markup, ss, cache)
return LogicalExpression.parse(markup, ss, cache) if LogicalExpression.logical?(markup)
return ComparisonExpression.parse(markup, ss, cache) if ComparisonExpression.comparison?(markup)
if (markup.start_with?("(") && markup.end_with?(")")) && markup =~ RANGES_REGEX if (markup.start_with?("(") && markup.end_with?(")")) && markup =~ RANGES_REGEX
return RangeLookup.parse( return RangeLookup.parse(
Regexp.last_match(1), Regexp.last_match(1),
@@ -0,0 +1,29 @@
# frozen_string_literal: true
module Liquid
class Expression
class ComparisonExpression
COMPARISON_REGEX = /\A\s*(.+?)\s*(==|!=|<>|<=|>=|<|>|contains)\s*(.+)\s*\z/
class << self
def comparison?(markup)
markup =~ COMPARISON_REGEX
end
def parse(markup, ss, cache)
match = markup.match(COMPARISON_REGEX)
if match
left = Expression.parse(match[1].strip, ss, cache)
operator = match[2].strip
right = Expression.parse(match[3].strip, ss, cache)
return Condition.new(left, operator, right)
end
Condition.new(parse(markup, ss, cache), nil, nil)
end
end
end
end
end
@@ -0,0 +1,56 @@
# frozen_string_literal: true
module Liquid
class Expression
class LogicalExpression
LOGICAL_REGEX = /\A\s*(.+?)\s+(and|or)\s+(.+)\s*\z/i
EXPRESSIONS_AND_OPERATORS = /(?:\b(?:\s?and\s?|\s?or\s?)\b|(?:\s*(?!\b(?:\s?and\s?|\s?or\s?)\b)(?:#{QuotedFragment}|\S+)\s*)+)/o
BOOLEAN_OPERATORS = ['and', 'or'].freeze
class << self
def logical?(markup)
markup =~ LOGICAL_REGEX
end
def parse(markup, ss, cache)
expressions = markup.scan(EXPRESSIONS_AND_OPERATORS)
last_expr = expressions.pop
condition = if ComparisonExpression.comparison?(last_expr)
ComparisonExpression.parse(last_expr, ss, cache)
elsif LOGICAL_REGEX.match?(last_expr)
LogicalExpression.parse(last_expr, ss, cache)
else
Condition.new(Expression.parse(last_expr, ss, cache), nil, nil)
end
until expressions.empty?
operator = expressions.pop.to_s.strip
next unless BOOLEAN_OPERATORS.include?(operator)
expr = expressions.pop.to_s.strip
new_condition = if ComparisonExpression.comparison?(expr)
ComparisonExpression.parse(expr, ss, cache)
elsif LOGICAL_REGEX.match?(expr)
LogicalExpression.parse(expr, ss, cache)
else
Condition.new(Expression.parse(expr, ss, cache), nil, nil)
end
if operator == 'and'
new_condition.and(condition)
else # operator == 'or'
new_condition.or(condition)
end
condition = new_condition
end
condition
end
end
end
end
end
+12
View File
@@ -14,6 +14,8 @@ module Liquid
COMPARISON_LESS_THAN = [:comparison, "<"].freeze COMPARISON_LESS_THAN = [:comparison, "<"].freeze
COMPARISON_LESS_THAN_OR_EQUAL = [:comparison, "<="].freeze COMPARISON_LESS_THAN_OR_EQUAL = [:comparison, "<="].freeze
COMPARISON_NOT_EQUAL_ALT = [:comparison, "<>"].freeze COMPARISON_NOT_EQUAL_ALT = [:comparison, "<>"].freeze
BOOLEAN_AND = [:boolean_operator, "and"].freeze
BOOLEAN_OR = [:boolean_operator, "or"].freeze
DASH = [:dash, "-"].freeze DASH = [:dash, "-"].freeze
DOT = [:dot, "."].freeze DOT = [:dot, "."].freeze
DOTDOT = [:dotdot, ".."].freeze DOTDOT = [:dotdot, ".."].freeze
@@ -151,6 +153,10 @@ module Liquid
# Special case for "contains" # Special case for "contains"
output << if type == :id && t == "contains" && output.last&.first != :dot output << if type == :id && t == "contains" && output.last&.first != :dot
COMPARISON_CONTAINS COMPARISON_CONTAINS
elsif type == :id && t == "and" && output.last&.first != :dot
BOOLEAN_AND
elsif type == :id && t == "or" && output.last&.first != :dot
BOOLEAN_OR
else else
[type, t] [type, t]
end end
@@ -161,6 +167,12 @@ module Liquid
end end
# rubocop:enable Metrics/BlockNesting # rubocop:enable Metrics/BlockNesting
output << EOS output << EOS
rescue ::ArgumentError => e
if e.message == "invalid byte sequence in #{ss.string.encoding}"
raise SyntaxError, "Invalid byte sequence in #{ss.string.encoding}"
else
raise
end
end end
def raise_syntax_error(start_pos, ss) def raise_syntax_error(start_pos, ss)
+2
View File
@@ -2,12 +2,14 @@
errors: errors:
syntax: syntax:
tag_unexpected_args: "Syntax Error in '%{tag}' - Valid syntax: %{tag}" tag_unexpected_args: "Syntax Error in '%{tag}' - Valid syntax: %{tag}"
block_tag_unexpected_args: "Syntax Error in '%{tag}' - Valid syntax: {% %{tag} %}{% end%{tag} %}"
assign: "Syntax Error in 'assign' - Valid syntax: assign [var] = [source]" assign: "Syntax Error in 'assign' - Valid syntax: assign [var] = [source]"
capture: "Syntax Error in 'capture' - Valid syntax: capture [var]" capture: "Syntax Error in 'capture' - Valid syntax: capture [var]"
case: "Syntax Error in 'case' - Valid syntax: case [condition]" case: "Syntax Error in 'case' - Valid syntax: case [condition]"
case_invalid_when: "Syntax Error in tag 'case' - Valid when condition: {% when [condition] [or condition2...] %}" case_invalid_when: "Syntax Error in tag 'case' - Valid when condition: {% when [condition] [or condition2...] %}"
case_invalid_else: "Syntax Error in tag 'case' - Valid else condition: {% else %} (no parameters) " case_invalid_else: "Syntax Error in tag 'case' - Valid else condition: {% else %} (no parameters) "
cycle: "Syntax Error in 'cycle' - Valid syntax: cycle [name :] var [, var2, var3 ...]" cycle: "Syntax Error in 'cycle' - Valid syntax: cycle [name :] var [, var2, var3 ...]"
doc_invalid_nested: "Syntax Error in 'doc' - Nested doc tags are not allowed"
for: "Syntax Error in 'for loop' - Valid syntax: for [item] in [collection]" for: "Syntax Error in 'for loop' - Valid syntax: for [item] in [collection]"
for_invalid_in: "For loops require an 'in' clause" for_invalid_in: "For loops require an 'in' clause"
for_invalid_attribute: "Invalid attribute in for loop. Valid attributes are limit and offset" for_invalid_attribute: "Invalid attribute in for loop. Valid attributes are limit and offset"
+16 -1
View File
@@ -48,7 +48,7 @@ module Liquid
def expression def expression
token = @tokens[@p] token = @tokens[@p]
case token[0] expr = case token[0]
when :id when :id
str = consume str = consume
str << variable_lookups str << variable_lookups
@@ -69,6 +69,21 @@ module Liquid
else else
raise SyntaxError, "#{token} is not a valid expression" raise SyntaxError, "#{token} is not a valid expression"
end end
if look(:comparison)
operator = consume(:comparison)
left = expr
right = expression
"#{left} #{operator} #{right}"
elsif look(:boolean_operator)
operator = consume(:boolean_operator)
left = expr
right = expression
"#{left} #{operator} #{right}"
else
expr
end
end end
def argument def argument
+26 -40
View File
@@ -387,7 +387,7 @@ module Liquid
end end
elsif ary.all? { |el| el.respond_to?(:[]) } elsif ary.all? { |el| el.respond_to?(:[]) }
begin begin
ary.sort { |a, b| nil_safe_compare(fetch_property(a, property), fetch_property(b, property)) } ary.sort { |a, b| nil_safe_compare(a[property], b[property]) }
rescue TypeError rescue TypeError
raise_property_error(property) raise_property_error(property)
end end
@@ -416,7 +416,7 @@ module Liquid
end end
elsif ary.all? { |el| el.respond_to?(:[]) } elsif ary.all? { |el| el.respond_to?(:[]) }
begin begin
ary.sort { |a, b| nil_safe_casecmp(fetch_property(a, property), fetch_property(b, property)) } ary.sort { |a, b| nil_safe_casecmp(a[property], b[property]) }
rescue TypeError rescue TypeError
raise_property_error(property) raise_property_error(property)
end end
@@ -456,10 +456,10 @@ module Liquid
# Tests if any item in an array has a specific property value. # Tests if any item in an array has a specific property value.
# @liquid_description # @liquid_description
# This requires you to provide both the property name and the associated value. # This requires you to provide both the property name and the associated value.
# @liquid_syntax array | some: string, string # @liquid_syntax array | has: string, string
# @liquid_return [boolean] # @liquid_return [boolean]
def has(input, property, target_value = nil) def has(input, property, target_value = nil)
filter_array(input, property, target_value) { |ary, &block| ary.any?(&block) } filter_array(input, property, target_value, false) { |ary, &block| ary.any?(&block) }
end end
# @liquid_public_docs # @liquid_public_docs
@@ -472,7 +472,7 @@ module Liquid
# @liquid_syntax array | find: string, string # @liquid_syntax array | find: string, string
# @liquid_return [untyped] # @liquid_return [untyped]
def find(input, property, target_value = nil) def find(input, property, target_value = nil)
filter_array(input, property, target_value) { |ary, &block| ary.find(&block) } filter_array(input, property, target_value, nil) { |ary, &block| ary.find(&block) }
end end
# @liquid_public_docs # @liquid_public_docs
@@ -485,7 +485,7 @@ module Liquid
# @liquid_syntax array | find_index: string, string # @liquid_syntax array | find_index: string, string
# @liquid_return [number] # @liquid_return [number]
def find_index(input, property, target_value = nil) def find_index(input, property, target_value = nil)
filter_array(input, property, target_value) { |ary, &block| ary.find_index(&block) } filter_array(input, property, target_value, nil) { |ary, &block| ary.find_index(&block) }
end end
# @liquid_public_docs # @liquid_public_docs
@@ -504,7 +504,7 @@ module Liquid
[] []
else else
ary.uniq do |item| ary.uniq do |item|
fetch_property(item, property) item[property]
rescue TypeError rescue TypeError
raise_property_error(property) raise_property_error(property)
rescue NoMethodError rescue NoMethodError
@@ -540,7 +540,7 @@ module Liquid
if property == "to_liquid" if property == "to_liquid"
e e
elsif e.respond_to?(:[]) elsif e.respond_to?(:[])
r = fetch_property(e, property) r = e[property]
r.is_a?(Proc) ? r.call : r r.is_a?(Proc) ? r.call : r
end end
end end
@@ -564,7 +564,7 @@ module Liquid
[] []
else else
ary.reject do |item| ary.reject do |item|
fetch_property(item, property).nil? item[property].nil?
rescue TypeError rescue TypeError
raise_property_error(property) raise_property_error(property)
rescue NoMethodError rescue NoMethodError
@@ -950,7 +950,7 @@ module Liquid
if property.nil? if property.nil?
item item
elsif item.respond_to?(:[]) elsif item.respond_to?(:[])
fetch_property(item, property) item[property]
else else
0 0
end end
@@ -969,16 +969,16 @@ module Liquid
attr_reader :context attr_reader :context
def filter_array(input, property, target_value, &block) def filter_array(input, property, target_value, default_value = [], &block)
ary = InputIterator.new(input, context) ary = InputIterator.new(input, context)
return [] if ary.empty? return default_value if ary.empty?
block.call(ary) do |item| block.call(ary) do |item|
if target_value.nil? if target_value.nil?
fetch_property(item, property) item[property]
else else
fetch_property(item, property) == target_value item[property] == target_value
end end
rescue TypeError rescue TypeError
raise_property_error(property) raise_property_error(property)
@@ -988,31 +988,6 @@ module Liquid
end end
end end
def fetch_property(drop, property_or_keys)
##
# This keeps backward compatibility by supporting properties containing
# dots. This is valid in Liquid syntax and used in some runtimes, such as
# Shopify with metafields.
#
# Using this approach, properties like 'price.value' can be accessed in
# both of the following examples:
#
# ```
# [
# { 'name' => 'Item 1', 'price.price' => 40000 },
# { 'name' => 'Item 2', 'price' => { 'value' => 39900 } }
# ]
# ```
value = drop[property_or_keys]
return value if !value.nil? || !property_or_keys.is_a?(String)
keys = property_or_keys.split('.')
keys.reduce(drop) do |drop, key|
drop.respond_to?(:[]) ? drop[key] : drop
end
end
def raise_property_error(property) def raise_property_error(property)
raise Liquid::ArgumentError, "cannot select the property '#{property}'" raise Liquid::ArgumentError, "cannot select the property '#{property}'"
end end
@@ -1063,7 +1038,18 @@ module Liquid
end end
def join(glue) def join(glue)
to_a.join(glue.to_s) first = true
output = +""
each do |item|
if first
first = false
else
output << glue
end
output << Liquid::Utils.to_s(item)
end
output
end end
def concat(args) def concat(args)
+2
View File
@@ -19,6 +19,7 @@ require_relative "tags/comment"
require_relative "tags/raw" require_relative "tags/raw"
require_relative "tags/render" require_relative "tags/render"
require_relative "tags/cycle" require_relative "tags/cycle"
require_relative "tags/doc"
module Liquid module Liquid
module Tags module Tags
@@ -42,6 +43,7 @@ module Liquid
'if' => If, 'if' => If,
'echo' => Echo, 'echo' => Echo,
'tablerow' => TableRow, 'tablerow' => TableRow,
'doc' => Doc,
}.freeze }.freeze
end end
end end
+74
View File
@@ -0,0 +1,74 @@
# frozen_string_literal: true
module Liquid
# @liquid_public_docs
# @liquid_type tag
# @liquid_category syntax
# @liquid_name doc
# @liquid_summary
# Documents template elements with annotations.
# @liquid_description
# The `doc` tag allows developers to include documentation within Liquid
# templates. Any content inside `doc` tags is not rendered or outputted.
# Liquid code inside will be parsed but not executed. This facilitates
# tooling support for features like code completion, linting, and inline
# documentation.
# @liquid_syntax
# {% doc %}
# Renders a message.
#
# @param {string} foo - A foo value.
# @param {string} [bar] - An optional bar value.
#
# @example
# {% render 'message', foo: 'Hello', bar: 'World' %}
# {% enddoc %}
# {{ foo }}, {{ bar }}!
class Doc < Block
NO_UNEXPECTED_ARGS = /\A\s*\z/
def initialize(tag_name, markup, parse_context)
super
ensure_valid_markup(tag_name, markup, parse_context)
end
def parse(tokens)
while (token = tokens.shift)
tag_name = token =~ BlockBody::FullTokenPossiblyInvalid && Regexp.last_match(2)
raise_nested_doc_error if tag_name == @tag_name
if tag_name == block_delimiter
parse_context.trim_whitespace = (token[-3] == WhitespaceControl)
return
end
end
raise_tag_never_closed(block_name)
end
def render_to_output_buffer(_context, output)
output
end
def blank?
true
end
def nodelist
[]
end
private
def ensure_valid_markup(tag_name, markup, parse_context)
unless NO_UNEXPECTED_ARGS.match?(markup)
raise SyntaxError, parse_context.locale.t("errors.syntax.block_tag_unexpected_args", tag: tag_name)
end
end
def raise_nested_doc_error
raise SyntaxError, parse_context.locale.t("errors.syntax.doc_invalid_nested")
end
end
end
+6
View File
@@ -103,6 +103,12 @@ module Liquid
pos = @ss.pos -= 2 pos = @ss.pos -= 2
@source.byteslice(start, pos - start) @source.byteslice(start, pos - start)
rescue ::ArgumentError => e
if e.message == "invalid byte sequence in #{@ss.string.encoding}"
raise SyntaxError, "Invalid byte sequence in #{@ss.string.encoding}"
else
raise
end
end end
def next_variable_token def next_variable_token
+28 -18
View File
@@ -90,34 +90,38 @@ module Liquid
obj obj
end end
if RUBY_VERSION >= '3.4' def self.to_s(obj, seen = {})
def self.to_s(obj, seen = {}) case obj
case obj when Hash
when Hash # If the custom hash implementation overrides `#to_s`, use their
# custom implementation. Otherwise we use Liquid's default
# implementation.
if obj.class.instance_method(:to_s) == HASH_TO_S_METHOD
hash_inspect(obj, seen) hash_inspect(obj, seen)
when Array
array_inspect(obj, seen)
else else
obj.to_s obj.to_s
end end
when Array
array_inspect(obj, seen)
else
obj.to_s
end end
end
def self.inspect(obj, seen = {}) def self.inspect(obj, seen = {})
case obj case obj
when Hash when Hash
# If the custom hash implementation overrides `#inspect`, use their
# custom implementation. Otherwise we use Liquid's default
# implementation.
if obj.class.instance_method(:inspect) == HASH_INSPECT_METHOD
hash_inspect(obj, seen) hash_inspect(obj, seen)
when Array
array_inspect(obj, seen)
else else
obj.inspect obj.inspect
end end
end when Array
else array_inspect(obj, seen)
def self.to_s(obj, seen = nil) else
obj.to_s
end
def self.inspect(obj, seen = nil)
obj.inspect obj.inspect
end end
end end
@@ -175,5 +179,11 @@ module Liquid
ensure ensure
seen.delete(hash.object_id) seen.delete(hash.object_id)
end end
HASH_TO_S_METHOD = Hash.instance_method(:to_s)
private_constant :HASH_TO_S_METHOD
HASH_INSPECT_METHOD = Hash.instance_method(:inspect)
private_constant :HASH_INSPECT_METHOD
end end
end end
+1 -1
View File
@@ -2,5 +2,5 @@
# frozen_string_literal: true # frozen_string_literal: true
module Liquid module Liquid
VERSION = "5.7.0" VERSION = "5.8.1"
end end
+23
View File
@@ -77,7 +77,30 @@ class HashRenderingTest < Minitest::Test
assert_template_result("{\"numbers\"=>[{:foo=>42}]}", "{{ my_hash }}", { "my_hash" => { "numbers" => [{ foo: 42 }] } }) assert_template_result("{\"numbers\"=>[{:foo=>42}]}", "{{ my_hash }}", { "my_hash" => { "numbers" => [{ foo: 42 }] } })
end end
def test_join_filter_with_hash
array = [{ "key1" => "value1" }, { "key2" => "value2" }]
glue = { "lol" => "wut" }
assert_template_result("{\"key1\"=>\"value1\"}{\"lol\"=>\"wut\"}{\"key2\"=>\"value2\"}", "{{ my_array | join: glue }}", { "my_array" => array, "glue" => glue })
end
def test_render_hash_with_hash_key def test_render_hash_with_hash_key
assert_template_result("{{\"foo\"=>\"bar\"}=>42}", "{{ my_hash }}", { "my_hash" => { Hash["foo" => "bar"] => 42 } }) assert_template_result("{{\"foo\"=>\"bar\"}=>42}", "{{ my_hash }}", { "my_hash" => { Hash["foo" => "bar"] => 42 } })
end end
def test_rendering_hash_with_custom_to_s_method_uses_custom_to_s
my_hash = Class.new(Hash) do
def to_s
"kewl"
end
end.new
assert_template_result("kewl", "{{ my_hash }}", { "my_hash" => my_hash })
end
def test_rendering_hash_without_custom_to_s_uses_default_inspect
my_hash = Class.new(Hash).new
my_hash[:foo] = :bar
assert_template_result("{:foo=>:bar}", "{{ my_hash }}", { "my_hash" => my_hash })
end
end end
+48 -107
View File
@@ -54,30 +54,6 @@ class TestEnumerable < Liquid::Drop
end end
end end
class TestDeepEnumerable < Liquid::Drop
include Enumerable
class Product < Liquid::Drop
attr_reader :title, :price, :premium
def initialize(title:, price:, premium: nil)
@title = { "content" => title, "language" => "en" }
@price = { "value" => price, "unit" => "USD" }
@premium = { "category" => premium } if premium
end
end
def each(&block)
[
Product.new(title: "Pro goggles", price: 1299),
Product.new(title: "Thermal gloves", price: 1299),
Product.new(title: "Alpine jacket", price: 3999, premium: 'Basic'),
Product.new(title: "Mountain boots", price: 3899, premium: 'Pro'),
Product.new(title: "Safety helmet", price: 1999)
].each(&block)
end
end
class NumberLikeThing < Liquid::Drop class NumberLikeThing < Liquid::Drop
def initialize(amount) def initialize(amount)
@amount = amount @amount = amount
@@ -157,6 +133,18 @@ class StandardFiltersTest < Minitest::Test
assert_equal([], @filters.slice(input, -(1 << 63), 6)) assert_equal([], @filters.slice(input, -(1 << 63), 6))
end end
def test_find_on_empty_array
assert_nil(@filters.find([], 'foo', 'bar'))
end
def test_find_index_on_empty_array
assert_nil(@filters.find_index([], 'foo', 'bar'))
end
def test_has_on_empty_array
refute(@filters.has([], 'foo', 'bar'))
end
def test_truncate def test_truncate
assert_equal('1234...', @filters.truncate('1234567890', 7)) assert_equal('1234...', @filters.truncate('1234567890', 7))
assert_equal('1234567890', @filters.truncate('1234567890', 20)) assert_equal('1234567890', @filters.truncate('1234567890', 20))
@@ -305,6 +293,16 @@ class StandardFiltersTest < Minitest::Test
assert_equal('1121314', @filters.join([1, 2, 3, 4], 1)) assert_equal('1121314', @filters.join([1, 2, 3, 4], 1))
end end
def test_join_calls_to_liquid_on_each_element
drop = Class.new(Liquid::Drop) do
def to_liquid
'i did it'
end
end
assert_equal('i did it, i did it', @filters.join([drop.new, drop.new], ", "))
end
def test_sort def test_sort
assert_equal([1, 2, 3, 4], @filters.sort([4, 3, 2, 1])) assert_equal([1, 2, 3, 4], @filters.sort([4, 3, 2, 1]))
assert_equal([{ "a" => 1 }, { "a" => 2 }, { "a" => 3 }, { "a" => 4 }], @filters.sort([{ "a" => 4 }, { "a" => 3 }, { "a" => 1 }, { "a" => 2 }], "a")) assert_equal([{ "a" => 1 }, { "a" => 2 }, { "a" => 3 }, { "a" => 4 }], @filters.sort([{ "a" => 4 }, { "a" => 3 }, { "a" => 1 }, { "a" => 2 }], "a"))
@@ -416,15 +414,6 @@ class StandardFiltersTest < Minitest::Test
end end
end end
def test_sort_natural_with_deep_enumerables
template = <<~LIQUID
{{- products | sort_natural: 'title.content' | map: 'title.content' | join: ', ' -}}
LIQUID
expected_output = "Alpine jacket, Mountain boots, Pro goggles, Safety helmet, Thermal gloves"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
def test_legacy_sort_hash def test_legacy_sort_hash
assert_equal([{ a: 1, b: 2 }], @filters.sort(a: 1, b: 2)) assert_equal([{ a: 1, b: 2 }], @filters.sort(a: 1, b: 2))
end end
@@ -461,15 +450,6 @@ class StandardFiltersTest < Minitest::Test
end end
end end
def test_uniq_with_deep_enumerables
template = <<~LIQUID
{{- products | uniq: 'price.value' | map: "title.content" | join: ', ' -}}
LIQUID
expected_output = "Pro goggles, Alpine jacket, Mountain boots, Safety helmet"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
def test_compact_empty_array def test_compact_empty_array
assert_equal([], @filters.compact([], "a")) assert_equal([], @filters.compact([], "a"))
end end
@@ -486,15 +466,6 @@ class StandardFiltersTest < Minitest::Test
end end
end end
def test_compact_with_deep_enumerables
template = <<~LIQUID
{{- products | compact: 'premium.category' | map: 'title.content' | join: ', ' -}}
LIQUID
expected_output = "Alpine jacket, Mountain boots"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
def test_reverse def test_reverse
assert_equal([4, 3, 2, 1], @filters.reverse([1, 2, 3, 4])) assert_equal([4, 3, 2, 1], @filters.reverse([1, 2, 3, 4]))
end end
@@ -604,15 +575,6 @@ class StandardFiltersTest < Minitest::Test
assert_template_result("213", '{{ foo | sort: "bar" | map: "foo" }}', { "foo" => TestEnumerable.new }) assert_template_result("213", '{{ foo | sort: "bar" | map: "foo" }}', { "foo" => TestEnumerable.new })
end end
def test_sort_with_deep_enumerables
template = <<~LIQUID
{{- products | sort: 'price.value' | map: 'title.content' | join: ', ' -}}
LIQUID
expected_output = "Pro goggles, Thermal gloves, Safety helmet, Mountain boots, Alpine jacket"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
def test_first_and_last_call_to_liquid def test_first_and_last_call_to_liquid
assert_template_result('foobar', '{{ foo | first }}', { 'foo' => [ThingWithToLiquid.new] }) assert_template_result('foobar', '{{ foo | first }}', { 'foo' => [ThingWithToLiquid.new] })
assert_template_result('foobar', '{{ foo | last }}', { 'foo' => [ThingWithToLiquid.new] }) assert_template_result('foobar', '{{ foo | last }}', { 'foo' => [ThingWithToLiquid.new] })
@@ -929,15 +891,6 @@ class StandardFiltersTest < Minitest::Test
assert_template_result(expected_output, template, { "array" => array }) assert_template_result(expected_output, template, { "array" => array })
end end
def test_reject_with_deep_enumerables
template = <<~LIQUID
{{- products | reject: 'title.content', 'Pro goggles' | map: 'price.value' | join: ', ' -}}
LIQUID
expected_output = "1299, 3999, 3899, 1999"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
def test_has def test_has
array = [ array = [
{ "handle" => "alpha", "ok" => true }, { "handle" => "alpha", "ok" => true },
@@ -966,6 +919,18 @@ class StandardFiltersTest < Minitest::Test
assert_template_result(expected_output, "{{ array | has: 'ok', true }}", { "array" => array }) assert_template_result(expected_output, "{{ array | has: 'ok', true }}", { "array" => array })
end end
def test_has_with_empty_arrays
template = <<~LIQUID
{%- assign has_product = products | has: 'title.content', 'Not found' -%}
{%- unless has_product -%}
Product not found.
{%- endunless -%}
LIQUID
expected_output = "Product not found."
assert_template_result(expected_output, template, { "products" => [] })
end
def test_has_with_false_value def test_has_with_false_value
array = [ array = [
{ "handle" => "alpha", "ok" => true }, { "handle" => "alpha", "ok" => true },
@@ -994,16 +959,6 @@ class StandardFiltersTest < Minitest::Test
assert_template_result(expected_output, template, { "array" => array }) assert_template_result(expected_output, template, { "array" => array })
end end
def test_has_with_deep_enumerables
template = <<~LIQUID
{{- products | has: 'title.content', 'Pro goggles' -}},
{{- products | has: 'title.content', 'foo' -}}
LIQUID
expected_output = "true,false"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
def test_find_with_value def test_find_with_value
products = [ products = [
{ "title" => "Pro goggles", "price" => 1299 }, { "title" => "Pro goggles", "price" => 1299 },
@@ -1022,14 +977,16 @@ class StandardFiltersTest < Minitest::Test
assert_template_result(expected_output, template, { "products" => products }) assert_template_result(expected_output, template, { "products" => products })
end end
def test_find_with_deep_enumerables def test_find_with_empty_arrays
template = <<~LIQUID template = <<~LIQUID
{%- assign product = products | find: 'title.content', 'Pro goggles' -%} {%- assign product = products | find: 'title.content', 'Not found' -%}
{{- product.title.content -}} {%- unless product -%}
Product not found.
{%- endunless -%}
LIQUID LIQUID
expected_output = "Pro goggles" expected_output = "Product not found."
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new }) assert_template_result(expected_output, template, { "products" => [] })
end end
def test_find_index_with_value def test_find_index_with_value
@@ -1050,14 +1007,16 @@ class StandardFiltersTest < Minitest::Test
assert_template_result(expected_output, template, { "products" => products }) assert_template_result(expected_output, template, { "products" => products })
end end
def test_find_index_with_deep_enumerables def test_find_index_with_empty_arrays
template = <<~LIQUID template = <<~LIQUID
{%- assign index = products | find_index: 'title.content', 'Alpine jacket' -%} {%- assign index = products | find_index: 'title.content', 'Not found' -%}
{{- index -}} {%- unless index -%}
Index not found.
{%- endunless -%}
LIQUID LIQUID
expected_output = "2" expected_output = "Index not found."
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new }) assert_template_result(expected_output, template, { "products" => [] })
end end
def test_where def test_where
@@ -1158,15 +1117,6 @@ class StandardFiltersTest < Minitest::Test
assert_nil(@filters.where([nil], "ok")) assert_nil(@filters.where([nil], "ok"))
end end
def test_where_with_deep_enumerables
template = <<~LIQUID
{{- products | where: 'title.content', 'Pro goggles' | map: 'price.value' -}}
LIQUID
expected_output = "1299"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
def test_all_filters_never_raise_non_liquid_exception def test_all_filters_never_raise_non_liquid_exception
test_drop = TestDrop.new(value: "test") test_drop = TestDrop.new(value: "test")
test_drop.context = Context.new test_drop.context = Context.new
@@ -1318,15 +1268,6 @@ class StandardFiltersTest < Minitest::Test
assert_template_result("0", "{{ input | sum: 'subtotal' }}", { "input" => input }) assert_template_result("0", "{{ input | sum: 'subtotal' }}", { "input" => input })
end end
def test_sum_with_deep_enumerables
template = <<~LIQUID
{{- products | sum: 'price.value' -}}
LIQUID
expected_output = "12495"
assert_template_result(expected_output, template, { "products" => TestDeepEnumerable.new })
end
private private
def with_timezone(tz) def with_timezone(tz)
+7 -1
View File
@@ -47,12 +47,18 @@ class BlockUnitTest < Minitest::Test
) )
end end
def test_with_block def test_comment_tag_with_block
template = Liquid::Template.parse(" {% comment %} {% endcomment %} ") template = Liquid::Template.parse(" {% comment %} {% endcomment %} ")
assert_equal([String, Comment, String], block_types(template.root.nodelist)) assert_equal([String, Comment, String], block_types(template.root.nodelist))
assert_equal(3, template.root.nodelist.size) assert_equal(3, template.root.nodelist.size)
end end
def test_doc_tag_with_block
template = Liquid::Template.parse(" {% doc %} {% enddoc %} ")
assert_equal([String, Doc, String], block_types(template.root.nodelist))
assert_equal(3, template.root.nodelist.size)
end
private private
def block_types(nodelist) def block_types(nodelist)
+151
View File
@@ -0,0 +1,151 @@
# frozen_string_literal: true
require 'test_helper'
class BooleanUnitTest < Minitest::Test
include Liquid
def test_simple_boolean_comparison
assert_parity("1 > 0", "true")
assert_parity("1 < 0", "false")
end
def test_boolean_and_operator
assert_parity("true and true", "true")
assert_parity("true and false", "false")
end
def test_boolean_or_operator
assert_parity("true or false", "true")
assert_parity("false or false", "false")
end
def test_operator_precedence
assert_parity("false and false or true", "false")
end
def test_complex_boolean_expressions
assert_parity("true and true and true", "true")
assert_parity("true and false and true", "false")
assert_parity("false or false or true", "true")
end
def test_boolean_with_variables
assert_parity("a and b", "true", { "a" => true, "b" => true })
assert_parity("a and b", "false", { "a" => true, "b" => false })
assert_parity("a or b", "true", { "a" => false, "b" => true })
assert_parity("a or b", "false", { "a" => false, "b" => false })
end
def test_nil_equals_nil
assert_parity("nil == nil", "true")
end
def test_nil_not_equals_nil
assert_parity("nil != nil", "false")
end
def test_nil_not_equals_empty_string
assert_parity("nil == ''", "false")
assert_parity("nil != ''", "true")
end
def test_undefined_variable_in_comparisons
assert_parity("undefined_var == nil", "true")
assert_parity("undefined_var != nil", "false")
end
def test_undefined_variable_compared_to_empty_string
assert_parity("undefined_var == ''", "false")
assert_parity("undefined_var != ''", "true")
end
def test_boolean_variable_in_comparisons
assert_parity("t == true", "true", { "t" => true })
assert_parity("f == false", "true", { "f" => false })
end
def test_boolean_variable_compared_to_nil
assert_parity("t == nil", "false", { "t" => true })
assert_parity("f == nil", "false", { "f" => false })
assert_parity("f != nil", "true", { "f" => false })
end
def test_nil_and_undefined_variables_in_boolean_expressions
assert_parity("x == undefined_var", "true", { "x" => nil })
assert_parity("x != undefined_var", "false", { "x" => nil })
end
def test_nil_literal_in_or_expression
assert_parity("nil or true", "true")
end
def test_nil_variable_in_or_expression
assert_parity("x or false", "false", { "x" => nil })
end
def test_mixed_boolean_expressions
assert_parity("a > b and c < d", "true", { "a" => 99, "b" => 0, "c" => 0, "d" => 99 })
assert_parity("a > b and c < d", "false", { "a" => 99, "b" => 0, "c" => 99, "d" => 0 })
end
def test_boolean_assignment_shorthand
template = Liquid::Template.parse("{% assign lazy_load = media_position > 1 %}{{ lazy_load }}")
assert_equal("false", template.render("media_position" => 1))
assert_equal("true", template.render("media_position" => 2))
end
def test_equality_operators
assert_parity_todo!("1 == 1", "true")
assert_parity_todo!("1 != 2", "true")
assert_parity_todo!("'hello' == 'hello'", "true")
end
def test_nil_renders_as_empty_string
assert_parity_todo!("nil", "false")
end
def test_nil_comparison_with_blank
assert_parity_todo!("nil_value == blank", "false")
assert_parity_todo!("nil_value != blank", "true")
assert_parity_todo!("undefined != blank", "true")
assert_parity_todo!("undefined == blank", "false")
end
def test_if_with_variables
assert_parity_todo!("value", "true", { "value" => true })
assert_parity_todo!("value", "false", { "value" => false })
assert_parity_todo!("value", "false", { "value" => nil })
assert_parity_todo!("value", "true", { "value" => "text" })
assert_parity_todo!("value", "true", { "value" => "" })
end
def test_nil_variable_in_and_expression
assert_parity_todo!("x and true", "false", { "x" => nil })
end
private
def assert_parity_todo!(liquid_expression, expected_result, args = {})
assert_parity_scenario(:condition, "{% if #{liquid_expression} %}true{% else %}false{% endif %}", expected_result, args)
test_name = caller_locations(1, 1)[0].label
puts "\e[33mTODO: parity for '#{test_name}'\e[0m"
end
def assert_parity(liquid_expression, expected_result, args = {})
assert_parity_scenario(:condition, "{% if #{liquid_expression} %}true{% else %}false{% endif %}", expected_result, args)
assert_parity_scenario(:expression, "{{ #{liquid_expression} }}", expected_result, args)
end
def assert_parity_scenario(kind, template, exp_output, args = {})
act_output = Liquid::Template.parse(template).render(args)
assert_equal(exp_output, act_output, <<~ERROR_MESSAGE)
#{kind.to_s.capitalize} template failure:
---
#{template}
---
args: #{args.inspect}
ERROR_MESSAGE
end
end
+82
View File
@@ -131,6 +131,88 @@ class LexerUnitTest < Minitest::Test
assert_equal([[:id, "false"], [:number, "1"], [:end_of_string]], tokenize("false 1")) assert_equal([[:id, "false"], [:number, "1"], [:end_of_string]], tokenize("false 1"))
end end
def test_error_with_invalid_utf8
error = assert_raises(SyntaxError) do
tokenize("\x00\xff")
end
assert_equal(
'Liquid syntax error: Invalid byte sequence in UTF-8',
error.message,
)
end
def test_boolean_and_operator
exp = [
[:id, "true"],
[:boolean_operator, "and"],
[:id, "false"],
[:end_of_string],
]
act = tokenize("true and false")
assert_equal(exp, act)
end
def test_boolean_or_operator
exp = [
[:id, "false"],
[:boolean_operator, "or"],
[:id, "true"],
[:end_of_string],
]
act = tokenize("false or true")
assert_equal(exp, act)
end
def test_boolean_operators_in_complex_expressions
exp = [
[:id, "a"],
[:boolean_operator, "and"],
[:id, "b"],
[:boolean_operator, "or"],
[:id, "c"],
[:end_of_string],
]
act = tokenize("a and b or c")
assert_equal(exp, act)
end
def test_boolean_operators_with_comparisons
exp = [
[:id, "a"],
[:comparison, ">"],
[:number, "5"],
[:boolean_operator, "and"],
[:id, "b"],
[:comparison, "<"],
[:number, "10"],
[:end_of_string],
]
act = tokenize("a > 5 and b < 10")
assert_equal(exp, act)
end
def test_boolean_operators_as_property_names
exp = [
[:id, "obj"],
[:dot, "."],
[:id, "and"],
[:dot, "."],
[:id, "property"],
[:end_of_string],
]
act = tokenize("obj.and.property")
assert_equal(exp, act)
exp = [
[:id, "obj"],
[:dot, "."],
[:id, "or"],
[:end_of_string],
]
act = tokenize("obj.or")
assert_equal(exp, act)
end
private private
def tokenize(input) def tokenize(input)
+184
View File
@@ -0,0 +1,184 @@
# frozen_string_literal: true
require 'test_helper'
class DocTagUnitTest < Minitest::Test
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_does_not_support_extra_arguments
error = assert_raises(Liquid::SyntaxError) do
template = <<~LIQUID.chomp
{% doc extra %}
{% enddoc %}
LIQUID
Liquid::Template.parse(template)
end
exp_error = "Liquid syntax error: Syntax Error in 'doc' - Valid syntax: {% doc %}{% enddoc %}"
act_error = error.message
assert_equal(exp_error, act_error)
end
def test_doc_tag_must_support_valid_tags
assert_match_syntax_error("Liquid syntax error (line 1): 'doc' tag was never closed", '{% doc %} foo')
assert_match_syntax_error("Liquid syntax error (line 1): Syntax Error in 'doc' - Valid syntax: {% doc %}{% enddoc %}", '{% doc } foo {% enddoc %}')
assert_match_syntax_error("Liquid syntax error (line 1): Syntax Error in 'doc' - Valid syntax: {% doc %}{% enddoc %}", '{% doc } foo %}{% enddoc %}')
end
def test_doc_tag_ignores_liquid_nodes
template = <<~LIQUID.chomp
{% doc %}
{% if true %}
{% if ... %}
{%- for ? -%}
{% while true %}
{%
unless if
%}
{% endcase %}
{% enddoc %}
LIQUID
assert_template_result('', template)
end
def test_doc_tag_ignores_unclosed_liquid_tags
template = <<~LIQUID.chomp
{% doc %}
{% if true %}
{% enddoc %}
LIQUID
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_ignores_unclosed_assign
template = <<~LIQUID.chomp
{% doc %}
{% assign foo = "1"
{% enddoc %}
LIQUID
assert_template_result('', template)
end
def test_doc_tag_ignores_malformed_syntax
template = <<~LIQUID.chomp
{% doc %}
{% {{ {%- enddoc %}
LIQUID
assert_template_result('', template)
end
def test_doc_tag_preserves_error_line_numbers
template = Liquid::Template.parse(<<~LIQUID.chomp, line_numbers: true)
{% doc %}
{% if true %}
{% enddoc %}
{{ errors.standard_error }}
LIQUID
expected = <<~TEXT.chomp
Liquid error (line 4): standard error
TEXT
assert_equal(expected, template.render('errors' => ErrorDrop.new))
end
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_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 %}")
end
def test_doc_tag_visitor
template_source = '{% doc %}{% enddoc %}'
assert_equal(
[Liquid::Doc],
visit(template_source),
)
end
private
def traversal(template)
ParseTreeVisitor
.for(Template.parse(template).root)
.add_callback_for(Liquid::Doc) do |tag|
tag_class = tag.class
tag_class
end
end
def visit(template)
traversal(template).visit.flatten.compact
end
end
+11
View File
@@ -35,4 +35,15 @@ class TemplateUnitTest < Minitest::Test
def test_template_inheritance def test_template_inheritance
assert_equal("foo", TemplateSubclass.parse("foo").render) assert_equal("foo", TemplateSubclass.parse("foo").render)
end end
def test_invalid_utf8
input = "\xff\x00"
error = assert_raises(SyntaxError) do
Liquid::Tokenizer.new(source: input, string_scanner: StringScanner.new(input))
end
assert_equal(
'Liquid syntax error: Invalid byte sequence in UTF-8',
error.message,
)
end
end end