liquid 5.9.0 → 5.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 112da43191fdf32af9afb1ad6322ff2fab8b22b6d658073980ba236aa1834213
-  data.tar.gz: b7ab5c91bc2f65b91a782027eedd8374f1f46629c791d6b2c07a8ba2c07d7314
+  metadata.gz: 1b12ad70375f0ed9e3a2bab4a0a53ea565f3082af8d5bc06f4dea13a0a4ac574
+  data.tar.gz: 04c2f7494b1ab0f97a2a33ad9d39c9c573a33b42bd109df8d42bb5e26d245f01
 SHA512:
-  metadata.gz: c941dc92d57cf97c30a6db6eb206e7f00b780070b8dc790def3a8be06a3714562813b0ca8da34d5745be4432c839cf2f5946557d103ae0e56ffe5822b4ebf1e6
-  data.tar.gz: 9491a34a69273c3cebe65208f935007e68dbd81a8b32913ebc7d0056863c9f3a30b6dff9d1da3b37af66e472aedf60c6979e22d5f500ba6d24bd4f8637449a3f
+  metadata.gz: dc94bd83ae20e716eabf8ab2ce9f1fe9f8ff45dee6e0acac91f9095c32557c94d08e5a3c1b473c268c5a6a6d63a4d4ca10170406f062545545f63c1980a4d392
+  data.tar.gz: 0f19c1d79039fda7a6e485cf794cde252817dc43bd292351b7bc53d1adabd12919e18cc0870fcf3db3c0018e22ef91a1507ded76b27719fb30b79414e04d3d2f

data/History.md

@@ -1,5 +1,14 @@
 # Liquid Change Log
 
+## 5.10.0
+* Introduce support for Inline Snippets [Julia Boutin]
+  ```
+  {%- snippet snowdevil -%}
+    Snowdevil
+  {%- endsnippet -%}
+  {% render snowdevil %}
+  ```
+
 ## 5.9.0
 * Introduce `:rigid` error mode for stricter, safer parsing of all tags [CP Clermont, Guilherme Carreiro]
 

data/lib/liquid/locales/en.yml

@@ -5,6 +5,7 @@
       block_tag_unexpected_args: "Syntax Error in '%{tag}' - Valid syntax: {% %{tag} %}{% end%{tag} %}"
       assign: "Syntax Error in 'assign' - Valid syntax: assign [var] = [source]"
       capture: "Syntax Error in 'capture' - Valid syntax: capture [var]"
+      snippet: "Syntax Error in 'snippet' - Valid syntax: snippet [var]"
       case: "Syntax Error in 'case' - Valid syntax: case [condition]"
       case_invalid_when: "Syntax Error in tag 'case' - Valid when condition: {% when [condition] [or condition2...] %}"
       case_invalid_else: "Syntax Error in tag 'case' - Valid else condition: {% else %} (no parameters) "
@@ -19,6 +20,7 @@
       invalid_delimiter: "'%{tag}' is not a valid delimiter for %{block_name} tags. use %{block_delimiter}"
       invalid_template_encoding: "Invalid template encoding"
       render: "Syntax error in tag 'render' - Template name must be a quoted string"
+      render_invalid_template_name: "Syntax error in tag 'render' - Expected a string or identifier, found %{found}"
       table_row: "Syntax Error in 'table_row loop' - Valid syntax: table_row [item] in [collection] cols=3"
       table_row_invalid_attribute: "Invalid attribute '%{attribute}' in tablerow loop. Valid attributes are cols, limit, offset, and range"
       tag_never_closed: "'%{block_name}' tag was never closed"
@@ -29,5 +31,6 @@
       variable_termination: "Variable '%{token}' was not properly terminated with regexp: %{tag_end}"
     argument:
       include: "Argument error in tag 'include' - Illegal template name"
+      render: "Argument error in tag 'render' - Dynamically chosen templates are not allowed"
     disabled:
       tag: "usage is not allowed in this context"

data/lib/liquid/snippet_drop.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Liquid
+  class SnippetDrop < Drop
+    attr_reader :body, :name, :filename
+
+    def initialize(body, name, filename)
+      super()
+      @body = body
+      @name = name
+      @filename = filename
+    end
+
+    def to_partial
+      @body
+    end
+
+    def to_s
+      'SnippetDrop'
+    end
+  end
+end

data/lib/liquid/tags/render.rb

@@ -27,7 +27,7 @@ module Liquid
   # @liquid_syntax_keyword filename The name of the snippet to render, without the `.liquid` extension.
   class Render < Tag
     FOR = 'for'
-    SYNTAX = /(#{QuotedString}+)(\s+(with|#{FOR})\s+(#{QuotedFragment}+))?(\s+(?:as)\s+(#{VariableSegment}+))?/o
+    SYNTAX = /(#{QuotedString}+|#{VariableSegment}+)(\s+(with|#{FOR})\s+(#{QuotedFragment}+))?(\s+(?:as)\s+(#{VariableSegment}+))?/o
 
     disable_tags "include"
 
@@ -47,21 +47,23 @@ module Liquid
     end
 
     def render_tag(context, output)
-      # 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,
-        context: context,
-        parse_context: parse_context,
-      )
-
-      context_variable_name = @alias_name || template_name.split('/').last
+      template = context.evaluate(@template_name_expr)
+
+      if template.respond_to?(:to_partial)
+        partial = template.to_partial
+        template_name = template.filename
+        context_variable_name = @alias_name || template.name
+      elsif @template_name_expr.is_a?(String)
+        partial = PartialCache.load(template, context: context, parse_context: parse_context)
+        template_name = partial.name
+        context_variable_name = @alias_name || template_name.split('/').last
+      else
+        raise ::ArgumentError
+      end
 
       render_partial_func = ->(var, forloop) {
         inner_context               = context.new_isolated_subcontext
-        inner_context.template_name = partial.name
+        inner_context.template_name = template_name
         inner_context.partial       = true
         inner_context['forloop']    = forloop if forloop
 
@@ -101,14 +103,18 @@ module Liquid
         key = p.consume
         p.consume(:colon)
         @attributes[key] = safe_parse_expression(p)
-        p.consume?(:comma)
+        p.consume?(:comma) # optional comma
       end
 
       p.consume(:end_of_string)
     end
 
     def rigid_template_name(p)
-      p.consume(:string)
+      return p.consume(:string) if p.look(:string)
+      return p.consume(:id) if p.look(:id)
+
+      found = p.consume || "nothing"
+      raise SyntaxError, options[:locale].t("errors.syntax.render_invalid_template_name", found: found)
     end
 
     def strict_parse(markup)

data/lib/liquid/tags/snippet.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Liquid
+  # @liquid_public_docs
+  # @liquid_type tag
+  # @liquid_category variable
+  # @liquid_name snippet
+  # @liquid_summary
+  #   Creates a new inline snippet.
+  # @liquid_description
+  #   You can create inline snippets to make your Liquid code more modular.
+  # @liquid_syntax
+  #   {% snippet snippet_name %}
+  #     value
+  #   {% endsnippet %}
+  class Snippet < Block
+    def initialize(tag_name, markup, options)
+      super
+      p = @parse_context.new_parser(markup)
+      if p.look(:id)
+        @to = p.consume(:id)
+        p.consume(:end_of_string)
+      else
+        raise SyntaxError, options[:locale].t("errors.syntax.snippet")
+      end
+    end
+
+    def render_to_output_buffer(context, output)
+      snippet_drop = SnippetDrop.new(@body, @to, context.template_name)
+      context.scopes.last[@to] = snippet_drop
+      context.resource_limits.increment_assign_score(assign_score_of(snippet_drop))
+      output
+    end
+
+    def blank?
+      true
+    end
+
+    private
+
+    def assign_score_of(snippet_drop)
+      snippet_drop.body.nodelist.sum { |node| node.to_s.bytesize }
+    end
+  end
+end

data/lib/liquid/tags.rb

@@ -20,6 +20,7 @@ require_relative "tags/raw"
 require_relative "tags/render"
 require_relative "tags/cycle"
 require_relative "tags/doc"
+require_relative "tags/snippet"
 
 module Liquid
   module Tags
@@ -44,6 +45,7 @@ module Liquid
       'echo' => Echo,
       'tablerow' => TableRow,
       'doc' => Doc,
+      'snippet' => Snippet,
     }.freeze
   end
 end

data/lib/liquid/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Liquid
-  VERSION = "5.9.0"
+  VERSION = "5.10.0"
 end

data/lib/liquid.rb

@@ -67,6 +67,7 @@ require 'liquid/i18n'
 require 'liquid/drop'
 require 'liquid/tablerowloop_drop'
 require 'liquid/forloop_drop'
+require 'liquid/snippet_drop'
 require 'liquid/extensions'
 require 'liquid/errors'
 require 'liquid/interrupts'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: liquid
 version: !ruby/object:Gem::Version
-  version: 5.9.0
+  version: 5.10.0
 platform: ruby
 authors:
 - Tobias Lütke
@@ -105,6 +105,7 @@ files:
 - lib/liquid/range_lookup.rb
 - lib/liquid/registers.rb
 - lib/liquid/resource_limits.rb
+- lib/liquid/snippet_drop.rb
 - lib/liquid/standardfilters.rb
 - lib/liquid/strainer_template.rb
 - lib/liquid/tablerowloop_drop.rb
@@ -130,6 +131,7 @@ files:
 - lib/liquid/tags/inline_comment.rb
 - lib/liquid/tags/raw.rb
 - lib/liquid/tags/render.rb
+- lib/liquid/tags/snippet.rb
 - lib/liquid/tags/table_row.rb
 - lib/liquid/tags/unless.rb
 - lib/liquid/template.rb