mirror of
https://github.com/Shopify/liquid.git
synced 2026-09-13 07:50:43 -07:00
Compare commits
16
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
369789ed2f | ||
|
|
6a86fcc411 | ||
|
|
fdd8c714b2 | ||
|
|
63583ffe5b | ||
|
|
9a06cedbba | ||
|
|
42b6763546 | ||
|
|
e5d18c83bb | ||
|
|
c77ff68573 | ||
|
|
b0cba0bfd2 | ||
|
|
8d8661349a | ||
|
|
1f3ea7322b | ||
|
|
06f44226c0 | ||
|
|
4bd22a26dc | ||
|
|
3ed54bfdf9 | ||
|
|
29986d3704 | ||
|
|
347a2418c4 |
@@ -23,8 +23,4 @@ group :test do
|
||||
gem 'rubocop', '~> 1.61.0'
|
||||
gem 'rubocop-shopify', '~> 2.12.0', require: false
|
||||
gem 'rubocop-performance', require: false
|
||||
|
||||
platform :mri, :truffleruby do
|
||||
gem 'liquid-c', github: 'Shopify/liquid-c', ref: 'main'
|
||||
end
|
||||
end
|
||||
|
||||
@@ -43,8 +43,6 @@ task :test do
|
||||
Rake::Task['base_test'].invoke
|
||||
|
||||
if RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'truffleruby'
|
||||
ENV['LIQUID_C'] = '1'
|
||||
|
||||
ENV['LIQUID_PARSER_MODE'] = 'lax'
|
||||
Rake::Task['integration_test'].reenable
|
||||
Rake::Task['integration_test'].invoke
|
||||
@@ -83,10 +81,21 @@ namespace :benchmark do
|
||||
end
|
||||
|
||||
desc "Run unit benchmarks"
|
||||
task :unit do
|
||||
Dir["./performance/unit/*_benchmark.rb"].each do |file|
|
||||
puts "🧪 Running #{file}"
|
||||
ruby file
|
||||
namespace :unit do
|
||||
desc "Run all unit benchmarks"
|
||||
task :all do
|
||||
Dir["./performance/unit/*_benchmark.rb"].each do |file|
|
||||
puts "🧪 Running #{file}"
|
||||
ruby file
|
||||
end
|
||||
end
|
||||
|
||||
%w[lexer loom].each do |benchmark|
|
||||
desc "Run the #{benchmark} benchmark"
|
||||
task benchmark.to_sym do
|
||||
puts "🧪 Running #{benchmark}"
|
||||
ruby "./performance/unit/#{benchmark}_benchmark.rb"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
+1
-5
@@ -44,15 +44,11 @@ module Liquid
|
||||
VariableParser = /\[(?>[^\[\]]+|\g<0>)*\]|#{VariableSegment}+\??/o
|
||||
|
||||
RAISE_EXCEPTION_LAMBDA = ->(_e) { raise }
|
||||
|
||||
singleton_class.send(:attr_accessor, :cache_classes)
|
||||
self.cache_classes = true
|
||||
end
|
||||
|
||||
require "liquid/version"
|
||||
require "liquid/deprecations"
|
||||
require "liquid/const"
|
||||
require "liquid/template/tag_registry"
|
||||
require 'liquid/standardfilters'
|
||||
require 'liquid/file_system'
|
||||
require 'liquid/parser_switching'
|
||||
@@ -72,7 +68,6 @@ require 'liquid/extensions'
|
||||
require 'liquid/errors'
|
||||
require 'liquid/interrupts'
|
||||
require 'liquid/strainer_template'
|
||||
require 'liquid/strainer_factory'
|
||||
require 'liquid/expression'
|
||||
require 'liquid/context'
|
||||
require 'liquid/tag'
|
||||
@@ -91,3 +86,4 @@ require 'liquid/partial_cache'
|
||||
require 'liquid/usage'
|
||||
require 'liquid/registers'
|
||||
require 'liquid/template_factory'
|
||||
require 'liquid/loom'
|
||||
|
||||
@@ -31,10 +31,11 @@ module Liquid
|
||||
end
|
||||
end
|
||||
|
||||
def freeze
|
||||
@nodelist.freeze
|
||||
super
|
||||
end
|
||||
# TODO: Freeze the nodelist after optimization
|
||||
# def freeze
|
||||
# @nodelist.freeze
|
||||
# super
|
||||
# end
|
||||
|
||||
private def parse_for_liquid_tag(tokenizer, parse_context)
|
||||
while (token = tokenizer.shift)
|
||||
@@ -154,6 +155,12 @@ module Liquid
|
||||
end
|
||||
new_tag = tag.parse(tag_name, markup, tokenizer, parse_context)
|
||||
@blank &&= new_tag.blank?
|
||||
|
||||
if parse_context.eager_optimize
|
||||
next if new_tag.nodelist&.all? { !_1.is_a?(String) && _1.nodelist.empty? } # this is an empty block
|
||||
next if new_tag.is_a?(If) && new_tag.blocks.empty? # this is an empty If block
|
||||
end
|
||||
|
||||
@nodelist << new_tag
|
||||
when token.start_with?(VARSTART)
|
||||
whitespace_handler(token, parse_context)
|
||||
|
||||
@@ -19,7 +19,7 @@ module Liquid
|
||||
|
||||
# rubocop:disable Metrics/ParameterLists
|
||||
def self.build(environment: Environment.default, environments: {}, outer_scope: {}, registers: {}, rethrow_errors: false, resource_limits: nil, static_environments: {}, &block)
|
||||
new(environments, outer_scope, registers, rethrow_errors, resource_limits, static_environments, &block)
|
||||
new(environments, outer_scope, registers, rethrow_errors, resource_limits, static_environments, environment, &block)
|
||||
end
|
||||
|
||||
def initialize(environments = {}, outer_scope = {}, registers = {}, rethrow_errors = false, resource_limits = nil, static_environments = {}, environment = Environment.default)
|
||||
@@ -143,6 +143,7 @@ module Liquid
|
||||
check_overflow
|
||||
|
||||
self.class.build(
|
||||
environment: @environment,
|
||||
resource_limits: resource_limits,
|
||||
static_environments: static_environments,
|
||||
registers: Registers.new(registers),
|
||||
|
||||
@@ -41,7 +41,7 @@ module Liquid
|
||||
# @return [Environment] The new environment instance.
|
||||
def build(tags: nil, file_system: nil, error_mode: nil, exception_renderer: nil)
|
||||
ret = new
|
||||
ret.tags = Template::TagRegistry.new(tags) if tags
|
||||
ret.tags = tags if tags
|
||||
ret.file_system = file_system if file_system
|
||||
ret.error_mode = error_mode if error_mode
|
||||
ret.exception_renderer = exception_renderer if exception_renderer
|
||||
@@ -74,7 +74,7 @@ module Liquid
|
||||
# Initializes a new environment instance.
|
||||
# @api private
|
||||
def initialize
|
||||
@tags = Template::TagRegistry.new(Tags::STANDARD_TAGS)
|
||||
@tags = Tags::STANDARD_TAGS.dup
|
||||
@error_mode = :lax
|
||||
@strainer_template = Class.new(StrainerTemplate).tap do |klass|
|
||||
klass.add_filter(StandardFilters)
|
||||
|
||||
@@ -0,0 +1,123 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Liquid
|
||||
class Loom
|
||||
MERGABLE_IF_OPERATORS = ["==", ">", "<", "!="].freeze
|
||||
EQUAL_OP = "==".freeze
|
||||
|
||||
class << self
|
||||
def optimize(template)
|
||||
new(template).optimize
|
||||
end
|
||||
end
|
||||
|
||||
def initialize template
|
||||
@root = template.root
|
||||
end
|
||||
|
||||
def optimize
|
||||
merge_if_blocks
|
||||
end
|
||||
|
||||
def merge_if_blocks
|
||||
nodelist_list = [@root.nodelist]
|
||||
|
||||
while nodelist_list.any?
|
||||
next_nodelist_list = []
|
||||
|
||||
nodelist_list.each do |nodelist|
|
||||
i = 0
|
||||
while i < nodelist.length
|
||||
node = nodelist[i]
|
||||
chain_if_blocks(nodelist, node, i) if node.is_a?(If)
|
||||
i += 1
|
||||
end
|
||||
end
|
||||
|
||||
nodelist_list = next_nodelist_list
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def mergable_if_blocks?(target_if, next_if)
|
||||
target_left = target_if.blocks.first.left
|
||||
target_right = target_if.blocks.first.right
|
||||
next_left = next_if.blocks.first.left
|
||||
next_right = next_if.blocks.first.right
|
||||
|
||||
used_variables = Hash.new { |h, k| h[k] = 0 }
|
||||
|
||||
[
|
||||
target_if.blocks.first.left,
|
||||
target_if.blocks.first.right,
|
||||
next_if.blocks.first.left,
|
||||
next_if.blocks.first.right
|
||||
].each do |var|
|
||||
if var.is_a?(VariableLookup)
|
||||
used_variables[var.name] += 1
|
||||
end
|
||||
end
|
||||
|
||||
return if used_variables.keys.count > 1
|
||||
|
||||
most_used_variable_name = used_variables.keys[0]
|
||||
|
||||
# TODO: I probably can't do this
|
||||
# It might be possible to get different result between a > b and b < a
|
||||
# Move most commonly used variable to the left side
|
||||
if (target_left.is_a?(VariableLookup) && target_left.name != most_used_variable_name) || (target_right.is_a?(VariableLookup) && target_right.name == most_used_variable_name)
|
||||
target_left, target_right = target_right, target_left
|
||||
end
|
||||
|
||||
if (next_left.is_a?(VariableLookup) && next_left.name != most_used_variable_name) || (next_right.is_a?(VariableLookup) && next_right.name == most_used_variable_name)
|
||||
next_left, next_right = next_right, next_left
|
||||
end
|
||||
|
||||
return false unless target_left.is_a?(VariableLookup) && next_left.is_a?(VariableLookup)
|
||||
return false if target_left.name != next_left.name
|
||||
|
||||
return false if target_right.nil? || next_right.nil?
|
||||
|
||||
|
||||
# we need to be conversative here and only can merge ==, >, <, and != operators
|
||||
target_operator = target_if.blocks.first.operator
|
||||
next_operator = next_if.blocks.first.operator
|
||||
|
||||
return false unless MERGABLE_IF_OPERATORS.include?(target_operator) && MERGABLE_IF_OPERATORS.include?(next_operator)
|
||||
|
||||
return false if target_operator == next_operator && target_right == next_right
|
||||
|
||||
return false if target_right.is_a?(VariableLookup) || next_right.is_a?(VariableLookup)
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def chain_if_blocks(nodelist, first_if_node, first_if_index)
|
||||
used_variables = Set.new
|
||||
|
||||
# only check the top level Condition (ignore children conditions for now)
|
||||
first_if_node.blocks.each do |condition|
|
||||
used_variables << condition.left
|
||||
used_variables << condition.right if condition.right
|
||||
end
|
||||
|
||||
if_blocks = []
|
||||
|
||||
nodelist[first_if_index + 1..-1].each do |node|
|
||||
break unless node.is_a?(If)
|
||||
|
||||
# check if the variables used in the current block are used in the previous block
|
||||
break unless mergable_if_blocks?(first_if_node, node)
|
||||
|
||||
if_blocks << node
|
||||
end
|
||||
|
||||
nodelist.delete_if { |node| if_blocks.include?(node) }
|
||||
|
||||
if_blocks.each do |if_block|
|
||||
first_if_node.blocks << if_block.blocks.first
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -3,7 +3,7 @@
|
||||
module Liquid
|
||||
class ParseContext
|
||||
attr_accessor :locale, :line_number, :trim_whitespace, :depth
|
||||
attr_reader :partial, :warnings, :error_mode, :environment
|
||||
attr_reader :partial, :warnings, :error_mode, :environment, :eager_optimize
|
||||
|
||||
def initialize(options = Const::EMPTY_HASH)
|
||||
@environment = options.fetch(:environment, Environment.default)
|
||||
@@ -11,6 +11,7 @@ module Liquid
|
||||
|
||||
@locale = @template_options[:locale] ||= I18n.new
|
||||
@warnings = []
|
||||
@eager_optimize = options.fetch(:eager_optimize, ENV["OPTIMIZE"] == "true")
|
||||
|
||||
self.depth = 0
|
||||
self.partial = false
|
||||
|
||||
@@ -36,7 +36,7 @@ module Liquid
|
||||
protected
|
||||
|
||||
def children
|
||||
@node.respond_to?(:nodelist) ? Array(@node.nodelist) : []
|
||||
@node.respond_to?(:nodelist) ? Array(@node.nodelist) : Const::EMPTY_ARRAY
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Liquid
|
||||
# StrainerFactory is the factory for the filters system.
|
||||
module StrainerFactory
|
||||
extend self
|
||||
|
||||
def add_global_filter(filter, environment = Environment.default)
|
||||
Deprecations.warn("StrainerFactory.add_global_filter", "Environment#register_filter")
|
||||
environment.register_filter(filter)
|
||||
end
|
||||
|
||||
def create(context, filters = Const::EMPTY_ARRAY, environment = Environment.default)
|
||||
Deprecations.warn("StrainerFactory.create", "StrainerFactory.create_strainer")
|
||||
environment.create_strainer(context, filters)
|
||||
end
|
||||
|
||||
def global_filter_names(environment = Environment.default)
|
||||
Deprecations.warn("StrainerFactory.global_filter_names", "Environment#filter_method_names")
|
||||
Environment.strainer_template.filter_method_names
|
||||
end
|
||||
end
|
||||
end
|
||||
+31
-3
@@ -23,6 +23,7 @@ module Liquid
|
||||
def initialize(tag_name, markup, options)
|
||||
super
|
||||
@blocks = []
|
||||
@has_else_block = false
|
||||
push_block('if', markup)
|
||||
end
|
||||
|
||||
@@ -33,17 +34,44 @@ module Liquid
|
||||
def parse(tokens)
|
||||
while parse_body(@blocks.last.attachment, tokens)
|
||||
end
|
||||
@blocks.reverse_each do |block|
|
||||
block.attachment.remove_blank_strings if blank?
|
||||
block.attachment.freeze
|
||||
|
||||
if parse_context.eager_optimize && definitive_false_statement?
|
||||
@blocks.clear
|
||||
else
|
||||
@blocks.reverse_each do |block|
|
||||
block.attachment.remove_blank_strings if blank?
|
||||
block.attachment.freeze
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def definitive_false_statement?
|
||||
# check if any blocks have variable lookups
|
||||
@blocks.each do |condition|
|
||||
return false if condition.left.is_a?(VariableLookup) || condition.right&.is_a?(VariableLookup)
|
||||
|
||||
child_condition = condition.child_condition
|
||||
|
||||
while child_condition
|
||||
return false if child_condition&.left.is_a?(VariableLookup) || child_condition&.right&.is_a?(VariableLookup)
|
||||
child_condition = child_condition.child_condition
|
||||
end
|
||||
end
|
||||
|
||||
# check if all blocks are false
|
||||
@blocks.each do |condition|
|
||||
return false if condition.evaluate
|
||||
end
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
ELSE_TAG_NAMES = ['elsif', 'else'].freeze
|
||||
private_constant :ELSE_TAG_NAMES
|
||||
|
||||
def unknown_tag(tag, markup, tokens)
|
||||
if ELSE_TAG_NAMES.include?(tag)
|
||||
@has_else_block = true
|
||||
push_block(tag, markup)
|
||||
else
|
||||
super
|
||||
|
||||
@@ -82,7 +82,11 @@ module Liquid
|
||||
# See Liquid::Profiler for more information
|
||||
def parse(source, options = {})
|
||||
environment = options[:environment] || Environment.default
|
||||
new(environment: environment).parse(source, options)
|
||||
template = new(environment: environment).parse(source, options)
|
||||
|
||||
Loom.optimize(template) if options[:eager_optimize]
|
||||
|
||||
template
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Liquid
|
||||
class Template
|
||||
class TagRegistry
|
||||
include Enumerable
|
||||
|
||||
def initialize(tags = nil)
|
||||
@tags = {}
|
||||
@cache = {}
|
||||
tags.each { |tag_name, klass| self[tag_name] = klass }
|
||||
Deprecations.warn("Template::TagRegistry", "Use a Environment instance with zeitwerk")
|
||||
end
|
||||
|
||||
def [](tag_name)
|
||||
return nil unless @tags.key?(tag_name)
|
||||
return @cache[tag_name] if Liquid.cache_classes
|
||||
|
||||
lookup_class(@tags[tag_name]).tap { |o| @cache[tag_name] = o }
|
||||
end
|
||||
|
||||
def delete(tag_name)
|
||||
Deprecations.warn("Template::TagRegistry#delete", "Use a Environment instance with immutable tags")
|
||||
@tags.delete(tag_name)
|
||||
@cache.delete(tag_name)
|
||||
end
|
||||
|
||||
def []=(tag_name, klass)
|
||||
@tags[tag_name] = klass.name
|
||||
@cache[tag_name] = klass
|
||||
end
|
||||
|
||||
def each(&block)
|
||||
@tags.each(&block)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def lookup_class(name)
|
||||
Object.const_get(name)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
+13
-7
@@ -68,7 +68,7 @@ module Liquid
|
||||
@name = parse_context.parse_expression(p.expression)
|
||||
while p.consume?(:pipe)
|
||||
filtername = p.consume(:id)
|
||||
filterargs = p.consume?(:colon) ? parse_filterargs(p) : []
|
||||
filterargs = p.consume?(:colon) ? parse_filterargs(p) : Const::EMPTY_ARRAY
|
||||
@filters << parse_filter_expressions(filtername, filterargs)
|
||||
end
|
||||
p.consume(:end_of_string)
|
||||
@@ -95,15 +95,21 @@ module Liquid
|
||||
|
||||
def render_to_output_buffer(context, output)
|
||||
obj = render(context)
|
||||
render_obj_to_output(obj, output)
|
||||
output
|
||||
end
|
||||
|
||||
if obj.is_a?(Array)
|
||||
output << obj.join
|
||||
elsif obj.nil?
|
||||
else
|
||||
def render_obj_to_output(obj, output)
|
||||
case obj
|
||||
when NilClass
|
||||
# Do nothing
|
||||
when Array
|
||||
obj.each do |o|
|
||||
render_obj_to_output(o, output)
|
||||
end
|
||||
when
|
||||
output << obj.to_s
|
||||
end
|
||||
|
||||
output
|
||||
end
|
||||
|
||||
def disabled?(_context)
|
||||
|
||||
@@ -2,5 +2,5 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Liquid
|
||||
VERSION = "5.6.0.alpha"
|
||||
VERSION = "5.6.0.rc2"
|
||||
end
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
|
||||
s.summary = "A secure, non-evaling end user template engine with aesthetic markup."
|
||||
s.authors = ["Tobias Lütke"]
|
||||
s.email = ["[email protected]"]
|
||||
s.homepage = "http://www.liquidmarkup.org"
|
||||
s.homepage = "https://shopify.github.io/liquid/"
|
||||
s.license = "MIT"
|
||||
# s.description = "A secure, non-evaling end user template engine with aesthetic markup."
|
||||
|
||||
|
||||
@@ -4,7 +4,8 @@ require 'benchmark/ips'
|
||||
require_relative 'theme_runner'
|
||||
|
||||
RubyVM::YJIT.enable if defined?(RubyVM::YJIT)
|
||||
Liquid::Template.error_mode = ARGV.first.to_sym if ARGV.first
|
||||
Liquid::Environment.default.error_mode = ARGV.first.to_sym if ARGV.first
|
||||
|
||||
profiler = ThemeRunner.new
|
||||
|
||||
Benchmark.ips do |x|
|
||||
|
||||
@@ -11,11 +11,12 @@ require_relative 'shop_filter'
|
||||
require_relative 'tag_filter'
|
||||
require_relative 'weight_filter'
|
||||
|
||||
Liquid::Template.register_tag('paginate', Paginate)
|
||||
Liquid::Template.register_tag('form', CommentForm)
|
||||
default_environment = Liquid::Environment.default
|
||||
default_environment.register_tag('paginate', Paginate)
|
||||
default_environment.register_tag('form', CommentForm)
|
||||
|
||||
Liquid::Template.register_filter(JsonFilter)
|
||||
Liquid::Template.register_filter(MoneyFilter)
|
||||
Liquid::Template.register_filter(WeightFilter)
|
||||
Liquid::Template.register_filter(ShopFilter)
|
||||
Liquid::Template.register_filter(TagFilter)
|
||||
default_environment.register_filter(JsonFilter)
|
||||
default_environment.register_filter(MoneyFilter)
|
||||
default_environment.register_filter(WeightFilter)
|
||||
default_environment.register_filter(ShopFilter)
|
||||
default_environment.register_filter(TagFilter)
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "benchmark/ips"
|
||||
require 'liquid'
|
||||
|
||||
RubyVM::YJIT.enable
|
||||
|
||||
TEMPLATE = <<~LIQUID
|
||||
{% if false %}
|
||||
{% for i in (1..1000000) %}
|
||||
{{ "Hello world!" }}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
{% assign result = 1 %}
|
||||
{% if foo == 1 %}{% assign result = 1 %}{% endif %}{% if foo == 2 %}{% assign result = 2 %}{% endif %}{% if foo == 3 %}{% assign result = 3 %}{% endif %}
|
||||
Result: {{ result }}
|
||||
LIQUID
|
||||
|
||||
baseline_template = Liquid::Template.parse(TEMPLATE, eager_optimize: false)
|
||||
optimized_template = Liquid::Template.parse(TEMPLATE, eager_optimize: true)
|
||||
|
||||
[nil, 1, 2, 3].each do |foo|
|
||||
baseline_output = baseline_template.render('foo' => foo)
|
||||
optimized_output = optimized_template.render('foo' => foo)
|
||||
|
||||
if baseline_output != optimized_output
|
||||
puts "WARNING! Baseline and optimized templates render differently for foo=#{foo}"
|
||||
puts "Baseline: #{baseline_output}"
|
||||
puts "Optimized: #{optimized_output}"
|
||||
|
||||
raise
|
||||
end
|
||||
end
|
||||
|
||||
def render(template, foo)
|
||||
template.render('foo' => foo)
|
||||
end
|
||||
|
||||
Benchmark.ips do |x|
|
||||
x.config(time: 20, warmup: 3)
|
||||
|
||||
x.report("baseline") do
|
||||
[nil, 1, 2, 3].each do |foo|
|
||||
render(baseline_template, foo)
|
||||
end
|
||||
end
|
||||
|
||||
x.report("optimized") do
|
||||
[nil, 1, 2, 3].each do |foo|
|
||||
render(optimized_template, foo)
|
||||
end
|
||||
end
|
||||
|
||||
x.compare!
|
||||
end
|
||||
@@ -672,6 +672,21 @@ class ContextTest < Minitest::Test
|
||||
assert_includes(result, "unscoped_products_count: 5")
|
||||
end
|
||||
|
||||
def test_new_isolated_context_inherits_parent_environment
|
||||
global_environment = Liquid::Environment.build(tags: {})
|
||||
context = Context.build(environment: global_environment)
|
||||
|
||||
subcontext = context.new_isolated_subcontext
|
||||
assert_equal(global_environment, subcontext.environment)
|
||||
end
|
||||
|
||||
def test_newly_built_context_inherits_parent_environment
|
||||
global_environment = Liquid::Environment.build(tags: {})
|
||||
context = Context.build(environment: global_environment)
|
||||
assert_equal(global_environment, context.environment)
|
||||
assert(context.environment.tags.each.to_a.empty?)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def assert_no_object_allocations
|
||||
|
||||
@@ -203,20 +203,19 @@ class ErrorHandlingTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_setting_default_exception_renderer
|
||||
old_exception_renderer = Liquid::Template.default_exception_renderer
|
||||
exceptions = []
|
||||
Liquid::Template.default_exception_renderer = ->(e) {
|
||||
default_exception_renderer = ->(e) {
|
||||
exceptions << e
|
||||
''
|
||||
}
|
||||
template = Liquid::Template.parse('This is a runtime error: {{ errors.argument_error }}')
|
||||
|
||||
env = Liquid::Environment.build(exception_renderer: default_exception_renderer)
|
||||
template = Liquid::Template.parse('This is a runtime error: {{ errors.argument_error }}', environment: env)
|
||||
|
||||
output = template.render('errors' => ErrorDrop.new)
|
||||
|
||||
assert_equal('This is a runtime error: ', output)
|
||||
assert_equal([Liquid::ArgumentError], template.errors.map(&:class))
|
||||
ensure
|
||||
Liquid::Template.default_exception_renderer = old_exception_renderer if old_exception_renderer
|
||||
end
|
||||
|
||||
def test_setting_exception_renderer_on_environment
|
||||
|
||||
@@ -33,7 +33,7 @@ class ProfilerTest < Minitest::Test
|
||||
end
|
||||
|
||||
def setup
|
||||
Liquid::Template.file_system = ProfilingFileSystem.new
|
||||
Liquid::Environment.default.file_system = ProfilingFileSystem.new
|
||||
end
|
||||
|
||||
def test_template_allows_flagging_profiling
|
||||
|
||||
@@ -174,10 +174,10 @@ class IncludeTagTest < Minitest::Test
|
||||
end
|
||||
end
|
||||
|
||||
Liquid::Template.file_system = infinite_file_system.new
|
||||
env = Liquid::Environment.build(file_system: infinite_file_system.new)
|
||||
|
||||
assert_raises(Liquid::StackLevelError) do
|
||||
Template.parse("{% include 'loop' %}").render!
|
||||
Template.parse("{% include 'loop' %}", environment: env).render!
|
||||
end
|
||||
end
|
||||
|
||||
@@ -264,26 +264,27 @@ class IncludeTagTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_does_not_add_error_in_strict_mode_for_missing_variable
|
||||
Liquid::Template.file_system = TestFileSystem.new
|
||||
env = Liquid::Environment.build(file_system: TestFileSystem.new)
|
||||
|
||||
a = Liquid::Template.parse(' {% include "nested_template" %}')
|
||||
a = Liquid::Template.parse(' {% include "nested_template" %}', environment: env)
|
||||
a.render!
|
||||
assert_empty(a.errors)
|
||||
end
|
||||
|
||||
def test_passing_options_to_included_templates
|
||||
Liquid::Template.file_system = TestFileSystem.new
|
||||
env = Liquid::Environment.build(file_system: TestFileSystem.new)
|
||||
|
||||
assert_raises(Liquid::SyntaxError) do
|
||||
Template.parse("{% include template %}", error_mode: :strict).render!("template" => '{{ "X" || downcase }}')
|
||||
Template.parse("{% include template %}", error_mode: :strict, environment: env).render!("template" => '{{ "X" || downcase }}')
|
||||
end
|
||||
with_error_mode(:lax) do
|
||||
assert_equal('x', Template.parse("{% include template %}", error_mode: :strict, include_options_blacklist: true).render!("template" => '{{ "X" || downcase }}'))
|
||||
assert_equal('x', Template.parse("{% include template %}", error_mode: :strict, include_options_blacklist: true, environment: env).render!("template" => '{{ "X" || downcase }}'))
|
||||
end
|
||||
assert_raises(Liquid::SyntaxError) do
|
||||
Template.parse("{% include template %}", error_mode: :strict, include_options_blacklist: [:locale]).render!("template" => '{{ "X" || downcase }}')
|
||||
Template.parse("{% include template %}", error_mode: :strict, include_options_blacklist: [:locale], environment: env).render!("template" => '{{ "X" || downcase }}')
|
||||
end
|
||||
with_error_mode(:lax) do
|
||||
assert_equal('x', Template.parse("{% include template %}", error_mode: :strict, include_options_blacklist: [:error_mode]).render!("template" => '{{ "X" || downcase }}'))
|
||||
assert_equal('x', Template.parse("{% include template %}", error_mode: :strict, include_options_blacklist: [:error_mode], environment: env).render!("template" => '{{ "X" || downcase }}'))
|
||||
end
|
||||
end
|
||||
|
||||
@@ -334,8 +335,11 @@ class IncludeTagTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_including_with_strict_variables
|
||||
Liquid::Template.file_system = StubFileSystem.new({ "simple" => "simple" })
|
||||
template = Liquid::Template.parse("{% include 'simple' %}", error_mode: :warn)
|
||||
env = Liquid::Environment.build(
|
||||
file_system: StubFileSystem.new('simple' => 'simple'),
|
||||
)
|
||||
|
||||
template = Liquid::Template.parse("{% include 'simple' %}", error_mode: :warn, environment: env)
|
||||
template.render(nil, strict_variables: true)
|
||||
|
||||
assert_equal([], template.errors)
|
||||
|
||||
@@ -82,19 +82,22 @@ class RenderTagTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_recursively_rendered_template_does_not_produce_endless_loop
|
||||
Liquid::Template.file_system = StubFileSystem.new('loop' => '{% render "loop" %}')
|
||||
env = Liquid::Environment.build(
|
||||
file_system: StubFileSystem.new('loop' => '{% render "loop" %}'),
|
||||
)
|
||||
|
||||
assert_raises(Liquid::StackLevelError) do
|
||||
Template.parse('{% render "loop" %}').render!
|
||||
Template.parse('{% render "loop" %}', environment: env).render!
|
||||
end
|
||||
end
|
||||
|
||||
def test_sub_contexts_count_towards_the_same_recursion_limit
|
||||
Liquid::Template.file_system = StubFileSystem.new(
|
||||
'loop_render' => '{% render "loop_render" %}',
|
||||
env = Liquid::Environment.build(
|
||||
file_system: StubFileSystem.new('loop_render' => '{% render "loop_render" %}'),
|
||||
)
|
||||
|
||||
assert_raises(Liquid::StackLevelError) do
|
||||
Template.parse('{% render "loop_render" %}').render!
|
||||
Template.parse('{% render "loop_render" %}', environment: env).render!
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -130,6 +130,10 @@ class VariableTest < Minitest::Test
|
||||
assert_template_result('bar', '{{ foo }}', { 'foo' => :bar })
|
||||
end
|
||||
|
||||
def test_nested_array
|
||||
assert_template_result('', '{{ foo }}', { 'foo' => [[nil]] })
|
||||
end
|
||||
|
||||
def test_dynamic_find_var
|
||||
assert_template_result('bar', '{{ [key] }}', { 'key' => 'foo', 'foo' => 'bar' })
|
||||
end
|
||||
|
||||
+4
-9
@@ -13,12 +13,7 @@ if (env_mode = ENV['LIQUID_PARSER_MODE'])
|
||||
puts "-- #{env_mode.upcase} ERROR MODE"
|
||||
mode = env_mode.to_sym
|
||||
end
|
||||
Liquid::Template.error_mode = mode
|
||||
|
||||
if ENV['LIQUID_C'] == '1'
|
||||
puts "-- LIQUID C"
|
||||
require 'liquid/c'
|
||||
end
|
||||
Liquid::Environment.default.error_mode = mode
|
||||
|
||||
if Minitest.const_defined?('Test')
|
||||
# We're on Minitest 5+. Nothing to do here.
|
||||
@@ -88,11 +83,11 @@ module Minitest
|
||||
end
|
||||
|
||||
def with_error_mode(mode)
|
||||
old_mode = Liquid::Template.error_mode
|
||||
Liquid::Template.error_mode = mode
|
||||
old_mode = Liquid::Environment.default.error_mode
|
||||
Liquid::Environment.default.error_mode = mode
|
||||
yield
|
||||
ensure
|
||||
Liquid::Template.error_mode = old_mode
|
||||
Liquid::Environment.default.error_mode = old_mode
|
||||
end
|
||||
|
||||
def with_custom_tag(tag_name, tag_class, &block)
|
||||
|
||||
@@ -0,0 +1,186 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'test_helper'
|
||||
|
||||
class EagerOptimizeTest < Minitest::Test
|
||||
include Liquid
|
||||
|
||||
def test_remove_empty_blocks
|
||||
source = <<~LIQUID.gsub(/\n/, '')
|
||||
{% for i in (1..1000000) %}
|
||||
{% endfor %}
|
||||
LIQUID
|
||||
|
||||
template = Liquid::Template.parse(source, eager_optimize: true)
|
||||
assert_equal(0, total_node_count(template))
|
||||
end
|
||||
|
||||
def test_remove_false_if_block
|
||||
source = <<~LIQUID.gsub(/\n/, '')
|
||||
{% if false %}
|
||||
{% if true %}
|
||||
{% if true %}
|
||||
{% if true %}
|
||||
{{ "Hello world!" }}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
template = Liquid::Template.parse(source, eager_optimize: true)
|
||||
assert_equal(0, total_node_count(template))
|
||||
|
||||
source = <<~LIQUID.gsub(/\n/, '')
|
||||
{% if false %}
|
||||
{% for i in (1..1000000) %}
|
||||
{{ "Hello world!" }}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
template = Liquid::Template.parse(source, eager_optimize: true)
|
||||
assert_equal(0, total_node_count(template))
|
||||
end
|
||||
|
||||
def test_remove_multiple_false_if_block
|
||||
source = <<~LIQUID.gsub(/\n/, '')
|
||||
{% if false %}
|
||||
{% if true %}
|
||||
{% if true %}
|
||||
{% if true %}
|
||||
{{ "Hello world!" }}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
template = Liquid::Template.parse(source, eager_optimize: true)
|
||||
assert_equal(0, total_node_count(template))
|
||||
end
|
||||
|
||||
def test_merge_if_blocks
|
||||
# for now, work with consecutive if blocks without any String nodes in between
|
||||
source = <<~LIQUID.gsub(/\n/, '')
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if foo == 2 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if foo == 3 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_optimization([Liquid::If], source, { "foo" => nil })
|
||||
assert_optimization([Liquid::If], source, { "foo" => 1 })
|
||||
assert_optimization([Liquid::If], source, { "foo" => 2 })
|
||||
assert_optimization([Liquid::If], source, { "foo" => 5 })
|
||||
|
||||
source = <<~LIQUID.gsub(/\n/, '')
|
||||
{% assign bar = "application" %}
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if foo == 2 and bar contains "app" %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if 3 == foo and bar == "application" %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_optimization([Liquid::Assign, Liquid::If], source)
|
||||
end
|
||||
|
||||
def test_does_not_merge_if_blocks
|
||||
assert_optimization([Liquid::If, Liquid::If], <<~LIQUID.gsub(/\n/, ''))
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if k == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_optimization([Liquid::If, Liquid::If], <<~LIQUID.gsub(/\n/, ''))
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_optimization([Liquid::If, Liquid::If], <<~LIQUID.gsub(/\n/, ''))
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if a == foo %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_optimization([Liquid::If, Liquid::If], <<~LIQUID.gsub(/\n/, ''))
|
||||
{% if foo %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if foo %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_optimization([Liquid::If, Liquid::If], <<~LIQUID.gsub(/\n/, ''))
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if foo >= 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
|
||||
assert_optimization([Liquid::If, Liquid::If], <<~LIQUID.gsub(/\n/, ''))
|
||||
{% if foo == 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
{% if 1 %}
|
||||
foo: {{ foo }}
|
||||
{% endif %}
|
||||
LIQUID
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def assert_optimization(expected, source, context = { "foo" => 1 })
|
||||
template = Template.parse(source, eager_optimize: true)
|
||||
assert_equal(expected, template.root.nodelist.map(&:class),)
|
||||
|
||||
baseline_template = Template.parse(source, eager_optimize: false)
|
||||
|
||||
assert_equal(
|
||||
baseline_template.render(context),
|
||||
template.render(context),
|
||||
)
|
||||
end
|
||||
|
||||
def total_node_count(template)
|
||||
root = template.root
|
||||
children = root.nodelist
|
||||
count = 0
|
||||
|
||||
while children.any?
|
||||
next_children = []
|
||||
|
||||
children.each do |node|
|
||||
count += 1 unless node.is_a?(Liquid::BlockBody)
|
||||
next_children.concat(node.nodelist) if node.respond_to?(:nodelist) && node.nodelist
|
||||
end
|
||||
|
||||
children = next_children
|
||||
end
|
||||
|
||||
count
|
||||
end
|
||||
end
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
require 'test_helper'
|
||||
|
||||
class StrainerFactoryUnitTest < Minitest::Test
|
||||
class EnvironmentFilterTest < Minitest::Test
|
||||
include Liquid
|
||||
|
||||
module AccessScopeFilters
|
||||
@@ -16,8 +16,6 @@ class StrainerFactoryUnitTest < Minitest::Test
|
||||
private :private_filter
|
||||
end
|
||||
|
||||
StrainerFactory.add_global_filter(AccessScopeFilters)
|
||||
|
||||
module LateAddedFilter
|
||||
def late_added_filter(_input)
|
||||
"filtered"
|
||||
@@ -25,24 +23,28 @@ class StrainerFactoryUnitTest < Minitest::Test
|
||||
end
|
||||
|
||||
def setup
|
||||
@context = Context.build
|
||||
@environment = Liquid::Environment.build do |env|
|
||||
env.register_filter(AccessScopeFilters)
|
||||
end
|
||||
|
||||
@context = Context.build(environment: @environment)
|
||||
end
|
||||
|
||||
def test_strainer
|
||||
strainer = StrainerFactory.create(@context)
|
||||
strainer = @environment.create_strainer(@context)
|
||||
assert_equal(5, strainer.invoke('size', 'input'))
|
||||
assert_equal("public", strainer.invoke("public_filter"))
|
||||
end
|
||||
|
||||
def test_stainer_raises_argument_error
|
||||
strainer = StrainerFactory.create(@context)
|
||||
strainer = @environment.create_strainer(@context)
|
||||
assert_raises(Liquid::ArgumentError) do
|
||||
strainer.invoke("public_filter", 1)
|
||||
end
|
||||
end
|
||||
|
||||
def test_stainer_argument_error_contains_backtrace
|
||||
strainer = StrainerFactory.create(@context)
|
||||
strainer = @environment.create_strainer(@context)
|
||||
|
||||
exception = assert_raises(Liquid::ArgumentError) do
|
||||
strainer.invoke("public_filter", 1)
|
||||
@@ -57,7 +59,7 @@ class StrainerFactoryUnitTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_strainer_only_invokes_public_filter_methods
|
||||
strainer = StrainerFactory.create(@context)
|
||||
strainer = @environment.create_strainer(@context)
|
||||
assert_equal(false, strainer.class.invokable?('__test__'))
|
||||
assert_equal(false, strainer.class.invokable?('test'))
|
||||
assert_equal(false, strainer.class.invokable?('instance_eval'))
|
||||
@@ -66,18 +68,18 @@ class StrainerFactoryUnitTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_strainer_returns_nil_if_no_filter_method_found
|
||||
strainer = StrainerFactory.create(@context)
|
||||
strainer = @environment.create_strainer(@context)
|
||||
assert_nil(strainer.invoke("private_filter"))
|
||||
assert_nil(strainer.invoke("undef_the_filter"))
|
||||
end
|
||||
|
||||
def test_strainer_returns_first_argument_if_no_method_and_arguments_given
|
||||
strainer = StrainerFactory.create(@context)
|
||||
strainer = @environment.create_strainer(@context)
|
||||
assert_equal("password", strainer.invoke("undef_the_method", "password"))
|
||||
end
|
||||
|
||||
def test_strainer_only_allows_methods_defined_in_filters
|
||||
strainer = StrainerFactory.create(@context)
|
||||
strainer = @environment.create_strainer(@context)
|
||||
assert_equal("1 + 1", strainer.invoke("instance_eval", "1 + 1"))
|
||||
assert_equal("puts", strainer.invoke("__send__", "puts", "Hi Mom"))
|
||||
assert_equal("has_method?", strainer.invoke("invoke", "has_method?", "invoke"))
|
||||
@@ -86,7 +88,9 @@ class StrainerFactoryUnitTest < Minitest::Test
|
||||
def test_strainer_uses_a_class_cache_to_avoid_method_cache_invalidation
|
||||
a = Module.new
|
||||
b = Module.new
|
||||
strainer = StrainerFactory.create(@context, [a, b])
|
||||
|
||||
strainer = @environment.create_strainer(@context, [a, b])
|
||||
|
||||
assert_kind_of(StrainerTemplate, strainer)
|
||||
assert_kind_of(a, strainer)
|
||||
assert_kind_of(b, strainer)
|
||||
@@ -94,8 +98,10 @@ class StrainerFactoryUnitTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_add_global_filter_clears_cache
|
||||
assert_equal('input', StrainerFactory.create(@context).invoke('late_added_filter', 'input'))
|
||||
StrainerFactory.add_global_filter(LateAddedFilter)
|
||||
assert_equal('filtered', StrainerFactory.create(nil).invoke('late_added_filter', 'input'))
|
||||
assert_equal('input', @environment.create_strainer(@context).invoke('late_added_filter', 'input'))
|
||||
|
||||
@environment.register_filter(LateAddedFilter)
|
||||
|
||||
assert_equal('filtered', @environment.create_strainer(nil).invoke('late_added_filter', 'input'))
|
||||
end
|
||||
end
|
||||
@@ -25,11 +25,13 @@ class StrainerTemplateUnitTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_add_filter_raises_when_module_privately_overrides_registered_public_methods
|
||||
strainer = Context.new.strainer
|
||||
|
||||
error = assert_raises(Liquid::MethodOverrideError) do
|
||||
strainer.class.add_filter(PrivateMethodOverrideFilter)
|
||||
Liquid::Environment.build do |env|
|
||||
env.register_filter(PublicMethodOverrideFilter)
|
||||
env.register_filter(PrivateMethodOverrideFilter)
|
||||
end
|
||||
end
|
||||
|
||||
assert_equal('Liquid error: Filter overrides registered public methods as non public: public_filter', error.message)
|
||||
end
|
||||
|
||||
@@ -42,11 +44,13 @@ class StrainerTemplateUnitTest < Minitest::Test
|
||||
end
|
||||
|
||||
def test_add_filter_raises_when_module_overrides_registered_public_method_as_protected
|
||||
strainer = Context.new.strainer
|
||||
|
||||
error = assert_raises(Liquid::MethodOverrideError) do
|
||||
strainer.class.add_filter(ProtectedMethodOverrideFilter)
|
||||
Liquid::Environment.build do |env|
|
||||
env.register_filter(PublicMethodOverrideFilter)
|
||||
env.register_filter(ProtectedMethodOverrideFilter)
|
||||
end
|
||||
end
|
||||
|
||||
assert_equal('Liquid error: Filter overrides registered public methods as non public: public_filter', error.message)
|
||||
end
|
||||
|
||||
|
||||
@@ -20,50 +20,12 @@ class TemplateUnitTest < Minitest::Test
|
||||
assert_equal(fixture("en_locale.yml"), locale.path)
|
||||
end
|
||||
|
||||
def test_with_cache_classes_tags_returns_the_same_class
|
||||
original_cache_setting = Liquid.cache_classes
|
||||
Liquid.cache_classes = true
|
||||
|
||||
original_klass = Class.new
|
||||
Object.send(:const_set, :CustomTag, original_klass)
|
||||
Template.register_tag('custom', CustomTag)
|
||||
|
||||
Object.send(:remove_const, :CustomTag)
|
||||
|
||||
new_klass = Class.new
|
||||
Object.send(:const_set, :CustomTag, new_klass)
|
||||
|
||||
assert(Template.tags['custom'].equal?(original_klass))
|
||||
ensure
|
||||
Object.send(:remove_const, :CustomTag)
|
||||
Liquid.cache_classes = original_cache_setting
|
||||
end
|
||||
|
||||
def test_without_cache_classes_tags_reloads_the_class
|
||||
original_cache_setting = Liquid.cache_classes
|
||||
Liquid.cache_classes = false
|
||||
|
||||
original_klass = Class.new
|
||||
Object.send(:const_set, :CustomTag, original_klass)
|
||||
with_custom_tag('custom', CustomTag) do
|
||||
Object.send(:remove_const, :CustomTag)
|
||||
|
||||
new_klass = Class.new
|
||||
Object.send(:const_set, :CustomTag, new_klass)
|
||||
|
||||
assert(Template.tags['custom'].equal?(new_klass))
|
||||
end
|
||||
ensure
|
||||
Object.send(:remove_const, :CustomTag)
|
||||
Liquid.cache_classes = original_cache_setting
|
||||
end
|
||||
|
||||
class FakeTag; end
|
||||
|
||||
def test_tags_can_be_looped_over
|
||||
with_custom_tag('fake', FakeTag) do
|
||||
result = Template.tags.map { |name, klass| [name, klass] }
|
||||
assert(result.include?(["fake", "TemplateUnitTest::FakeTag"]))
|
||||
assert(result.include?(["fake", TemplateUnitTest::FakeTag]))
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
Reference in New Issue
Block a user