locomotive_liquid 2.1.3

data/lib/liquid/tags/capture.rb

@@ -0,0 +1,35 @@
+module Liquid
+
+  # Capture stores the result of a block into a variable without rendering it inplace.
+  #
+  #   {% capture heading %}
+  #     Monkeys!
+  #   {% endcapture %}
+  #   ...
+  #   <h1>{{ heading }}</h1>
+  #
+  # Capture is useful for saving content for use later in your template, such as
+  # in a sidebar or footer.
+  #
+  class Capture < Block
+    Syntax = /(\w+)/
+
+    def initialize(tag_name, markup, tokens, context)
+      if markup =~ Syntax
+        @to = $1
+      else
+        raise SyntaxError.new("Syntax Error in 'capture' - Valid syntax: capture [var]")
+      end
+
+      super
+    end
+
+    def render(context)
+      output = super
+      context.scopes.last[@to] = output.join
+      ''
+    end
+  end
+
+  Template.register_tag('capture', Capture)
+end

data/lib/liquid/tags/case.rb

@@ -0,0 +1,83 @@
+module Liquid
+  class Case < Block
+    Syntax     = /(#{QuotedFragment})/
+    WhenSyntax = /(#{QuotedFragment})(?:(?:\s+or\s+|\s*\,\s*)(#{QuotedFragment}.*))?/
+
+    def initialize(tag_name, markup, tokens, context)
+      @blocks = []
+
+      if markup =~ Syntax
+        @left = $1
+      else
+        raise SyntaxError.new("Syntax Error in tag 'case' - Valid syntax: case [condition]")
+      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
+
+        @blocks.inject([]) do |output, 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
+
+          output
+        end
+      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("Syntax Error in tag 'case' - Valid when condition: {% when [condition] [or condition2...] %} ")
+        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("Syntax Error in tag 'case' - Valid else condition: {% else %} (no parameters) ")
+      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,9 @@
+module Liquid
+  class Comment < Block                                             
+    def render(context)
+      ''
+    end    
+  end
+  
+  Template.register_tag('comment', Comment)  
+end

data/lib/liquid/tags/cycle.rb

@@ -0,0 +1,59 @@
+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}+/
+    NamedSyntax  = /^(#{QuotedFragment})\s*\:\s*(.*)/
+
+    def initialize(tag_name, markup, tokens, context)
+      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("Syntax Error in 'cycle' - Valid syntax: cycle [name :] var [, var2, var3 ...]")
+      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
+
+    private
+
+    def variables_from_string(markup)
+      markup.split(',').collect do |var|
+        var =~ /\s*(#{QuotedFragment})\s*/
+        $1 ? $1 : nil
+      end.compact
+    end
+
+  end
+
+  Template.register_tag('cycle', Cycle)
+end

data/lib/liquid/tags/extends.rb

@@ -0,0 +1,75 @@
+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, context)
+      if markup =~ Syntax
+        @template_name = $1.gsub('\'', '').strip
+      else
+        raise SyntaxError.new("Error in tag 'extends' - Valid syntax: extends [template]")
+      end
+
+      @context = context
+
+      @parent_template = parse_parent_template
+
+      prepare_parsing
+
+      super
+
+      end_tag
+    end
+
+    def prepare_parsing
+      @context.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
+
+    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,136 @@
+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>
+  #    {% 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 = /(\w+)\s+in\s+(#{QuotedFragment}+)\s*(reversed)?/
+
+    def initialize(tag_name, markup, tokens, context)
+      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("Syntax Error in 'for loop' - Valid syntax: for [item] in [collection]")
+      end
+
+      super
+    end
+
+    def render(context)
+      context.registers[:for] ||= Hash.new(0)
+
+      collection = context[@collection_name]
+      collection = collection.to_a if collection.is_a?(Range)
+
+      return '' unless collection.respond_to?(:each)
+
+      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 = slice_collection_using_each(collection, from, to)
+
+      return '' 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(@nodelist, context)
+        end
+      end
+      result
+    end
+
+    def slice_collection_using_each(collection, from, to)
+      segments = []
+      index = 0
+      yielded = 0
+      collection.each do |item|
+
+        if to && to <= index
+          break
+        end
+
+        if from <= index
+          segments << item
+        end
+
+        index += 1
+      end
+
+      segments
+    end
+  end
+
+  Template.register_tag('for', For)
+end

data/lib/liquid/tags/if.rb

@@ -0,0 +1,80 @@
+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
+    SyntaxHelp = "Syntax Error in tag 'if' - Valid syntax: if [expression]"
+    Syntax = /(#{QuotedFragment})\s*([=!<>a-z_]+)?\s*(#{QuotedFragment})?/
+    ExpressionsAndOperators = /(?:\b(?:and|or)\b|(?:\s*(?!\b(?:and|or)\b)(?:#{QuotedFragment}|\S+)\s*)+)/
+
+    def initialize(tag_name, markup, tokens, context)
+
+      @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
+
+        expressions = markup.scan(ExpressionsAndOperators).reverse
+        raise(SyntaxError, SyntaxHelp) unless expressions.shift =~ Syntax
+
+        condition = Condition.new($1, $2, $3)
+
+        while not expressions.empty?
+          operator = expressions.shift
+
+          raise(SyntaxError, SyntaxHelp) 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
+
+      @blocks.push(block)
+      @nodelist = block.attach(Array.new)
+    end
+
+
+  end
+
+  Template.register_tag('if', If)
+end