Compare commits

...
Author SHA1 Message Date
Albert Chu 591d3a2c70 [WIP] Support for nested boolean expressions in parentheses
- Added unit tests for range syntax
- Added logical expression unit tests
- parser respects parentheses during expression traversal
2025-03-17 18:26:52 -06:00
Albert Chu f1b178d25e Boolean precedence unit tests 2025-03-17 14:08:44 -06:00
Albert Chu 1ae2ff103e Added more non-parity unit tests 2025-03-13 16:41:17 -06:00
Albert Chu 6148604320 Added another failing unit test for behavior in main 2025-03-13 13:26:03 -06:00
Albert Chu e6e8221c78 Fixed lax parsing test case 2025-03-13 10:53:24 -06:00
Albert Chu 484f016e1b Added failing unit test that passes in main 2025-03-12 19:23:18 -06:00
Albert Chu 4b57b2bbd9 Reintroduced broken conditional operators behaviour present in liquid main 2025-03-12 14:08:45 -06:00
Albert Chu 430794dd5a Added test for operator reading bug 2025-03-11 17:00:57 -06:00
Albert Chu 08d36b09a2 Fixed ComparisonExpression.parse with MethodLiterals 2025-03-10 21:20:44 -06:00
Albert Chu b5c3d3fe82 Introduced debugging gems 2025-03-10 21:20:44 -06:00
Guilherme CarreiroandAlbert Chu 51a05c2781 Blank parity 2025-03-10 21:20:44 -06:00
Guilherme CarreiroandAlbert Chu 263a73bd81 Remove 'assert_parity_todo!' 2025-03-10 21:20:44 -06:00
Guilherme CarreiroandAlbert Chu 9e6b628a68 * Introduce support for literal comparisons (e.g., {{ 'hello' == 'hello' }})
* Evaluate expressions as truthy/falsy to unlock scenarios, such as `<div class="{{ disabled and "modal--disabled" }}">`
* Add additional scenarios to the expression test suite
* Simplify `LogicalExpression`
2025-03-10 21:20:44 -06:00
Albert Chu b31f24bdf0 More boolean unit tests and enabled more existing parity cases 2025-03-10 21:20:44 -06:00
Albert Chu b57f4fcbcb Support usecase where a nil variable value is used in a logical expression 2025-03-10 21:20:43 -06:00
Guilherme CarreiroandAlbert Chu 26ccec12ab * 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-10 21:20:43 -06:00
Guilherme CarreiroandAlbert Chu ba0bbe3c3f Update the parser to use the new tokens 2025-03-10 21:20:43 -06:00
Guilherme CarreiroandAlbert Chu 9b967690aa Introduce support to boolean operators in the lexer 2025-03-10 21:20:43 -06:00
Albert Chu 03feea967b Added a lot more boolean unit tests 2025-03-10 21:20:43 -06:00
Albert Chu 14b0d64b70 Rough support for parenthesis. Also better respect for and/or order precedence. 2025-03-10 21:20:43 -06:00
Albert Chu 6d4cffa000 Support for simple boolean comparisons and boolean assignments 2025-03-10 21:20:42 -06:00
Albert Chu f32c0fb4fb 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-10 21:20:42 -06:00
Albert Chu b036feb20a Removed infix operators from this PR 2025-03-10 21:20:42 -06:00
Albert Chu 5782a9e1d7 TDD: Unit tests for new liquid syntax 2025-03-10 21:20:42 -06:00
14 changed files with 1299 additions and 12 deletions
+2
View File
@@ -25,6 +25,8 @@ group :development do
end
group :test do
gem 'ruby-lsp'
gem 'debug'
gem 'rubocop', '~> 1.61.0'
gem 'rubocop-shopify', '~> 2.12.0', require: false
gem 'rubocop-performance', require: false
+2
View File
@@ -80,6 +80,8 @@ require 'liquid/variable_lookup'
require 'liquid/range_lookup'
require 'liquid/resource_limits'
require 'liquid/expression'
require 'liquid/expression/comparison_expression'
require 'liquid/expression/logical_expression'
require 'liquid/template'
require 'liquid/condition'
require 'liquid/utils'
+10 -2
View File
@@ -52,6 +52,10 @@ module Liquid
@@method_literals[markup] || parse_context.parse_expression(markup)
end
def self.parse(markup, ss, cache)
@@method_literals[markup] || Expression.parse(markup, ss, cache)
end
attr_reader :attachment, :child_condition
attr_accessor :left, :operator, :right
@@ -112,11 +116,15 @@ module Liquid
private
def equal_variables(left, right)
if left.is_a?(MethodLiteral) && right.is_a?(MethodLiteral)
return left.to_s == right.to_s
end
if left.is_a?(MethodLiteral)
if right.respond_to?(left.method_name)
return right.send(left.method_name)
else
return nil
return left.to_s == right
end
end
@@ -124,7 +132,7 @@ module Liquid
if left.respond_to?(right.method_name)
return left.send(right.method_name)
else
return nil
return right.to_s == left
end
end
+7 -6
View File
@@ -26,6 +26,7 @@ module Liquid
RANGES_REGEX = /\A\(\s*(?>(\S+)\s*\.\.)\s*(\S+)\s*\)\z/
INTEGER_REGEX = /\A(-?\d+)\z/
FLOAT_REGEX = /\A(-?\d+)\.\d+\z/
QUOTED_STRING = /\A#{QuotedString}\z/
class << self
def parse(markup, ss = StringScanner.new(""), cache = nil)
@@ -33,12 +34,9 @@ module Liquid
markup = markup.strip # markup can be a frozen string
if (markup.start_with?('"') && markup.end_with?('"')) ||
(markup.start_with?("'") && markup.end_with?("'"))
return markup[1..-2]
elsif LITERALS.key?(markup)
return LITERALS[markup]
end
return markup[1..-2] if QUOTED_STRING.match?(markup)
return LITERALS[markup] if LITERALS.key?(markup)
# Cache only exists during parsing
if cache
@@ -51,6 +49,9 @@ module Liquid
end
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
return RangeLookup.parse(
Regexp.last_match(1),
@@ -0,0 +1,31 @@
# frozen_string_literal: true
module Liquid
class Expression
class ComparisonExpression
# We can improve the resiliency of lax parsing by not expecting whitespace
# surrounding the operator (ie \s+ => \s*).
# However this is not in parity with existing lax parsing behavior.
COMPARISON_REGEX = /\A\s*(.+?)\s+(==|!=|<>|<=|>=|<|>|contains)\s+(.+)\s*\z/
class << self
def comparison?(markup)
markup.match(COMPARISON_REGEX)
end
def parse(markup, ss, cache)
match = comparison?(markup)
if match
left = Condition.parse(match[1].strip, ss, cache)
operator = match[2].strip
right = Condition.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,59 @@
# 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.match(LOGICAL_REGEX)
end
def boolean_operator?(markup)
BOOLEAN_OPERATORS.include?(markup)
end
def parse(markup, ss, cache)
expressions = markup.scan(EXPRESSIONS_AND_OPERATORS)
expression = expressions.pop
condition = parse_condition(expression, ss, cache)
until expressions.empty?
operator = expressions.pop.to_s.strip
next unless boolean_operator?(operator)
expression = expressions.pop.to_s.strip
new_condition = parse_condition(expression, ss, cache)
case operator
when 'and' then new_condition.and(condition)
when 'or' then new_condition.or(condition)
end
condition = new_condition
end
condition
end
private
def parse_condition(expr, ss, cache)
return ComparisonExpression.parse(expr, ss, cache) if comparison?(expr)
return LogicalExpression.parse(expr, ss, cache) if logical?(expr)
Condition.new(Expression.parse(expr, ss, cache), nil, nil)
end
def comparison?(...)
ComparisonExpression.comparison?(...)
end
end
end
end
end
+6
View File
@@ -14,6 +14,8 @@ module Liquid
COMPARISON_LESS_THAN = [:comparison, "<"].freeze
COMPARISON_LESS_THAN_OR_EQUAL = [:comparison, "<="].freeze
COMPARISON_NOT_EQUAL_ALT = [:comparison, "<>"].freeze
BOOLEAN_AND = [:boolean_operator, "and"].freeze
BOOLEAN_OR = [:boolean_operator, "or"].freeze
DASH = [:dash, "-"].freeze
DOT = [:dot, "."].freeze
DOTDOT = [:dotdot, ".."].freeze
@@ -151,6 +153,10 @@ module Liquid
# Special case for "contains"
output << if type == :id && t == "contains" && output.last&.first != :dot
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
[type, t]
end
+33 -4
View File
@@ -48,7 +48,7 @@ module Liquid
def expression
token = @tokens[@p]
case token[0]
expr = case token[0]
when :id
str = consume
str << variable_lookups
@@ -60,12 +60,41 @@ module Liquid
when :string, :number
consume
when :open_round
consume
first = expression
consume(:dotdot)
consume_round_parentheses(token)
else
raise SyntaxError, "#{token} is not a valid expression"
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
if look(:close_round)
"(#{left} #{operator} #{right})"
else
"#{left} #{operator} #{right}"
end
else
expr
end
end
def consume_round_parentheses(token)
consume
first = expression
dotdot_token = consume?(:dotdot)
if dotdot_token
last = expression
consume(:close_round)
"(#{first}..#{last})"
elsif look(:close_round)
consume(:close_round)
first
else
raise SyntaxError, "#{token} is not a valid expression"
end
+61
View File
@@ -0,0 +1,61 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
module Minitest
module Assertions
include Liquid
def assert_with_lax_parsing(template, expected_output, context = {})
prev_error_mode = Liquid::Environment.default.error_mode
Liquid::Environment.default.error_mode = :lax
begin
actual_output = Liquid::Template.parse(template).render(context)
rescue StandardError => e
actual_output = e.message
ensure
Liquid::Environment.default.error_mode = prev_error_mode
end
assert_equal(expected_output.strip, actual_output.strip)
end
def assert_parity(liquid_expression, expected_result, args = {})
assert_condition(liquid_expression, expected_result, args)
assert_expression(liquid_expression, expected_result, args)
end
def assert_expression(liquid_expression, expected_result, args = {})
assert_parity_scenario(:expression, "{{ #{liquid_expression} }}", expected_result, args)
end
def assert_condition(liquid_condition, expected_result, args = {})
assert_parity_scenario(:condition, "{% if #{liquid_condition} %}true{% else %}false{% endif %}", 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
end
class LinkDrop < Liquid::Drop
attr_accessor :levels, :links, :title, :type, :url
def initialize(levels: nil, links: nil, title: nil, type: nil, url: nil)
super()
@levels = levels
@links = links
@title = title
@type = type
@url = url
end
end
+171
View File
@@ -0,0 +1,171 @@
# frozen_string_literal: true
require 'test_helper'
require 'test_boolean_helper'
class BooleanPrecedenceUnitTest < Minitest::Test
include Liquid
def test_basic_boolean_parenthesized_expressions
assert_parity("false and (false or true)", "false")
assert_parity("true and (false or true)", "true")
assert_parity("(true and false) or true", "true")
assert_parity("(false and true) or false", "false")
end
def test_nested_boolean_parentheses
assert_parity("(false and (true or false)) or true", "true")
assert_parity("true and (false or (true and true))", "true")
assert_parity("(true and (false or false)) or false", "false")
end
def test_multiple_operations_with_consistent_operators
assert_parity("(true and true) and (false or true)", "true")
assert_parity("(false or false) or (true and false)", "false")
end
def test_parentheses_changing_default_precedence
# Default precedence: (true and false) or true
assert_parity("true and false or true", "true")
# With parentheses: true and (false or true)
assert_parity("true and (false or true)", "true")
# Default precedence: false or (true and true)
assert_parity("false or true and true", "true")
# With parentheses: (false or true) and true
assert_parity("(false or true) and true", "true")
end
def test_boolean_parentheses_with_variables
assert_parity("(a or b) and c", "true", { "a" => true, "b" => false, "c" => true })
assert_parity("(a or b) and c", "false", { "a" => true, "b" => false, "c" => false })
assert_parity("a and (b or c)", "true", { "a" => true, "b" => false, "c" => true })
assert_parity("a and (b or c)", "false", { "a" => false, "b" => true, "c" => true })
end
def test_comparison_operators_inside_parentheses
assert_parity("(1 > 0) and (2 < 3)", "true")
assert_parity("(1 < 0) or (2 > 3)", "false")
assert_parity("true and (1 == 1)", "true")
assert_parity("false or (2 != 2)", "false")
end
def test_complex_nested_boolean_expressions
assert_parity("((true and false) or (false and true)) or ((false or true) and (true or false))", "true")
assert_parity("((true and true) or (false and false)) and ((true or false) and (false or true))", "true")
end
def test_not_operator_with_parentheses
# Testing how 'not' interacts with parentheses
assert_parity("not (true or false)", "false")
assert_parity("not (false and true)", "true")
assert_parity("(not false) and true", "true")
assert_parity("(not true) or false", "false")
assert_parity("not (not true)", "true")
end
def test_nil_values_with_boolean_precedence
# How nil values interact with boolean expressions and parentheses
assert_parity("nil and (true or false)", "false")
assert_parity("(nil or true) and false", "false")
assert_parity("(nil and nil) or true", "true")
assert_parity("true and (nil or false)", "false")
end
def test_mixed_primitive_types_with_parentheses
# Testing how different types interact in boolean expressions with parentheses
assert_parity("('' or 0) and true", "true")
assert_parity("(true and 'string') or false", "true")
assert_parity("(false or '') and 1", "false")
assert_parity("(nil or false) and 'text'", "false")
end
def test_triple_operator_precedence
# Testing three different operators with different parenthesizing
assert_parity("true or false and true or false", "true") # default precedence
assert_parity("true or (false and true) or false", "true")
assert_parity("(true or false) and (true or false)", "true")
assert_parity("((true or false) and true) or false", "true")
assert_parity("true or (false and (true or false))", "true")
end
def test_undefined_variables_with_parentheses
# How undefined variables behave with parentheses
assert_parity("(undefined_var or true) and false", "false")
assert_parity("true and (undefined_var or false)", "false")
assert_parity("(undefined_var and true) or true", "true")
assert_parity("false or (undefined_var and false)", "false")
end
def test_comparison_chaining_with_parentheses
# Testing how comparison chains work with parentheses
assert_parity("(1 < 2) and (2 < 3) and (3 < 4)", "true")
assert_parity("(1 < 2) and ((2 > 3) or (3 < 4))", "true")
assert_parity(
"(a > b) or ((c < d) and (e == f))",
"true",
{ "a" => 5, "b" => 3, "c" => 1, "d" => 2, "e" => 7, "f" => 7 },
)
assert_parity(
"(a > b) or ((c < d) and (e == f))",
"false",
{ "a" => 3, "b" => 5, "c" => 2, "d" => 1, "e" => 7, "f" => 8 },
)
end
def test_deeply_nested_expressions
# Testing very deep nesting to ensure parser handles it correctly
assert_parity("(((true and true) or (false and false)) and ((true or false) and (true)))", "true")
assert_parity(
"(((a or b) and c) or (d and (e or f)))",
"true",
{ "a" => false, "b" => true, "c" => true, "d" => true, "e" => true, "f" => false },
)
end
def test_malformed_parentheses
# Unbalanced parentheses - missing closing parenthesis
template = "{% if (true and false %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Unbalanced parentheses - missing opening parenthesis
template = "{% if true and false) %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Empty parentheses
template = "{% if () %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Consecutive opening parentheses without operators
template = "{% if ((true) %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Consecutive closing parentheses without proper opening
template = "{% if (true)) %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Parentheses with missing operand
template = "{% if (and true) %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Operator followed immediately by closing parenthesis
template = "{% if (true and) %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Nested malformed parentheses
template = "{% if (true and (false or true) %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Double parentheses with no content between them
template = "{% if true and (()) %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Misplaced parentheses around operators
template = "{% if true (and) false %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
# Parentheses at wrong position in expression
template = "{% if true) and (false %}true{% else %}false{% endif %}"
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse(template) }
end
end
+491
View File
@@ -0,0 +1,491 @@
# frozen_string_literal: true
require 'test_helper'
require 'test_boolean_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_with_integer_literals
assert_expression("1", "1")
assert_expression("1 == 1", "true")
assert_expression("1 != 1", "false")
assert_expression("1 == 2", "false")
assert_expression("1 != 2", "true")
end
def test_equality_operators_with_stirng_literals
assert_expression("'hello'", "hello")
assert_expression("'hello' == 'hello'", "true")
assert_expression("'hello' != 'hello'", "false")
assert_expression("'hello' == 'world'", "false")
assert_expression("'hello' != 'world'", "true")
end
def test_equality_operators_with_float_literals
assert_expression("1.5", "1.5")
assert_expression("1.5 == 1.5", "true")
assert_expression("1.5 != 1.5", "false")
assert_expression("1.5 == 2.5", "false")
assert_expression("1.5 != 2.5", "true")
end
def test_equality_operators_with_nil_literals
assert_expression("nil", "")
assert_expression("nil == nil", "true")
assert_expression("nil != nil", "false")
assert_expression("null == nil", "true")
assert_expression("null != nil", "false")
end
def test_equality_operators_with_boolean_literals
assert_expression("true", "true")
assert_expression("false", "false")
assert_expression("true == true", "true")
assert_expression("true != true", "false")
assert_expression("false == false", "true")
assert_expression("false != false", "false")
assert_expression("true == false", "false")
assert_expression("true != false", "true")
end
def test_equality_operators_with_empty_literals
assert_expression("empty", "")
assert_expression("empty == ''", "true")
assert_expression("empty == empty", "true")
assert_expression("empty != empty", "false")
assert_expression("blank == blank", "true")
assert_expression("blank != blank", "false")
assert_expression("empty == blank", "true")
assert_expression("empty != blank", "false")
end
def test_nil_renders_as_empty_string
# No parity needed here. This is to ensure expressions rendered with {{ }}
# will still render as an empty string to preserve pre-existing behavior.
assert_expression("nil", "")
assert_expression("x", "", { "x" => nil })
assert_parity_scenario(:expression, "hello {{ x }}", "hello ", { "x" => nil })
end
def test_nil_comparison_with_blank
assert_parity("nil_value == blank", "false")
assert_parity("nil_value != blank", "true")
assert_parity("undefined != blank", "true")
assert_parity("undefined == blank", "false")
end
def test_if_with_variables
assert_parity("value", "true", { "value" => true })
assert_parity("value", "false", { "value" => false })
end
def test_nil_variable_in_and_expression
assert_condition("x and true", "false", { "x" => nil })
assert_condition("true and x", "false", { "x" => nil })
assert_expression("x and true", "", { "x" => nil })
assert_expression("true and x", "", { "x" => nil })
end
def test_boolean_variable_in_and_expression
assert_parity("true and x", "false", { "x" => false })
assert_parity("x and true", "false", { "x" => false })
assert_parity("true and x", "true", { "x" => true })
assert_parity("x and true", "true", { "x" => true })
assert_parity("true or x", "true", { "x" => false })
assert_parity("x or true", "true", { "x" => false })
assert_parity("true or x", "true", { "x" => true })
assert_parity("x or true", "true", { "x" => true })
end
def test_multi_variable_boolean_nil_and_expression
assert_condition("x and y", "false", { "x" => nil, "y" => true })
assert_condition("y and x", "false", { "x" => true, "y" => nil })
assert_expression("x and y", "", { "x" => nil, "y" => true })
assert_expression("y and x", "", { "x" => true, "y" => nil })
end
def test_multi_truthy_variables_and_expressions
assert_condition("x or y", "true", { "x" => nil, "y" => "hello" })
assert_condition("y or x", "true", { "x" => "hello", "y" => nil })
assert_expression("x or y", "hello", { "x" => nil, "y" => "hello" })
assert_expression("y or x", "hello", { "x" => "hello", "y" => nil })
end
def test_multi_variable_boolean_nil_or_expression
assert_parity("x or y", "true", { "x" => nil, "y" => true })
assert_parity("y or x", "true", { "x" => true, "y" => nil })
end
def test_links_not_blank_with_drop_returns_true_for_all_cases
link = LinkDrop.new(
levels: 0,
links: [
LinkDrop.new(levels: 1, links: [], title: "About", type: "page_link", url: "/pages/about"),
LinkDrop.new(levels: 1, links: [], title: "Contact", type: "page_link", url: "/pages/contact"),
],
title: "Main Menu",
type: "menu",
url: nil,
)
template = <<~LIQUID
{%- if link.links != blank -%}
true
{%- else -%}
false
{%- endif -%}
LIQUID
act_output = Liquid::Template.parse(template).render({ "link" => link })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => link.tap { |l| l.links = [] } })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => link.tap { |l| l.links = nil } })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => LinkDrop.new })
assert_equal("true", act_output)
end
def test_links_truthy_with_drop_returns_false_for_nil_and_empty_drop
link = LinkDrop.new(
levels: 0,
links: [
LinkDrop.new(levels: 1, links: [], title: "About", type: "page_link", url: "/pages/about"),
LinkDrop.new(levels: 1, links: [], title: "Contact", type: "page_link", url: "/pages/contact"),
],
title: "Main Menu",
type: "menu",
url: nil,
)
template = <<~LIQUID
{%- if link.links -%}
true
{%- else -%}
false
{%- endif -%}
LIQUID
act_output = Liquid::Template.parse(template).render({ "link" => link })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => link.tap { |l| l.links = [] } })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => link.tap { |l| l.links = nil } })
assert_equal("false", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => {} })
assert_equal("false", act_output)
end
def test_links_not_blank_with_hash_returns_true_for_all_cases
link = {
"levels" => 0,
"links" => [
{
"levels" => 1,
"links" => [],
"title" => { "text" => "About" },
"type" => "page_link",
"url" => "/pages/about",
},
{
"levels" => 1,
"links" => [],
"title" => { "text" => "Contact" },
"type" => "page_link",
"url" => "/pages/contact",
},
],
"title" => { "text" => "Main Menu" },
"type" => "menu",
"url" => nil,
}
template = <<~LIQUID
{%- if link.links != blank -%}
true
{%- else -%}
false
{%- endif -%}
LIQUID
act_output = Liquid::Template.parse(template).render({ "link" => link })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => { **link, "links" => [] } })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => { **link, "links" => nil } })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => {} })
assert_equal("true", act_output)
end
def test_links_truthy_with_hash_returns_false_for_nil_and_empty_hash
link = {
"levels" => 0,
"links" => [
{
"levels" => 1,
"links" => [],
"title" => { "text" => "About" },
"type" => "page_link",
"url" => "/pages/about",
},
{
"levels" => 1,
"links" => [],
"title" => { "text" => "Contact" },
"type" => "page_link",
"url" => "/pages/contact",
},
],
"title" => { "text" => "Main Menu" },
"type" => "menu",
"url" => nil,
}
template = <<~LIQUID
{%- if link.links -%}
true
{%- else -%}
false
{%- endif -%}
LIQUID
act_output = Liquid::Template.parse(template).render({ "link" => link })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => { **link, "links" => [] } })
assert_equal("true", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => { **link, "links" => nil } })
assert_equal("false", act_output)
act_output = Liquid::Template.parse(template).render({ "link" => {} })
assert_equal("false", act_output)
end
def test_conditions_with_boolean_operators_without_whitespace_around_operator
template = <<~LIQUID
<option variant_id="{{ variant.id }}" {% if current_variant.id==variant.id %}selected{%- endif -%}>{{ variant.title }}</option>
LIQUID
context = {
"variant" => {
"id" => 420,
"title" => "Default Title",
},
"current_variant" => {
"id" => 420,
},
}
# Expected output
# Note: Ideally we would like the whitespace around the boolean operator to be optional.
# So the more correct expected output would be:
#
# <option variant_id="420" selected>Default Title</option>
#
# However, the existing behaviour in liquid-ruby is that the whitespace is required around the boolean operator.
expected_lax_output = <<~HTML
<option variant_id="420" >Default Title</option>
HTML
expected_strict_output = <<~HTML
<option variant_id="420" selected>Default Title</option>
HTML
# This bugged output only happens in lax mode.
assert_with_lax_parsing(template, expected_lax_output, context)
# Default test parsing mode (strict) works as properly expected
assert_equal(expected_strict_output.delete("\n"), actual_strict_output.delete("\n"))
end
# TESTING INCORRECT BEHAVIOUR OF LIQUID-RUBY
# If liquid-vm fails this test, we should change it.
def test_boolean_conditional_with_json_filter
# Define the Liquid template to test
template = <<~LIQUID
{{ template.name == 'index' | json }}
LIQUID
# Define the context for the template where the template name is 'index'
context = {
"template" => {
"name" => "product",
},
}
# Expected output
# Note: I dont know what is the correct output here but this is the liquid-ruby 'main' output.
#
# It feels incorrect but I dont know whats better
expected_output = "product"
# Render the template with the context
actual_parsed_template = Liquid::Template.parse(template)
actual_output = actual_parsed_template.render(context)
# Assert that the actual output matches the expected output
assert_equal(expected_output, actual_output.strip)
end
# TESTING INCORRECT BEHAVIOUR OF LIQUID-RUBY
# If liquid-vm fails this test, we should change it.
def test_chained_conditional_with_object_contains
# Define the Liquid template to test
template = <<~LIQUID
{{ settings.prefilter_status and template contains 'collection' }}
LIQUID
# Test with context containing 'collection'
context_with_collection = {
"template" => {
"name" => "collection",
},
"settings" => {
"prefilter_status" => true,
},
}
# NOTE: This is a bug that liquid-ruby `main` output returns the first value.
assert_with_lax_parsing(template, "true", context_with_collection)
# Test with context not containing 'collection'
context_without_collection = {
"template" => {
"name" => "not-collection",
},
"settings" => {
"prefilter_status" => true,
},
}
# NOTE: This is a bug that liquid-ruby `main` output returns the first value.
assert_with_lax_parsing(template, "true", context_without_collection)
end
# TESTING INCORRECT BEHAVIOUR OF LIQUID-RUBY
# If liquid-vm fails this test, we should change it.
def test_assign_boolean_expression_to_variable
template = <<~LIQUID
{%- liquid
assign is_preview_mode = content_for_header contains "foo" or content_for_header contains "bar"
echo is_preview_mode
-%}
LIQUID
context = { "content_for_header" => "Some content" }
# Expected output
# This value should be "false" but it is the value of the variable from the failed expression.
assert_template_result("Some content", template, context)
# This following validation should only be supported with our changes. It is the short-hand for the above template.
# The validation for it is the expected correct output.
template = Liquid::Template.parse("{% assign is_preview_mode = content_for_header contains 'foo' or content_for_header contains 'bar' %}{{ is_preview_mode }}")
assert_equal("false", template.render(context))
end
end
@@ -0,0 +1,219 @@
# frozen_string_literal: true
require 'test_helper'
require 'test_boolean_helper'
class LogicalExpressionTest < Minitest::Test
include Liquid
def setup
@ss = StringScanner.new("")
@cache = {}
end
def test_logical_detection
assert(Expression::LogicalExpression.logical?("foo and bar"))
assert(Expression::LogicalExpression.logical?("foo or bar"))
assert(Expression::LogicalExpression.logical?("true and false"))
assert(Expression::LogicalExpression.logical?("1 or 0"))
refute(Expression::LogicalExpression.logical?("foo"))
refute(Expression::LogicalExpression.logical?("1 == 1"))
refute(Expression::LogicalExpression.logical?("a contains b"))
refute(Expression::LogicalExpression.logical?("not foo"))
end
def test_parenthesized_logical_detection
assert(Expression::LogicalExpression.logical?("a and (b or c)"))
assert(Expression::LogicalExpression.logical?("(a or b) and c"))
end
def test_boolean_operator_detection
assert(Expression::LogicalExpression.boolean_operator?("and"))
assert(Expression::LogicalExpression.boolean_operator?("or"))
refute(Expression::LogicalExpression.boolean_operator?("not"))
refute(Expression::LogicalExpression.boolean_operator?("=="))
refute(Expression::LogicalExpression.boolean_operator?("contains"))
refute(Expression::LogicalExpression.boolean_operator?("foo"))
end
def test_basic_parsing
result = Expression::LogicalExpression.parse("true and false", @ss, @cache)
assert_instance_of(Condition, result)
result = Expression::LogicalExpression.parse("a or b", @ss, @cache)
assert_instance_of(Condition, result)
end
def test_parsing_with_different_expressions
# Test with simple variable expressions
result = Expression::LogicalExpression.parse("var1 and var2", @ss, @cache)
assert_instance_of(Condition, result)
# Test with comparison expressions
result = Expression::LogicalExpression.parse("a == 1 and b != 2", @ss, @cache)
assert_instance_of(Condition, result)
end
def test_parsing_complex_expressions
# Test with nested logical expressions
result = Expression::LogicalExpression.parse("a and b or c", @ss, @cache)
assert_instance_of(Condition, result)
result = Expression::LogicalExpression.parse("a or b and c", @ss, @cache)
assert_instance_of(Condition, result)
end
def test_parsing_parenthesized_expressions
result = Expression::LogicalExpression.parse("(a and b) or c", @ss, @cache)
assert_instance_of(Condition, result)
result = Expression::LogicalExpression.parse("a and (b or c)", @ss, @cache)
assert_instance_of(Condition, result)
# Test with complex expressions
result = Expression::LogicalExpression.parse("(a or b) and (c or d)", @ss, @cache)
assert_instance_of(Condition, result)
end
def test_evaluation_of_parsed_expressions
context = Liquid::Context.new(
"a" => true,
"b" => false,
"c" => true,
"d" => false,
)
# Test simple logical expressions
expr = Expression::LogicalExpression.parse("a and c", @ss, @cache)
assert_equal(true, expr.evaluate(context))
expr = Expression::LogicalExpression.parse("a and b", @ss, @cache)
assert_equal(false, expr.evaluate(context))
expr = Expression::LogicalExpression.parse("b or c", @ss, @cache)
assert_equal(true, expr.evaluate(context))
expr = Expression::LogicalExpression.parse("b or d", @ss, @cache)
assert_equal(false, expr.evaluate(context))
end
def test_evaluation_of_complex_expressions
context = Liquid::Context.new(
"a" => true,
"b" => false,
"c" => true,
"d" => false,
)
# Test complex logical expressions
expr = Expression::LogicalExpression.parse("a and b or c", @ss, @cache)
assert_equal(true, expr.evaluate(context))
end
def test_evaluation_of_parenthesized_expressions
context = Liquid::Context.new(
"a" => true,
"b" => false,
"c" => true,
"d" => false,
)
expr = Expression::LogicalExpression.parse("a and (b or d)", @ss, @cache)
assert_equal(false, expr.evaluate(context))
expr = Expression::LogicalExpression.parse("(a or b) and (c or d)", @ss, @cache)
assert_equal(true, expr.evaluate(context))
expr = Expression::LogicalExpression.parse("(a or b) and (b or d)", @ss, @cache)
assert_equal(false, expr.evaluate(context))
end
def test_precedence_rules
context = Liquid::Context.new(
"a" => true,
"b" => false,
"c" => true,
)
# Test precedence rules (AND has higher precedence than OR)
# This should be interpreted as: a and (b or c)
expr1 = Expression::LogicalExpression.parse("a and b or c", @ss, @cache)
assert_equal(true, expr1.evaluate(context))
# Change context to make the expressions evaluate differently
context = Liquid::Context.new(
"a" => false,
"b" => false,
"c" => true,
)
# With these values, "a and (b or c)" would be false
expr1 = Expression::LogicalExpression.parse("a and b or c", @ss, @cache)
assert_equal(false, expr1.evaluate(context))
end
def test_precedence_with_parentheses
context = Liquid::Context.new(
"a" => true,
"b" => false,
"c" => true,
)
# This should be interpreted as: (a and b) or c
expr2 = Expression::LogicalExpression.parse("(a and b) or c", @ss, @cache)
assert_equal(true, expr2.evaluate(context))
# Change context to make the expressions evaluate differently
context = Liquid::Context.new(
"a" => false,
"b" => false,
"c" => true,
)
# But "(a and b) or c" would be true
expr2 = Expression::LogicalExpression.parse("(a and b) or c", @ss, @cache)
assert_equal(true, expr2.evaluate(context))
end
def test_integration_with_if_tag
# Test that our expressions work properly in actual templates
assert_template_result("true", "{% if true and true %}true{% else %}false{% endif %}")
assert_template_result("false", "{% if true and false %}true{% else %}false{% endif %}")
assert_template_result("true", "{% if false or true %}true{% else %}false{% endif %}")
assert_template_result("false", "{% if false or false %}true{% else %}false{% endif %}")
end
def test_integration_with_parenthesized_if_tag
# Test with parenthesized expressions
assert_template_result("true", "{% if (true and false) or true %}true{% else %}false{% endif %}")
assert_template_result("false", "{% if true and (false or false) %}true{% else %}false{% endif %}")
assert_template_result("true", "{% if true and (false or true) %}true{% else %}false{% endif %}")
end
def test_integration_with_variables
# Test with variables
template = "{% if a and b %}true{% else %}false{% endif %}"
assert_template_result("true", template, { "a" => true, "b" => true })
assert_template_result("false", template, { "a" => true, "b" => false })
template = "{% if a or b %}true{% else %}false{% endif %}"
assert_template_result("true", template, { "a" => true, "b" => false })
assert_template_result("false", template, { "a" => false, "b" => false })
end
def test_integration_with_parenthesized_variables
# Test with parenthesized expressions
template = "{% if (a and b) or c %}true{% else %}false{% endif %}"
assert_template_result("true", template, { "a" => true, "b" => true, "c" => false })
assert_template_result("true", template, { "a" => false, "b" => false, "c" => true })
assert_template_result("false", template, { "a" => false, "b" => false, "c" => false })
template = "{% if a and (b or c) %}true{% else %}false{% endif %}"
assert_template_result("true", template, { "a" => true, "b" => true, "c" => false })
assert_template_result("true", template, { "a" => true, "b" => false, "c" => true })
assert_template_result("false", template, { "a" => true, "b" => false, "c" => false })
assert_template_result("false", template, { "a" => false, "b" => true, "c" => true })
end
end
+72
View File
@@ -141,6 +141,78 @@ class LexerUnitTest < Minitest::Test
)
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
def tokenize(input)
+135
View File
@@ -0,0 +1,135 @@
# frozen_string_literal: true
require 'test_helper'
class RangeUnitTest < Minitest::Test
include Liquid
def test_basic_range_creation
assert_template_result("1 2 3 4 5", "{% for i in (1..5) %}{{ i }} {% endfor %}")
end
def test_range_with_variables
assert_template_result("3 4 5", "{% assign start = 3 %}{% for i in (start..5) %}{{ i }} {% endfor %}")
assert_template_result("1 2 3", "{% assign end = 3 %}{% for i in (1..end) %}{{ i }} {% endfor %}")
assert_template_result("2 3 4", "{% assign start = 2 %}{% assign end = 4 %}{% for i in (start..end) %}{{ i }} {% endfor %}")
end
def test_range_with_whitespace
assert_template_result("1 2 3", "{% for i in ( 1 .. 3 ) %}{{ i }} {% endfor %}")
assert_template_result("1 2 3", "{% for i in (1 .. 3) %}{{ i }} {% endfor %}")
end
def test_range_with_expressions
assert_template_result("3 4 5", "{% assign x = 1 %}{% assign start = x | plus: 2 %}{% for i in (start..5) %}{{ i }} {% endfor %}")
assert_template_result("1 2 3", "{% assign x = 2 %}{% assign end = x | plus: 1 %}{% for i in (1..end) %}{{ i }} {% endfor %}")
end
def test_range_with_literals_in_iteration
assert_template_result("1 2 3 4 5", "{% for i in (1..5) %}{{ i }} {% endfor %}")
end
def test_range_size_and_first_last
assert_template_result("5", "{{ (1..5) | size }}")
assert_template_result("1", "{{ (1..5) | first }}")
assert_template_result("5", "{{ (1..5) | last }}")
end
def test_empty_ranges
assert_template_result("", "{% for i in (5..1) %}{{ i }}{% endfor %}")
end
def test_ranges_in_conditionals
assert_template_result("yes", "{% if 3 >= (1..5) %}no{% else %}yes{% endif %}")
assert_template_result("yes", "{% if (1..5) contains 3 %}yes{% else %}no{% endif %}")
assert_template_result("no", "{% if (1..5) contains 6 %}yes{% else %}no{% endif %}")
end
def test_range_with_negative_numbers
assert_template_result("-3 -2 -1 0", "{% for i in (-3..0) %}{{ i }} {% endfor %}")
end
def test_range_with_floats
# Liquid doesn't support float ranges, should either error or not iterate
template = "{% for i in (1.5..3.5) %}{{ i }} {% endfor %}"
# Floats are rounded down to the nearest integer
assert_template_result("1 2 3", template)
end
# def test_ranges_with_calculated_endpoints
# assert_template_result(
# "3 4 5",
# "{% assign start = 1 %}{% assign end = 7 %}{% for i in (start | plus: 2 .. end | minus: 2) %}{{ i }} {% endfor %}",
# )
# end
def test_malformed_ranges
# Missing start value
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse("{% for i in (..5) %}{{ i }}{% endfor %}") }
# Missing end value
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse("{% for i in (1..) %}{{ i }}{% endfor %}") }
# Missing both values
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse("{% for i in (..) %}{{ i }}{% endfor %}") }
# Wrong syntax (no parentheses)
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse("{% for i in 1..5 %}{{ i }}{% endfor %}") }
# Unbalanced parentheses
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse("{% for i in (1..5 %}{{ i }}{% endfor %}") }
# Invalid characters in range
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse("{% for i in (#..@) %}{{ i }}{% endfor %}") }
# Invalid range
assert_raises(Liquid::SyntaxError) { Liquid::Template.parse("{% assign start = 1 %}{% assign end = 7 %}{% for i in (start | plus: 2 .. end | minus: 2) %}{{ i }} {% endfor %}") }
end
def test_ranges_with_strings_and_variables
assert_template_result(
"3 4 5",
"{% assign range = (3..5) %}{% for i in range %}{{ i }} {% endfor %}",
)
assert_template_result(
"4 5 6",
"{% assign start = 4 %}{% assign range = (start..6) %}{% for i in range %}{{ i }} {% endfor %}",
)
end
def test_ranges_with_limit_and_offset
assert_template_result(
"2 3",
"{% for i in (1..5) limit:2 offset:1 %}{{ i }} {% endfor %}",
)
assert_template_result(
"3 4 5",
"{% for i in (1..5) offset:2 %}{{ i }} {% endfor %}",
)
assert_template_result(
"1 2",
"{% for i in (1..5) limit:2 %}{{ i }} {% endfor %}",
)
end
def test_reversed_ranges
assert_template_result(
"5 4 3 2 1",
"{% for i in (1..5) reversed %}{{ i }} {% endfor %}",
)
end
def test_variable_ranges_with_reversed
assert_template_result(
"4 3 2 1",
"{% assign num = 4 %}{% for i in (1..num) reversed %}{{ i }} {% endfor %}",
)
end
def test_assigned_ranges_with_reversed
assert_template_result(
"5 4 3 2 1",
"{% assign range = (1..5) %}{% for i in range reversed %}{{ i }} {% endfor %}",
)
end
private
def assert_template_result(expected, template, assigns = {})
assert_equal(expected, Liquid::Template.parse(template).render!(assigns).strip)
end
end