Drop support for Ruby 2.6 and 2.7

Add `#` inline comment tag.

.github/workflows/liquid.yml

@@ -6,12 +6,12 @@ jobs:
     strategy:
       matrix:
         entry:
-          - { ruby: 2.5, allowed-failure: false } # minimum supported
+          - { ruby: 2.7, allowed-failure: false } # minimum supported
           - { ruby: 3.1, allowed-failure: false } # latest
           - { ruby: ruby-head, allowed-failure: true }
     name: test (${{ matrix.entry.ruby }})
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.entry.ruby }}
@@ -26,7 +26,7 @@ jobs:
   memory_profile:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7

History.md

@@ -1,9 +1,25 @@
 # Liquid Change Log
 
-## 5.3.0 (unreleased)
+## 5.4.0 (unreleased)
+
+### Breaking Changes
+* Require Ruby >= 2.7 (#TBC) [Andy Waite]
+
+### Features
+* Allow `#` to be used as an inline comment tag (#1498) [CP Clermont]
+
+### Fixes
+* `PartialCache` now shares snippet cache with subcontexts by default (#1553) [Chris AtLee]
+* Hash registers no longer leak into subcontexts as static registers (#1564) [Chris AtLee]
+
+### Changed
+* Liquid::Context#registers now always returns a Liquid::StaticRegisters object, though supports the most used Hash functions for compatibility (#1553)
+
+## 5.3.0 2022-03-22
 
 ### Fixes
 * StandardFilter: Fix missing @context on iterations (#1525) [Thierry Joyal]
+* Fix warning about block and default value in `static_registers.rb` (#1531) [Peter Zhu]
 
 ### Deprecation
 * Condition#evaluate to require mandatory context argument in Liquid 6.0.0 (#1527) [Thierry Joyal]

README.md

@@ -63,13 +63,13 @@ when templates are invalid. You can enable this new parser like this:
 
 ```ruby
 Liquid::Template.error_mode = :strict # Raises a SyntaxError when invalid syntax is used
-Liquid::Template.error_mode = :warn # Adds errors to template.errors but continues as normal
+Liquid::Template.error_mode = :warn # Adds strict errors to template.errors but continues as normal
 Liquid::Template.error_mode = :lax # The default mode, accepts almost anything.
 ```
 
 If you want to set the error mode only on specific templates you can pass `:error_mode` as an option to `parse`:
 ```ruby
-Liquid::Template.parse(source, :error_mode => :strict)
+Liquid::Template.parse(source, error_mode: :strict)
 ```
 This is useful for doing things like enabling strict mode only in the theme editor.
 

lib/liquid.rb

@@ -29,6 +29,7 @@ module Liquid
   WhitespaceControl           = '-'
   TagStart                    = /\{\%/
   TagEnd                      = /\%\}/
+  TagName                     = /#|\w+/
   VariableSignature           = /\(?[\w\-\.\[\]]\)?/
   VariableSegment             = /[\w\-]/
   VariableStart               = /\{\{/

lib/liquid/block_body.rb

@@ -4,8 +4,8 @@ require 'English'
 
 module Liquid
   class BlockBody
-    LiquidTagToken      = /\A\s*(\w+)\s*(.*?)\z/o
-    FullToken           = /\A#{TagStart}#{WhitespaceControl}?(\s*)(\w+)(\s*)(.*?)#{WhitespaceControl}?#{TagEnd}\z/om
+    LiquidTagToken      = /\A\s*(#{TagName})\s*(.*?)\z/o
+    FullToken           = /\A#{TagStart}#{WhitespaceControl}?(\s*)(#{TagName})(\s*)(.*?)#{WhitespaceControl}?#{TagEnd}\z/om
     ContentOfVariable   = /\A#{VariableStart}#{WhitespaceControl}?(.*?)#{WhitespaceControl}?#{VariableEnd}\z/om
     WhitespaceOrNothing = /\A\s*\z/
     TAGSTART            = "{%"
@@ -37,7 +37,7 @@ module Liquid
 
     private def parse_for_liquid_tag(tokenizer, parse_context)
       while (token = tokenizer.shift)
-        unless token.empty? || token =~ WhitespaceOrNothing
+        unless token.empty? || token.match?(WhitespaceOrNothing)
           unless token =~ LiquidTagToken
             # line isn't empty but didn't match tag syntax, yield and let the
             # caller raise a syntax error
@@ -150,7 +150,7 @@ module Liquid
           end
           parse_context.trim_whitespace = false
           @nodelist << token
-          @blank &&= !!(token =~ WhitespaceOrNothing)
+          @blank &&= token.match?(WhitespaceOrNothing)
         end
         parse_context.line_number = tokenizer.line_number
       end

lib/liquid/context.rb

@@ -28,7 +28,7 @@ module Liquid
 
       @static_environments = [static_environments].flat_map(&:freeze).freeze
       @scopes              = [(outer_scope || {})]
-      @registers           = registers
+      @registers           = registers.is_a?(StaticRegisters) ? registers : StaticRegisters.new(registers)
       @errors              = []
       @partial             = false
       @strict_variables    = false
@@ -39,6 +39,10 @@ module Liquid
       @global_filter       = nil
       @disabled_tags       = {}
 
+      @registers.static[:cached_partials] ||= {}
+      @registers.static[:file_system] ||= Liquid::Template.file_system
+      @registers.static[:template_factory] ||= Liquid::TemplateFactory.new
+
       self.exception_renderer = Template.default_exception_renderer
       if rethrow_errors
         self.exception_renderer = Liquid::RAISE_EXCEPTION_LAMBDA

lib/liquid/locales/en.yml

@@ -13,15 +13,16 @@
       for_invalid_attribute: "Invalid attribute in for loop. Valid attributes are limit and offset"
       if: "Syntax Error in tag 'if' - Valid syntax: if [expression]"
       include: "Error in tag 'include' - Valid syntax: include '[template]' (with|for) [object|collection]"
-      unknown_tag: "Unknown tag '%{tag}'"
+      inline_comment_invalid: "Syntax error in tag '#' - Each line of comments must be prefixed by the '#' character"
       invalid_delimiter: "'%{tag}' is not a valid delimiter for %{block_name} tags. use %{block_delimiter}"
+      render: "Syntax error in tag 'render' - Template name must be a quoted string"
+      table_row: "Syntax Error in 'table_row loop' - Valid syntax: table_row [item] in [collection] cols=3"
+      tag_never_closed: "'%{block_name}' tag was never closed"
+      tag_termination: "Tag '%{token}' was not properly terminated with regexp: %{tag_end}"
       unexpected_else: "%{block_name} tag does not expect 'else' tag"
       unexpected_outer_tag: "Unexpected outer '%{tag}' tag"
-      tag_termination: "Tag '%{token}' was not properly terminated with regexp: %{tag_end}"
+      unknown_tag: "Unknown tag '%{tag}'"
       variable_termination: "Variable '%{token}' was not properly terminated with regexp: %{tag_end}"
-      tag_never_closed: "'%{block_name}' tag was never closed"
-      table_row: "Syntax Error in 'table_row loop' - Valid syntax: table_row [item] in [collection] cols=3"
-      render: "Syntax error in tag 'render' - Template name must be a quoted string"
     argument:
       include: "Argument error in tag 'include' - Illegal template name"
     disabled:

lib/liquid/partial_cache.rb

@@ -3,16 +3,16 @@
 module Liquid
   class PartialCache
     def self.load(template_name, context:, parse_context:)
-      cached_partials = (context.registers[:cached_partials] ||= {})
+      cached_partials = context.registers[:cached_partials]
       cached = cached_partials[template_name]
       return cached if cached
 
-      file_system = (context.registers[:file_system] ||= Liquid::Template.file_system)
+      file_system = context.registers[:file_system]
       source      = file_system.read_template_file(template_name)
 
       parse_context.partial = true
 
-      template_factory = (context.registers[:template_factory] ||= Liquid::TemplateFactory.new)
+      template_factory = context.registers[:template_factory]
       template = template_factory.for(template_name)
 
       partial = template.parse(source, parse_context)

lib/liquid/standardfilters.rb

@@ -95,32 +95,7 @@ module Liquid
       end
     end
 
-    # @public_docs
-    # @type filter
-    # @category string
-    # @summary
-    #   Truncates a string down to a specified number of characters.
-    # @description
-    #   Truncates a string down to a specified number of characters. By default, an ellipsis (`...`) 
-    #   is appended to the truncated string.
-    #
-    #   > Tip:
-    #   > The number of characters in both default and custom ellipses is included in the 
-    #   > character count for the truncated string. For example, if you want to truncate a string 
-    #   > down to ten characters and use the default ellipsis (`...`), then you should set the 
-    #   > character count parameter to `13`. 
-    #
-    #   ### Custom ellipsis
-    #
-    #   The `truncate` filter accepts an optional parameter to specify a custom ellipsis to be 
-    #   appended to the truncated string.
-    #
-    #   ### No ellipsis
-    #
-    #   If you don't want an ellipsis appended to your truncated string, then you can set the 
-    #   ellipsis parameter to a blank string (`''`).
-    # @syntax {{ string | truncate: character_count, ellipsis }}
-    # @return string
+    # Truncate a string down to x characters
     def truncate(input, length = 50, truncate_string = "...")
       return if input.nil?
       input_str = input.to_s
@@ -134,26 +109,6 @@ module Liquid
       input_str.length > length ? input_str[0...l].concat(truncate_string_str) : input_str
     end
 
-    # @public_docs
-    # @type filter
-    # @category string
-    # @summary
-    #   Truncates a string down to a specified number of words.
-    # @description
-    #   Truncates a string down to a specified number of words. By default, an ellipsis (`...`) 
-    #   is appended to the truncated string.
-    #
-    #   ### Custom ellipsis
-    #
-    #   The `truncate` filter accepts an optional parameter to specify a custom ellipsis to be 
-    #   appended to the truncated string.
-    #
-    #   ### No ellipsis
-    #
-    #   If you don't want an ellipsis appended to your truncated string, then you can set the 
-    #   ellipsis parameter to a blank string (`''`).
-    # @syntax {{ string | truncatewords: word_count, ellipsis }}
-    # @return string
     def truncatewords(input, words = 15, truncate_string = "...")
       return if input.nil?
       input = input.to_s
@@ -182,54 +137,18 @@ module Liquid
       input.to_s.split(pattern.to_s)
     end
 
-    # @public_docs
-    # @type filter
-    # @category string
-    # @summary
-    #   Strips all whitespace, such as tabs, spaces, and newlines, from the left and right sides of a string.
-    # @description
-    #   Strips all whitespace, such as tabs, spaces, and newlines, from the left and right sides of a string.
-    # @syntax {{ string | strip }}
-    # @return string
     def strip(input)
       input.to_s.strip
     end
 
-    # @public_docs
-    # @type filter
-    # @category string
-    # @summary
-    #   Strips all whitespace, such as tabs, spaces, and newlines, from the left side of a string.
-    # @description
-    #   Strips all whitespace, such as tabs, spaces, and newlines, from the left side of a string.
-    # @syntax {{ string | lstrip }}
-    # @return string
     def lstrip(input)
       input.to_s.lstrip
     end
 
-    # @public_docs
-    # @type filter
-    # @category string
-    # @summary
-    #   Strips all whitespace, such as tabs, spaces, and newlines, from the right side of a string.
-    # @description
-    #   Strips all whitespace, such as tabs, spaces, and newlines, from the right side of a string.
-    # @syntax {{ string | rstrip }}
-    # @return string
     def rstrip(input)
       input.to_s.rstrip
     end
 
-    # @public_docs
-    # @type filter
-    # @category string
-    # @summary
-    #   Strips all HTML tags from a string.
-    # @description
-    #   Strips all HTML tags from a string.
-    # @syntax {{ string | strip_html }}
-    # @return string
     def strip_html(input)
       empty  = ''
       result = input.to_s.gsub(STRIP_HTML_BLOCKS, empty)
@@ -237,15 +156,7 @@ module Liquid
       result
     end
 
-    # @public_docs
-    # @type filter
-    # @category string
-    # @summary
-    #   Strips all line breaks and newlines from a string.
-    # @description
-    #   Strips all line breaks and newlines from a string.
-    # @syntax {{ string | strip_newlines }}
-    # @return string
+    # Remove all newlines from the string
     def strip_newlines(input)
       input.to_s.gsub(/\r?\n/, '')
     end

lib/liquid/tags/inline_comment.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Liquid
+  class InlineComment < Tag
+    def initialize(tag_name, markup, options)
+      super
+
+      # Semantically, a comment should only ignore everything after it on the line.
+      # Currently, this implementation doesn't support mixing a comment with another tag
+      # but we need to reserve future support for this and prevent the introduction
+      # of inline comments from being backward incompatible change.
+      #
+      # As such, we're forcing users to put a # symbol on every line otherwise this
+      # tag will throw an error.
+      if markup.match?(/\n\s*[^#\s]/)
+        raise SyntaxError, options[:locale].t("errors.syntax.inline_comment_invalid")
+      end
+    end
+
+    def render_to_output_buffer(_context, output)
+      output
+    end
+
+    def blank?
+      true
+    end
+  end
+
+  Template.register_tag('#', InlineComment)
+end

lib/liquid/tags/render.rb

@@ -34,9 +34,9 @@ module Liquid
     end
 
     def render_tag(context, output)
-      # Though we evaluate this here we will only ever parse it as a string literal.
-      template_name = context.evaluate(@template_name_expr)
-      raise ArgumentError, options[:locale].t("errors.argument.include") unless template_name
+      # The expression should be a String literal, which parses to a String object
+      template_name = @template_name_expr
+      raise ::ArgumentError unless template_name.is_a?(String)
 
       partial = PartialCache.load(
         template_name,

lib/liquid/template.rb

@@ -167,15 +167,14 @@ module Liquid
 
       output = nil
 
-      context_register = context.registers.is_a?(StaticRegisters) ? context.registers.static : context.registers
-
       case args.last
       when Hash
         options = args.pop
         output  = options[:output] if options[:output]
+        static_registers = context.registers.static
 
         options[:registers]&.each do |key, register|
-          context_register[key] = register
+          static_registers[key] = register
         end
 
         apply_options_to_context(context, options)

lib/liquid/variable_lookup.rb

@@ -2,8 +2,7 @@
 
 module Liquid
   class VariableLookup
-    SQUARE_BRACKETED = /\A\[(.*)\]\z/m
-    COMMAND_METHODS  = ['size', 'first', 'last'].freeze
+    COMMAND_METHODS = ['size', 'first', 'last'].freeze
 
     attr_reader :name, :lookups
 
@@ -15,8 +14,8 @@ module Liquid
       lookups = markup.scan(VariableParser)
 
       name = lookups.shift
-      if name =~ SQUARE_BRACKETED
-        name = Expression.parse(Regexp.last_match(1))
+      if name&.start_with?('[') && name&.end_with?(']')
+        name = Expression.parse(name[1..-2])
       end
       @name = name
 
@@ -25,8 +24,8 @@ module Liquid
 
       @lookups.each_index do |i|
         lookup = lookups[i]
-        if lookup =~ SQUARE_BRACKETED
-          lookups[i] = Expression.parse(Regexp.last_match(1))
+        if lookup&.start_with?('[') && lookup&.end_with?(']')
+          lookups[i] = Expression.parse(lookup[1..-2])
         elsif COMMAND_METHODS.include?(lookup)
           @command_flags |= 1 << i
         end

lib/liquid/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Liquid
-  VERSION = "5.3.0.alpha"
+  VERSION = "5.4.0.alpha"
 end

liquid.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   # s.description = "A secure, non-evaling end user template engine with aesthetic markup."
 
-  s.required_ruby_version     = ">= 2.5.0"
+  s.required_ruby_version     = ">= 2.7.0"
   s.required_rubygems_version = ">= 1.3.7"
 
   s.metadata['allowed_push_host'] = 'https://rubygems.org'

performance/theme_runner.rb

@@ -3,7 +3,7 @@
 # This profiler run simulates Shopify.
 # We are looking in the tests directory for liquid files and render them within the designated layout file.
 # We will also export a substantial database to liquid which the templates can render values of.
-# All this is to make the benchmark as non syntetic as possible. All templates and tests are lifted from
+# All this is to make the benchmark as non synthetic as possible. All templates and tests are lifted from
 # direct real-world usage and the profiler measures code that looks very similar to the way it looks in
 # Shopify which is likely the biggest user of liquid in the world which something to the tune of several
 # million Template#render calls a day.

test/integration/context_test.rb

@@ -618,6 +618,20 @@ class ContextTest < Minitest::Test
     end
   end
 
+  def test_context_always_uses_static_registers
+    registers = {
+      my_register: :my_value,
+    }
+    c = Context.new({}, {}, registers)
+    assert_instance_of(StaticRegisters, c.registers)
+    assert_equal(:my_value, c.registers[:my_register])
+
+    r = StaticRegisters.new(registers)
+    c = Context.new({}, {}, r)
+    assert_instance_of(StaticRegisters, c.registers)
+    assert_equal(:my_value, c.registers[:my_register])
+  end
+
   private
 
   def assert_no_object_allocations

test/integration/standard_filter_test.rb

@@ -32,7 +32,7 @@ class TestDrop < Liquid::Drop
   attr_reader :value
 
   def registers
-    @context.registers
+    { @value => @context.registers[@value] }
   end
 end
 
@@ -440,7 +440,7 @@ class StandardFiltersTest < Minitest::Test
   end
 
   def test_map_calls_context=
-    model = TestModel.new(value: "test")
+    model = TestModel.new(value: :test)
 
     template = Template.parse('{{ foo | map: "registers" }}')
     template.registers[:test] = 1234

test/integration/tags/inline_comment_test.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class InlineCommentTest < Minitest::Test
+  include Liquid
+
+  def test_inline_comment_returns_nothing
+    assert_template_result('', '{%- # this is an inline comment -%}')
+    assert_template_result('', '{%-# this is an inline comment -%}')
+    assert_template_result('', '{% # this is an inline comment %}')
+    assert_template_result('', '{%# this is an inline comment %}')
+  end
+
+  def test_inline_comment_does_not_require_a_space_after_the_pound_sign
+    assert_template_result('', '{%#this is an inline comment%}')
+  end
+
+  def test_liquid_inline_comment_returns_nothing
+    assert_template_result('Hey there, how are you doing today?', <<~LIQUID)
+      {%- liquid
+        # This is how you'd write a block comment in a liquid tag.
+        # It looks a lot like what you'd have in ruby.
+
+        # You can use it as inline documentation in your
+        # liquid blocks to explain why you're doing something.
+        echo "Hey there, "
+
+        # It won't affect the output.
+        echo "how are you doing today?"
+      -%}
+    LIQUID
+  end
+
+  def test_inline_comment_can_be_written_on_multiple_lines
+    assert_template_result('', <<~LIQUID)
+      {%-
+        # That kind of block comment is also allowed.
+        # It would only be a stylistic difference.
+
+        # Much like JavaScript's /* */ comments and their
+        # leading * on new lines.
+      -%}
+    LIQUID
+  end
+
+  def test_inline_comment_multiple_pound_signs
+    assert_template_result('', <<~LIQUID)
+      {%- liquid
+        ######################################
+        # We support comments like this too. #
+        ######################################
+      -%}
+    LIQUID
+  end
+
+  def test_inline_comments_require_the_pound_sign_on_every_new_line
+    assert_match_syntax_error("Each line of comments must be prefixed by the '#' character", <<~LIQUID)
+      {%-
+        # some comment
+        echo 'hello world'
+      -%}
+    LIQUID
+  end
+
+  def test_inline_comment_does_not_support_nested_tags
+    assert_template_result(' -%}', "{%- # {% echo 'hello world' %} -%}")
+  end
+end

test/unit/partial_cache_unit_test.rb

@@ -125,4 +125,35 @@ class PartialCacheUnitTest < Minitest::Test
     assert_equal('my partial body', partial.render)
     assert_equal(1, template_factory.count)
   end
+
+  def test_cache_state_is_shared_for_subcontexts
+    parse_context      = Liquid::ParseContext.new
+    shared_file_system = StubFileSystem.new(
+      'my_partial' => 'my shared value'
+    )
+    context = Liquid::Context.build(
+      registers: Liquid::StaticRegisters.new(
+        file_system: shared_file_system,
+      )
+    )
+    subcontext = context.new_isolated_subcontext
+
+    assert_equal(subcontext.registers[:cached_partials].object_id, context.registers[:cached_partials].object_id)
+
+    2.times do
+      Liquid::PartialCache.load(
+        'my_partial',
+        context: context,
+        parse_context: parse_context
+      )
+
+      Liquid::PartialCache.load(
+        'my_partial',
+        context: subcontext,
+        parse_context: parse_context
+      )
+    end
+
+    assert_equal(1, shared_file_system.file_read_count)
+  end
 end