locomotivecms-liquid 2.6.0

data/lib/liquid/tags/case.rb

@@ -0,0 +1,77 @@
+module Liquid
+  class Case < Block
+    Syntax     = /(#{QuotedFragment})/o
+    WhenSyntax = /(#{QuotedFragment})(?:(?:\s+or\s+|\s*\,\s*)(#{QuotedFragment}.*))?/o
+
+
+    def initialize(tag_name, markup, tokens, options)
+      @blocks = []
+
+      if markup =~ Syntax
+        @left = $1
+      else
+        raise SyntaxError.new(options[:locale].t("errors.syntax.case"), options[:line])
+      end
+
+      super
+    end
+
+    def unknown_tag(tag, markup, tokens)
+      @nodelist = []
+      case tag
+      when 'when'
+        record_when_condition(markup)
+      when 'else'
+        record_else_condition(markup)
+      else
+        super
+      end
+    end
+
+    def render(context)
+      context.stack do
+        execute_else_block = true
+
+        output = ''
+        @blocks.each do |block|
+          if block.else?
+            return render_all(block.attachment, context) if execute_else_block
+          elsif block.evaluate(context)
+            execute_else_block = false
+            output << render_all(block.attachment, context)
+          end
+        end
+        output
+      end
+    end
+
+    private
+
+    def record_when_condition(markup)
+      while markup
+        # Create a new nodelist and assign it to the new block
+        if not markup =~ WhenSyntax
+          raise SyntaxError.new(options[:locale].t("errors.syntax.case_invalid_when"), line)
+        end
+
+        markup = $2
+
+        block = Condition.new(@left, '==', $1)
+        block.attach(@nodelist)
+        @blocks.push(block)
+      end
+    end
+
+    def record_else_condition(markup)
+      if not markup.strip.empty?
+        raise SyntaxError.new(options[:locale].t("errors.syntax.case_invalid_else"), line)
+      end
+
+      block = ElseCondition.new
+      block.attach(@nodelist)
+      @blocks << block
+    end
+  end
+
+  Template.register_tag('case', Case)
+end

data/lib/liquid/tags/comment.rb

@@ -0,0 +1,16 @@
+module Liquid
+  class Comment < Block
+    def render(context)
+      ''
+    end
+
+    def unknown_tag(tag, markup, tokens)
+    end
+
+    def blank?
+      true
+    end
+  end
+
+  Template.register_tag('comment', Comment)
+end

data/lib/liquid/tags/continue.rb

@@ -0,0 +1,21 @@
+module Liquid
+
+  # Continue tag to be used to break out of a for loop.
+  #
+  # == Basic Usage:
+  #    {% for item in collection %}
+  #      {% if item.condition %}
+  #        {% continue %}
+  #      {% endif %}
+  #    {% endfor %}
+  #
+  class Continue < Tag
+
+    def interrupt
+      ContinueInterrupt.new
+    end
+
+  end
+
+  Template.register_tag('continue', Continue)
+end

data/lib/liquid/tags/cycle.rb

@@ -0,0 +1,61 @@
+module Liquid
+  # Cycle is usually used within a loop to alternate between values, like colors or DOM classes.
+  #
+  #   {% for item in items %}
+  #     <div class="{% cycle 'red', 'green', 'blue' %}"> {{ item }} </div>
+  #   {% end %}
+  #
+  #    <div class="red"> Item one </div>
+  #    <div class="green"> Item two </div>
+  #    <div class="blue"> Item three </div>
+  #    <div class="red"> Item four </div>
+  #    <div class="green"> Item five</div>
+  #
+  class Cycle < Tag
+    SimpleSyntax = /^#{QuotedFragment}+/o
+    NamedSyntax  = /^(#{QuotedFragment})\s*\:\s*(.*)/o
+
+    def initialize(tag_name, markup, tokens, options)
+      case markup
+      when NamedSyntax
+        @variables = variables_from_string($2)
+        @name = $1
+      when SimpleSyntax
+        @variables = variables_from_string(markup)
+        @name = "'#{@variables.to_s}'"
+      else
+        raise SyntaxError.new(options[:locale].t("errors.syntax.cycle"), options[:line])
+      end
+      super
+    end
+
+    def render(context)
+      context.registers[:cycle] ||= Hash.new(0)
+
+      context.stack do
+        key = context[@name]
+        iteration = context.registers[:cycle][key]
+        result = context[@variables[iteration]]
+        iteration += 1
+        iteration  = 0  if iteration >= @variables.size
+        context.registers[:cycle][key] = iteration
+        result
+      end
+    end
+
+    def blank?
+      false
+    end
+
+    private
+
+    def variables_from_string(markup)
+      markup.split(',').collect do |var|
+        var =~ /\s*(#{QuotedFragment})\s*/o
+        $1 ? $1 : nil
+      end.compact
+    end
+  end
+
+  Template.register_tag('cycle', Cycle)
+end

data/lib/liquid/tags/decrement.rb

@@ -0,0 +1,39 @@
+module Liquid
+
+  # decrement is used in a place where one needs to insert a counter
+  #     into a template, and needs the counter to survive across
+  #     multiple instantiations of the template.
+  #     NOTE: decrement is a pre-decrement, --i,
+  #           while increment is post:      i++.
+  #
+  #     (To achieve the survival, the application must keep the context)
+  #
+  #     if the variable does not exist, it is created with value 0.
+
+  #   Hello: {% decrement variable %}
+  #
+  # gives you:
+  #
+  #    Hello: -1
+  #    Hello: -2
+  #    Hello: -3
+  #
+  class Decrement < Tag
+    def initialize(tag_name, markup, tokens, options)
+      @variable = markup.strip
+
+      super
+    end
+
+    def render(context)
+      value = context.environments.first[@variable] ||= 0
+      value = value - 1
+      context.environments.first[@variable] = value
+      value.to_s
+    end
+
+    private
+  end
+
+  Template.register_tag('decrement', Decrement)
+end

data/lib/liquid/tags/default_content.rb

@@ -0,0 +1,21 @@
+module Liquid
+
+  # InheritedContent pulls out the content from child templates that isnt defined in blocks
+  #
+  #  {% defaultcontent %}
+  #
+  class DefaultContent < Tag
+    def initialize(tag_name, markup, tokens, context)
+      super
+    end
+
+    def render(context)
+      context.stack do
+        "HELLO"
+      end
+    end
+  end
+
+
+  Template.register_tag('defaultcontent', DefaultContent)
+end

data/lib/liquid/tags/extends.rb

@@ -0,0 +1,79 @@
+module Liquid
+
+  # Extends allows designer to use template inheritance
+  #
+  #   {% extends home %}
+  #   {% block content }Hello world{% endblock %}
+  #
+  class Extends < Block
+    Syntax = /(#{QuotedFragment}+)/
+
+    def initialize(tag_name, markup, tokens, options)
+      if markup =~ Syntax
+        @template_name = $1.gsub(/["']/o, '').strip
+      else
+        raise(SyntaxError.new(options[:locale].t("errors.syntax.extends")), options[:line])
+      end
+
+      @options = options
+
+      @parent_template = parse_parent_template
+
+      prepare_parsing
+
+      super
+
+      end_tag
+    end
+
+    def prepare_parsing
+      @options.merge!(:blocks => self.find_blocks(@parent_template.root.nodelist))
+    end
+
+    def end_tag
+      # replace the nodelist by the new one
+      @nodelist = @parent_template.root.nodelist.clone
+
+      @parent_template = nil # no need to keep it
+    end
+
+    def blank?
+      false
+    end
+
+    protected
+
+    def find_blocks(nodelist, blocks = {})
+      if nodelist && nodelist.any?
+        0.upto(nodelist.size - 1).each do |index|
+          node = nodelist[index]
+
+          if node.respond_to?(:call_super) # inherited block !
+            new_node = node.class.clone_block(node)
+
+            nodelist.insert(index, new_node)
+            nodelist.delete_at(index + 1)
+
+            blocks[node.name] = new_node
+          end
+          if node.respond_to?(:nodelist)
+            self.find_blocks(node.nodelist, blocks) # FIXME: find nested blocks too
+          end
+        end
+      end
+      blocks
+    end
+
+    private
+
+    def parse_parent_template
+      source = Template.file_system.read_template_file(@template_name)
+      Template.parse(source)
+    end
+
+    def assert_missing_delimitation!
+    end
+  end
+
+  Template.register_tag('extends', Extends)
+end

data/lib/liquid/tags/for.rb

@@ -0,0 +1,167 @@
+module Liquid
+
+  # "For" iterates over an array or collection.
+  # Several useful variables are available to you within the loop.
+  #
+  # == Basic usage:
+  #    {% for item in collection %}
+  #      {{ forloop.index }}: {{ item.name }}
+  #    {% endfor %}
+  #
+  # == Advanced usage:
+  #    {% for item in collection %}
+  #      <div {% if forloop.first %}class="first"{% endif %}>
+  #        Item {{ forloop.index }}: {{ item.name }}
+  #      </div>
+  #    {% else %}
+  #      There is nothing in the collection.
+  #    {% endfor %}
+  #
+  # You can also define a limit and offset much like SQL.  Remember
+  # that offset starts at 0 for the first item.
+  #
+  #    {% for item in collection limit:5 offset:10 %}
+  #      {{ item.name }}
+  #    {% end %}
+  #
+  #  To reverse the for loop simply use {% for item in collection reversed %}
+  #
+  # == Available variables:
+  #
+  # forloop.name:: 'item-collection'
+  # forloop.length:: Length of the loop
+  # forloop.index:: The current item's position in the collection;
+  #                 forloop.index starts at 1.
+  #                 This is helpful for non-programmers who start believe
+  #                 the first item in an array is 1, not 0.
+  # forloop.index0:: The current item's position in the collection
+  #                  where the first item is 0
+  # forloop.rindex:: Number of items remaining in the loop
+  #                  (length - index) where 1 is the last item.
+  # forloop.rindex0:: Number of items remaining in the loop
+  #                   where 0 is the last item.
+  # forloop.first:: Returns true if the item is the first item.
+  # forloop.last:: Returns true if the item is the last item.
+  #
+  class For < Block
+    Syntax = /\A(#{VariableSegment}+)\s+in\s+(#{QuotedFragment}+)\s*(reversed)?/o
+
+    def initialize(tag_name, markup, tokens, options)
+      parse_with_selected_parser(markup)
+      @nodelist = @for_block = []
+      super
+    end
+
+    def unknown_tag(tag, markup, tokens)
+      return super unless tag == 'else'
+      @nodelist = @else_block = []
+    end
+
+    def render(context)
+      context.registers[:for] ||= Hash.new(0)
+
+      collection = context[@collection_name]
+      collection = collection.to_a if collection.is_a?(Range)
+
+      # Maintains Ruby 1.8.7 String#each behaviour on 1.9
+      return render_else(context) unless iterable?(collection)
+
+      from = if @attributes['offset'] == 'continue'
+        context.registers[:for][@name].to_i
+      else
+        context[@attributes['offset']].to_i
+      end
+
+      limit = context[@attributes['limit']]
+      to    = limit ? limit.to_i + from : nil
+
+
+      segment = Utils.slice_collection_using_each(collection, from, to)
+
+      return render_else(context) if segment.empty?
+
+      segment.reverse! if @reversed
+
+      result = ''
+
+      length = segment.length
+
+      # Store our progress through the collection for the continue flag
+      context.registers[:for][@name] = from + segment.length
+
+      context.stack do
+        segment.each_with_index do |item, index|
+          context[@variable_name] = item
+          context['forloop'] = {
+            'name'    => @name,
+            'length'  => length,
+            'index'   => index + 1,
+            'index0'  => index,
+            'rindex'  => length - index,
+            'rindex0' => length - index - 1,
+            'first'   => (index == 0),
+          'last'    => (index == length - 1) }
+
+          result << render_all(@for_block, context)
+
+          # Handle any interrupts if they exist.
+          if context.has_interrupt?
+            interrupt = context.pop_interrupt
+            break if interrupt.is_a? BreakInterrupt
+            next if interrupt.is_a? ContinueInterrupt
+          end
+        end
+      end
+      result
+    end
+
+    protected
+
+    def lax_parse(markup)
+      if markup =~ Syntax
+        @variable_name = $1
+        @collection_name = $2
+        @name = "#{$1}-#{$2}"
+        @reversed = $3
+        @attributes = {}
+        markup.scan(TagAttributes) do |key, value|
+          @attributes[key] = value
+        end
+      else
+        raise SyntaxError.new(options[:locale].t("errors.syntax.for"), line)
+      end
+    end
+
+    def strict_parse(markup)
+      p = Parser.new(markup)
+      @variable_name = p.consume(:id)
+      raise SyntaxError.new(options[:locale].t("errors.syntax.for_invalid_in"), line)  unless p.id?('in')
+      @collection_name = p.expression
+      @name = "#{@variable_name}-#{@collection_name}"
+      @reversed = p.id?('reversed')
+
+      @attributes = {}
+      while p.look(:id) && p.look(:colon, 1)
+        unless attribute = p.id?('limit') || p.id?('offset')
+          raise SyntaxError.new(options[:locale].t("errors.syntax.for_invalid_attribute"), line)
+        end
+        p.consume
+        val = p.expression
+        @attributes[attribute] = val
+      end
+      p.consume(:end_of_string)
+    end
+
+    private
+
+      def render_else(context)
+        return @else_block ? [render_all(@else_block, context)] : ''
+      end
+
+      def iterable?(collection)
+        collection.respond_to?(:each) || Utils.non_blank_string?(collection)
+      end
+  end
+
+  Template.register_tag('for', For)
+end

data/lib/liquid/tags/if.rb

@@ -0,0 +1,100 @@
+module Liquid
+  # If is the conditional block
+  #
+  #   {% if user.admin %}
+  #     Admin user!
+  #   {% else %}
+  #     Not admin user
+  #   {% endif %}
+  #
+  #    There are {% if count < 5 %} less {% else %} more {% endif %} items than you need.
+  #
+  class If < Block
+    Syntax = /(#{QuotedFragment})\s*([=!<>a-z_]+)?\s*(#{QuotedFragment})?/o
+    ExpressionsAndOperators = /(?:\b(?:\s?and\s?|\s?or\s?)\b|(?:\s*(?!\b(?:\s?and\s?|\s?or\s?)\b)(?:#{QuotedFragment}|\S+)\s*)+)/o
+
+    def initialize(tag_name, markup, tokens, options)
+      @blocks = []
+      push_block('if', markup)
+      super
+    end
+
+    def unknown_tag(tag, markup, tokens)
+      if ['elsif', 'else'].include?(tag)
+        push_block(tag, markup)
+      else
+        super
+      end
+    end
+
+    def render(context)
+      context.stack do
+        @blocks.each do |block|
+          if block.evaluate(context)
+            return render_all(block.attachment, context)
+          end
+        end
+        ''
+      end
+    end
+
+    private
+
+      def push_block(tag, markup)
+        block = if tag == 'else'
+          ElseCondition.new
+        else
+          parse_with_selected_parser(markup)
+        end
+
+        @blocks.push(block)
+        @nodelist = block.attach(Array.new)
+      end
+
+      def lax_parse(markup)
+        expressions = markup.scan(ExpressionsAndOperators).reverse
+        raise(SyntaxError.new(options[:locale].t("errors.syntax.if")), line) unless expressions.shift =~ Syntax
+
+        condition = Condition.new($1, $2, $3)
+
+        while not expressions.empty?
+          operator = (expressions.shift).to_s.strip
+
+          raise(SyntaxError.new(options[:locale].t("errors.syntax.if")), line) unless expressions.shift.to_s =~ Syntax
+
+          new_condition = Condition.new($1, $2, $3)
+          new_condition.send(operator.to_sym, condition)
+          condition = new_condition
+        end
+
+        condition
+      end
+
+      def strict_parse(markup)
+        p = Parser.new(markup)
+
+        condition = parse_comparison(p)
+
+        while op = (p.id?('and') || p.id?('or'))
+          new_cond = parse_comparison(p)
+          new_cond.send(op, condition)
+          condition = new_cond
+        end
+        p.consume(:end_of_string)
+
+        condition
+      end
+
+      def parse_comparison(p)
+        a = p.expression
+        if op = p.consume?(:comparison)
+          b = p.expression
+          Condition.new(a, op, b)
+        else
+          Condition.new(a)
+        end
+      end
+  end
+
+  Template.register_tag('if', If)
+end

data/lib/liquid/tags/ifchanged.rb

@@ -0,0 +1,20 @@
+module Liquid
+  class Ifchanged < Block
+
+    def render(context)
+      context.stack do
+
+        output = render_all(@nodelist, context)
+
+        if output != context.registers[:ifchanged]
+          context.registers[:ifchanged] = output
+          output
+        else
+          ''
+        end
+      end
+    end
+  end
+
+  Template.register_tag('ifchanged', Ifchanged)
+end

data/lib/liquid/tags/include.rb

@@ -0,0 +1,97 @@
+module Liquid
+
+  # Include allows templates to relate with other templates
+  #
+  # Simply include another template:
+  #
+  #   {% include 'product' %}
+  #
+  # Include a template with a local variable:
+  #
+  #   {% include 'product' with products[0] %}
+  #
+  # Include a template for a collection:
+  #
+  #   {% include 'product' for products %}
+  #
+  class Include < Tag
+    Syntax = /(#{QuotedFragment}+)(\s+(?:with|for)\s+(#{QuotedFragment}+))?/o
+
+    def initialize(tag_name, markup, tokens, options)
+      if markup =~ Syntax
+
+        @template_name = $1
+        @variable_name = $3
+        @attributes    = {}
+
+        markup.scan(TagAttributes) do |key, value|
+          @attributes[key] = value
+        end
+
+      else
+        raise SyntaxError.new(options[:locale].t("errors.syntax.include"), options[:line])
+      end
+
+      super
+    end
+
+    def parse(tokens)
+    end
+
+    def blank?
+      false
+    end
+
+    def render(context)
+      partial = load_cached_partial(context)
+      variable = context[@variable_name || @template_name[1..-2]]
+
+      context.stack do
+        @attributes.each do |key, value|
+          context[key] = context[value]
+        end
+
+        if variable.is_a?(Array)
+          variable.collect do |var|
+            context[@template_name[1..-2]] = var
+            partial.render(context)
+          end
+        else
+          context[@template_name[1..-2]] = variable
+          partial.render(context)
+        end
+      end
+    end
+
+    private
+      def load_cached_partial(context)
+        cached_partials = context.registers[:cached_partials] || {}
+        template_name = context[@template_name]
+
+        if cached = cached_partials[template_name]
+          return cached
+        end
+        source = read_template_from_file_system(context)
+        partial = Liquid::Template.parse(source)
+        cached_partials[template_name] = partial
+        context.registers[:cached_partials] = cached_partials
+        partial
+      end
+
+      def read_template_from_file_system(context)
+        file_system = context.registers[:file_system] || Liquid::Template.file_system
+
+        # make read_template_file call backwards-compatible.
+        case file_system.method(:read_template_file).arity
+        when 1
+          file_system.read_template_file(context[@template_name])
+        when 2
+          file_system.read_template_file(context[@template_name], context)
+        else
+          raise ArgumentError, "file_system.read_template_file expects two parameters: (template_name, context)"
+        end
+      end
+  end
+
+  Template.register_tag('include', Include)
+end