liquid2 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a68d0ef0f934b9b4fd68d99591e5b0faf9df0e4d408e35c4df1aa2b7b98f4a1
-  data.tar.gz: 41d881fe5f30b1f390e2c8297e36ca08f6eb70c1b70225f8418ba255f6297759
+  metadata.gz: 474a8dc5c84a97344741bc74d459cc904f1da7025af450c834fb8d416eb98518
+  data.tar.gz: 2dda5436fd261f0208123baa7f7f917f2406531e0bf295db085528a8fa7a5baa
 SHA512:
-  metadata.gz: 53ad1737b2ae742366a0fc26e038c971d18a4f500ce104faac21a94547ac61a9926a5683a5150539e1b968d144b2cb15aa93823db163cbaa07d785b2e9ed3c31
-  data.tar.gz: 25e214ff840aacacb4ffed35160295d8fd7dd04ea301c62aec2a490d4c5d54ba72b73f9a7318b2bc0fb1f8c3ed7eea26a737ba5f8ea182b3a36e44996a8b06f4
+  metadata.gz: 489dd5089b45f07779de0ee25ee4a8fa5b028a8721bf1423a6ca6884ebde6647d36e9e9450e650c2816c1a63a5b6f1554d8e2d8fa7712c106792a3dbeefe0205
+  data.tar.gz: 7b5e904527625b34d0e177168abbd00198f393b303b9504ee68a37cda3a2f1ef7a407333b15dec96907271610ca715f0e08f49c695466f8f7ddff22a1056b6d4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.4.0] - 25-08-11
+
+- Fixed a bug where the parser would raise a `Liquid2::LiquidSyntaxError` if environment arguments `markup_out_end` and `markup_tag_end` where identical. See [#23](https://github.com/jg-rp/ruby-liquid2/issues/23).
+- Added `Liquid2::Environment.persistent_namespaces`. It is an array of symbols indicating which namespaces from `Liquid2::RenderContext.tag_namespaces` should be preserved when calling `Liquid2::RenderContext#copy`. This is important for some tags - like `{% extends %}` - that need to share state with partial templates rendered with `{% render %}`.
+- Added the `auto_trim` argument to `Liquid2::Environment`. `auto_trim` can be `'-'`, `'~'` or `nil` (the default). When not `nil`, it sets the automatic whitespace trimming applied to the left side of template text when no explicit whitespace control is given. `+` is also available as whitespace control in tags, outputs statements and comments. A `+` will ensure no trimming is applied, even if `auto_trim` is set.
+
 ## [0.3.1] - 25-06-24
 
 - Added support for custom markup delimiters. See [#16](https://github.com/jg-rp/ruby-liquid2/pull/16).

data/README.md

@@ -36,7 +36,7 @@ Liquid templates for Ruby, with some extra features.
 Add `'liquid2'` to your Gemfile:
 
 ```
-gem 'liquid2', '~> 0.3.1'
+gem 'liquid2', '~> 0.4.0'
 ```
 
 Or

data/lib/liquid2/context.rb

@@ -219,8 +219,10 @@ module Liquid2
                                loop_carry: loop_carry,
                                local_namespace_carry: @assign_score)
 
-      # XXX: bit of a hack
-      context.tag_namespace[:extends] = @tag_namespace[:extends]
+      @env.persistent_namespaces.each do |ns|
+        context.tag_namespace[ns] = @tag_namespace[ns] if @tag_namespace[ns]
+      end
+
       context
     end
 

data/lib/liquid2/environment.rb

@@ -51,8 +51,14 @@ module Liquid2
                 :re_double_quote_string_special, :re_single_quote_string_special, :re_markup_start,
                 :re_markup_end, :re_markup_end_chars, :re_up_to_markup_start, :re_punctuation,
                 :re_up_to_inline_comment_end, :re_up_to_raw_end, :re_block_comment_chunk,
-                :re_up_to_doc_end, :re_line_statement_comment
-
+                :re_up_to_doc_end, :re_line_statement_comment, :persistent_namespaces,
+                :universal_markup_end
+
+    # @param arithmetic_operators [bool] When `true`, arithmetic operators `+`, `-`, `*`, `/`, `%`
+    #   and `**` are enabled.
+    # @auto_trim ['-' | '~' | nil] Whitespace trimming to apply to the left of text when
+    #   neither `-` or `~` is given for any tag, output statement or comment. The default is
+    #   `nil`, which means no automatic whitespace trimming is applied.
     # @param context_depth_limit [Integer] The maximum number of times a render context can
     #   be extended or copied before a `Liquid2::LiquidResourceLimitError`` is raised.
     # @param globals [Hash[String, untyped]?] Variables that are available to all templates
@@ -91,6 +97,7 @@ module Liquid2
     def initialize(
       arithmetic_operators: false,
       context_depth_limit: 30,
+      auto_trim: nil,
       falsy_undefined: true,
       globals: nil,
       loader: nil,
@@ -117,6 +124,10 @@ module Liquid2
       # keyword argument.
       @filters = {}
 
+      # An array of symbols indicating which namespaces from RenderContext.tag_namespaces
+      # should be preserved when using RenderContext#copy.
+      @persistent_namespaces = [:extends]
+
       # When `true`, arithmetic operators `+`, `-`, `*`, `/`, `%` and `**` are enabled.
       # Defaults to `false`.
       @arithmetic_operators = arithmetic_operators
@@ -125,6 +136,11 @@ module Liquid2
       # a Liquid2::LiquidResourceLimitError is raised.
       @context_depth_limit = context_depth_limit
 
+      # The default whitespace trimming applied to the left of text content when neither
+      # `-` or `~` is specified. Defaults to `nil`, which means no automatic whitespace
+      # trimming.
+      @auto_trim = auto_trim
+
       # Variables that are available to all templates rendered from this environment.
       @globals = globals
 
@@ -185,6 +201,10 @@ module Liquid2
       # The string of characters that indicate the end of a Liquid tag.
       @markup_tag_end = markup_tag_end
 
+      # Indicates if tag and output end delimiters are identical. This is used by the
+      # parser when parsing output statements.
+      @universal_markup_end = markup_tag_end == markup_out_end
+
       # The string of characters that indicate the start of a Liquid comment. This should
       # include a single trailing `#`. Additional, variable length hashes will be handled
       # by the tokenizer. It is not possible to change comment syntax to not use `#`.
@@ -408,7 +428,7 @@ module Liquid2
 
     # Trim _text_.
     def trim(text, left_trim, right_trim)
-      case left_trim
+      case left_trim || @auto_trim
       when "-"
         text.lstrip!
       when "~"

data/lib/liquid2/parser.rb

@@ -43,6 +43,10 @@ module Liquid2
       @pos = 0
       @eof = [:token_eof, nil, length - 1]
       @whitespace_carry = nil
+
+      # If both tags and output statements share the same end delimiter, we expect
+      # `:token_tag_end` to close an output statement as the scanner scans for tags first.
+      @output_end = @env.universal_markup_end ? :token_tag_end : :token_output_end
     end
 
     # Return the current token without advancing the pointer.
@@ -691,7 +695,7 @@ module Liquid2
     def parse_output
       expr = parse_filtered_expression
       carry_whitespace_control
-      eat(:token_output_end)
+      eat(@output_end)
       Output.new(expr.token, expr)
     end
 

data/lib/liquid2/scanner.rb

@@ -240,10 +240,10 @@ module Liquid2
 
       # Miro benchmarks show no performance gain using scan_byte and peek_byte over scan here.
       case @scanner.scan(@re_markup_end)
-      when @s_out_end
-        @tokens << [:token_output_end, nil, @start]
       when @s_tag_end
         @tokens << [:token_tag_end, nil, @start]
+      when @s_out_end
+        @tokens << [:token_output_end, nil, @start]
       else
         # Unexpected token
         return nil if @scanner.eos?
@@ -306,10 +306,10 @@ module Liquid2
       accept_whitespace_control
 
       case @scanner.scan(@re_markup_end)
-      when @s_out_end
-        @tokens << [:token_output_end, nil, @start]
       when @s_tag_end
         @tokens << [:token_tag_end, nil, @start]
+      when @s_out_end
+        @tokens << [:token_output_end, nil, @start]
       else
         # Unexpected token
         return nil if @scanner.eos?
@@ -326,12 +326,12 @@ module Liquid2
       accept_whitespace_control
 
       case @scanner.scan(@re_markup_end)
-      when @s_out_end
-        @tokens << [:token_output_end, nil, @start]
-        @start = @scanner.pos
       when @s_tag_end
         @tokens << [:token_tag_end, nil, @start]
         @start = @scanner.pos
+      when @s_out_end
+        @tokens << [:token_output_end, nil, @start]
+        @start = @scanner.pos
       end
 
       if @scanner.skip_until(@re_up_to_raw_end)
@@ -347,12 +347,12 @@ module Liquid2
       accept_whitespace_control
 
       case @scanner.scan(@re_markup_end)
-      when @s_out_end
-        @tokens << [:token_output_end, nil, @start]
-        @start = @scanner.pos
       when @s_tag_end
         @tokens << [:token_tag_end, nil, @start]
         @start = @scanner.pos
+      when @s_out_end
+        @tokens << [:token_output_end, nil, @start]
+        @start = @scanner.pos
       end
 
       comment_depth = 1
@@ -393,12 +393,12 @@ module Liquid2
       accept_whitespace_control
 
       case @scanner.scan(@re_markup_end)
-      when @s_out_end
-        @tokens << [:token_output_end, nil, @start]
-        @start = @scanner.pos
       when @s_tag_end
         @tokens << [:token_tag_end, nil, @start]
         @start = @scanner.pos
+      when @s_out_end
+        @tokens << [:token_output_end, nil, @start]
+        @start = @scanner.pos
       end
 
       if @scanner.skip_until(@re_up_to_doc_end)
@@ -434,12 +434,12 @@ module Liquid2
       else
         accept_whitespace_control
         case @scanner.scan(@re_markup_end)
-        when @s_out_end
-          @tokens << [:token_output_end, nil, @start]
-          @start = @scanner.pos
         when @s_tag_end
           @tokens << [:token_tag_end, nil, @start]
           @start = @scanner.pos
+        when @s_out_end
+          @tokens << [:token_output_end, nil, @start]
+          @start = @scanner.pos
         end
 
         :lex_markup
@@ -485,12 +485,12 @@ module Liquid2
             @tokens << [:token_tag_end, nil, @start]
             accept_whitespace_control
             case @scanner.scan(@re_markup_end)
-            when @s_out_end
-              @tokens << [:token_output_end, nil, @start]
-              @start = @scanner.pos
             when @s_tag_end
               @tokens << [:token_tag_end, nil, @start]
               @start = @scanner.pos
+            when @s_out_end
+              @tokens << [:token_output_end, nil, @start]
+              @start = @scanner.pos
             end
 
             return :lex_markup

data/lib/liquid2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Liquid2
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/sig/liquid2.rbs

@@ -62,6 +62,8 @@ module Liquid2
     # keyword argument.
     @filters: Hash[String, [_Filter, (Integer | nil)]]
 
+    @persistent_namespaces: Array[Symbol]
+
     @local_namespace_limit: Integer?
 
     @context_depth_limit: Integer
@@ -90,6 +92,8 @@ module Liquid2
 
     @arithmetic_operators: bool
 
+    @auto_trim: '-' | '~' | nil
+
     # The string of characters that indicate the start of a Liquid output statement.
     @markup_out_start: String
 
@@ -102,6 +106,8 @@ module Liquid2
     # The string of characters that indicate the end of a Liquid tag.
     @markup_tag_end: String
 
+    @universal_markup_end: bool
+
     # The string of characters that indicate the start of a Liquid comment. This should
     # include a single trailing `#`. Additional, variable length hashes will be handled
     # by the tokenizer. It is not possible to change comment syntax to not use `#`.
@@ -154,6 +160,8 @@ module Liquid2
 
     attr_reader tags: Hash[String, _Tag]
 
+    attr_reader persistent_namespaces: Array[Symbol]
+
     attr_reader local_namespace_limit: Integer?
 
     attr_reader context_depth_limit: Integer
@@ -184,6 +192,8 @@ module Liquid2
 
     attr_reader markup_tag_start: String
 
+    attr_reader universal_markup_end: bool
+
     attr_reader re_tag_name: Regexp
 
     attr_reader re_word: Regexp
@@ -216,7 +226,7 @@ module Liquid2
 
     attr_reader re_line_statement_comment: Regexp
 
-    def initialize: (?arithmetic_operators: bool, ?context_depth_limit: ::Integer, ?falsy_undefined: bool, ?globals: untyped?, ?loader: TemplateLoader?, ?local_namespace_limit: Integer?, ?loop_iteration_limit: Integer?, ?markup_comment_prefix: ::String, ?markup_comment_suffix: ::String, ?markup_out_end: ::String, ?markup_out_start: ::String, ?markup_tag_end: ::String, ?markup_tag_start: ::String, ?output_stream_limit: Integer?, ?parser: singleton(Parser), ?scanner: singleton(Scanner), ?shorthand_indexes: bool, ?suppress_blank_control_flow_blocks: bool, ?undefined: singleton(Undefined)) -> void
+    def initialize: (?arithmetic_operators: bool, ?context_depth_limit: ::Integer, ?auto_trim: '-' | '~' | nil, ?falsy_undefined: bool, ?globals: untyped?, ?loader: TemplateLoader?, ?local_namespace_limit: Integer?, ?loop_iteration_limit: Integer?, ?markup_comment_prefix: ::String, ?markup_comment_suffix: ::String, ?markup_out_end: ::String, ?markup_out_start: ::String, ?markup_tag_end: ::String, ?markup_tag_start: ::String, ?output_stream_limit: Integer?, ?parser: singleton(Parser), ?scanner: singleton(Scanner), ?shorthand_indexes: bool, ?suppress_blank_control_flow_blocks: bool, ?undefined: singleton(Undefined)) -> void
 
     # @param source [String] template source text.
     # @return [Template]
@@ -387,6 +397,8 @@ module Liquid2
 
     @whitespace_carry: String?
 
+    @output_end: Symbol
+
     # Parse Liquid template text into a syntax tree.
     # @param source [String]
     # @return [Array[Node | String]]
@@ -512,13 +524,13 @@ module Liquid2
 
       MEMBERSHIP: 6
 
-      PREFIX: 7
-
       ADD_SUB: 8
 
       MUL_DIV: 9
       
       POW: 10
+
+      PREFIX: 11
     end
 
     PRECEDENCES: Hash[Symbol, Integer]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: liquid2
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - James Prior