optionally remove empty nodes from AST

This commit is contained in:
Michael Go
2025-01-07 14:34:49 -04:00
parent 879ec3e288
commit db64a0f0c2
5 changed files with 117 additions and 28 deletions
+15 -2
View File
@@ -59,7 +59,7 @@ module Liquid
end
new_tag = tag.parse(tag_name, markup, tokenizer, parse_context)
next if new_tag.is_a?(Comment)
next if parse_context.omit_blank_nodes && blank_node?(new_tag)
@blank &&= new_tag.blank?
@nodelist << new_tag
@@ -157,7 +157,7 @@ module Liquid
end
new_tag = tag.parse(tag_name, markup, tokenizer, parse_context)
next if new_tag.is_a?(Comment)
next if parse_context.omit_blank_nodes && blank_node?(new_tag)
@blank &&= new_tag.blank?
@nodelist << new_tag
@@ -275,5 +275,18 @@ module Liquid
def raise_missing_variable_terminator(token, parse_context)
BlockBody.raise_missing_variable_terminator(token, parse_context)
end
def blank_node?(node)
case node
when Comment
true
when BlockBody
true if node.nodelist.empty?
when Tag
node.nodelist.all? { |n| blank_node?(n) }
else
false
end
end
end
end
+5 -1
View File
@@ -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, :omit_blank_nodes
def initialize(options = Const::EMPTY_HASH)
@environment = options.fetch(:environment, Environment.default)
@@ -12,6 +12,10 @@ module Liquid
@locale = @template_options[:locale] ||= I18n.new
@warnings = []
# remove blank nodes such as
# comment tags, empty if tags, etc from the AST
@omit_blank_nodes = options.fetch(:omit_blank_nodes, false)
self.depth = 0
self.partial = false
end
-1
View File
@@ -1,4 +1,3 @@
<div id="page" class="innerpage clearfix">
<div id="text-page">
<div class="entry">
+97 -2
View File
@@ -49,12 +49,107 @@ class BlockUnitTest < Minitest::Test
def test_with_block
template = Liquid::Template.parse(" {% comment %} {% endcomment %} ")
assert_equal([String, String], block_types(template.root.nodelist))
assert_equal(2, template.root.nodelist.size)
assert_equal([String, Comment, String], block_types(template.root.nodelist))
assert_equal(3, template.root.nodelist.size)
end
def test_remove_empty_for_blocks_with_optimization_option
source = <<~LIQUID.chomp
{% for i in (1..1000000) %}
{% endfor %}
LIQUID
assert_root_nodelist_size(source, 0, omit_blank_nodes: true)
source = <<~LIQUID.chomp
{% for i in (1..1000000) %}
{% else %}
{% endfor %}
LIQUID
assert_root_nodelist_size(source, 0, omit_blank_nodes: true)
source = <<~LIQUID.chomp
{% for i in list %}
i
{% endfor %}
LIQUID
assert_root_nodelist_size(source, 1, omit_blank_nodes: true)
source = <<~LIQUID.chomp
{% for i in list %}
{% else %}
1
{% endfor %}
LIQUID
assert_root_nodelist_size(source, 1, omit_blank_nodes: true)
end
def test_remove_comment_nodes_with_optimization_option
source = <<~LIQUID.chomp
{% comment %}
{% if true %}
{% endif %}
{% endcomment %}
LIQUID
assert_root_nodelist_size(source, 0, omit_blank_nodes: true)
source = <<~LIQUID.chomp
{% liquid
comment
if true
endif
endcomment
%}
LIQUID
assert_root_nodelist_size(source, 0, omit_blank_nodes: true)
end
def test_remove_if_nodes_with_optimization_option
source = <<~LIQUID.chomp
{% if true %}
{% endif %}
LIQUID
assert_root_nodelist_size(source, 0, omit_blank_nodes: true)
source = <<~LIQUID.chomp
{% unless true %}
{% endunless %}
LIQUID
assert_root_nodelist_size(source, 0, omit_blank_nodes: true)
source = <<~LIQUID.chomp
{% if false %}
{% else %}
{% endif %}
LIQUID
assert_root_nodelist_size(source, 0, omit_blank_nodes: true)
source = <<~LIQUID.chomp
{% if false %}
{% else %}
Hello!
{% endif %}
LIQUID
assert_root_nodelist_size(source, 1, omit_blank_nodes: true)
end
private
def assert_root_nodelist_size(source, expected_size, parse_options = {})
template = Liquid::Template.parse(source, parse_options)
assert_equal(expected_size, template.root.nodelist.size)
end
def block_types(nodelist)
nodelist.collect(&:class)
end
-22
View File
@@ -199,26 +199,4 @@ class CommentTagUnitTest < Minitest::Test
World!
LIQUID
end
def test_comment_tag_node_is_not_in_nodelist
template = Liquid::Template.parse(<<~LIQUID.chomp)
{% comment %}
{% if true %}
{% endif %}
{% endcomment %}
LIQUID
assert_equal(0, template.root.nodelist.size)
template = Liquid::Template.parse(<<~LIQUID.chomp)
{% liquid
comment
if true
endif
endcomment
%}
LIQUID
assert_equal(0, template.root.nodelist.size)
end
end