liquid-blocks 0.2.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Dan Webb
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/lib/liquid_blocks.rb

@@ -0,0 +1,9 @@
+require 'liquid'
+
+module LiquidBlocks
+  autoload :Extends, 'liquid_blocks/extends'
+  autoload :Block, 'liquid_blocks/block'
+end
+
+Liquid::Template.register_tag(:extends, LiquidBlocks::Extends)
+Liquid::Template.register_tag(:block, LiquidBlocks::Block)

data/lib/liquid_blocks/block.rb

@@ -0,0 +1,56 @@
+module LiquidBlocks
+
+  class BlockDrop < ::Liquid::Drop
+    def initialize(block)
+      @block = block
+    end
+
+    def super
+      @block.call_super(@context)
+    end
+  end
+
+  class Block < ::Liquid::Block
+    Syntax = /(\w)+/
+
+    attr_accessor :parent
+    attr_reader :name
+
+    def initialize(tag_name, markup, tokens)
+      if markup =~ Syntax
+        @name = $1
+      else
+        raise Liquid::SyntaxError.new("Syntax Error in 'block' - Valid syntax: block [name]")
+      end
+
+      super if tokens
+    end
+
+    def render(context)
+      context.stack do
+        context['block'] = BlockDrop.new(self)
+
+        render_all(@nodelist, context)
+      end
+    end
+
+    def add_parent(nodelist)
+      if parent
+        parent.add_parent(nodelist)
+      else
+        self.parent = Block.new(@tag_name, @name, nil)
+        parent.nodelist = nodelist
+      end
+    end
+
+    def call_super(context)
+      if parent
+        parent.render(context)
+      else
+        ''
+      end
+    end
+
+  end
+
+end

data/lib/liquid_blocks/extends.rb

@@ -0,0 +1,101 @@
+module LiquidBlocks
+
+  class Extends < ::Liquid::Block
+    Syntax = /(#{Liquid::QuotedFragment}+)/
+
+    def initialize(tag_name, markup, tokens)
+      if markup =~ Syntax
+        @template_name = $1
+      else
+        raise Liquid::SyntaxError.new("Syntax Error in 'extends' - Valid syntax: extends [template]")
+      end
+
+      super
+
+      @blocks = @nodelist.inject({}) do |m, node|
+        m[node.name] = node if node.is_a?(::LiquidBlocks::Block); m
+      end
+    end
+
+    def parse(tokens)
+      parse_all(tokens)
+    end
+
+    def render(context)
+      template = load_template(context)
+      parent_blocks = find_blocks(template.root)
+
+      @blocks.each do |name, block|
+        if pb = parent_blocks[name]
+          pb.parent = block.parent
+          pb.add_parent(pb.nodelist)
+          pb.nodelist = block.nodelist
+        else
+          if is_extending?(template)
+            template.root.nodelist << block
+          end
+        end
+      end
+
+      template.render(context)
+    end
+
+    private
+
+    def parse_all(tokens)
+      @nodelist ||= []
+      @nodelist.clear
+
+      while token = tokens.shift
+        case token
+        when /^#{Liquid::TagStart}/
+          if token =~ /^#{Liquid::TagStart}\s*(\w+)\s*(.*)?#{Liquid::TagEnd}$/
+            # fetch the tag from registered blocks
+            if tag = Liquid::Template.tags[$1]
+              @nodelist << tag.new($1, $2, tokens)
+            else
+              # this tag is not registered with the system
+              # pass it to the current block for special handling or error reporting
+              unknown_tag($1, $2, tokens)
+            end
+          else
+            raise Liquid::SyntaxError, "Tag '#{token}' was not properly terminated with regexp: #{Liquid::TagEnd.inspect}"
+          end
+        when /^#{Liquid::VariableStart}/
+          @nodelist << create_variable(token)
+        when ''
+          # pass
+        else
+          @nodelist << token
+        end
+      end
+    end
+
+    def load_template(context)
+      source = Liquid::Template.file_system.read_template_file(@template_name[1..-2], context)
+      Liquid::Template.parse(source)
+    end
+
+    def find_blocks(node, blocks={})
+      if node.respond_to?(:nodelist) && !node.nodelist.nil?
+        node.nodelist.inject(blocks) do |b, node|
+          if node.is_a?(LiquidBlocks::Block)
+            b[node.name] = node
+          else
+            find_blocks(node, b)
+          end
+
+          b
+        end
+      end
+
+      blocks
+    end
+
+    def is_extending?(template)
+      template.root.nodelist.any? { |node| node.is_a?(Extends) }
+    end
+
+  end
+
+end

data/lib/liquid_blocks/version.rb

@@ -0,0 +1,3 @@
+module LiquidBlocks
+  VERSION = '0.2.0'
+end

data/test/test_liquid_blocks.rb

@@ -0,0 +1,161 @@
+require 'test/unit'
+require 'liquid_blocks'
+
+class TestFileSystem
+  def read_template_file(path, context)
+    if path == 'simple'
+      'test'
+    elsif path == 'complex'
+      %{
+        beginning
+
+        {% block thing %}
+        rarrgh
+        {% endblock %}
+
+        {% block another %}
+        bum
+        {% endblock %}
+
+      end
+      }
+    elsif path == 'nested'
+      %{
+        {% extends 'complex' %}
+
+        {% block thing %}
+        from nested
+        {% endblock %}
+
+        {% block another %}
+        from nested (another)
+        {% endblock %}
+      }
+    else
+      %{
+        {% extends 'complex' %}
+
+        {% block thing %}
+        from nested
+        {% endblock %}
+      }
+    end
+  end
+end
+
+Liquid::Template.file_system = TestFileSystem.new
+
+class LiquidBlocksTest < Test::Unit::TestCase
+  def test_output_the_contents_of_the_extended_template
+    template = Liquid::Template.parse %{
+      {% extends 'simple' %}
+
+      {% block thing %}
+      yeah
+      {% endblock %}
+    }
+
+    assert_match /test/, template.render
+  end
+
+  def test_render_original_content_of_block_if_no_child_block_given
+    template = Liquid::Template.parse %{
+      {% extends 'complex' %}
+    }
+
+    assert_match /rarrgh/, template.render
+    assert_match /bum/, template.render
+  end
+
+  def test_render_child_content_of_block_if_child_block_given
+    template = Liquid::Template.parse %{
+      {% extends 'complex' %}
+
+      {% block thing %}
+      booyeah
+      {% endblock %}
+    }
+
+    assert_match /booyeah/, template.render
+    assert_match /bum/, template.render
+  end
+
+  def test_render_child_content_of_blocks_if_multiple_child_blocks_given
+    template = Liquid::Template.parse %{
+      {% extends 'complex' %}
+
+      {% block thing %}
+      booyeah
+      {% endblock %}
+
+      {% block another %}
+      blurb
+      {% endblock %}
+    }
+
+    assert_match /booyeah/, template.render
+    assert_match /blurb/, template.render
+  end
+
+  def test_remember_context_of_child_template
+    template = Liquid::Template.parse %{
+      {% extends 'complex' %}
+
+      {% block thing %}
+      booyeah
+      {% endblock %}
+
+      {% block another %}
+      {{ a }}
+      {% endblock %}
+    }
+
+    res = template.render 'a' => 1234
+
+    assert_match /booyeah/, res
+    assert_match /1234/, res
+  end
+
+  def test_work_with_nested_templates
+    template = Liquid::Template.parse %{
+      {% extends 'nested' %}
+
+      {% block thing %}
+      booyeah
+      {% endblock %}
+    }
+
+    res = template.render 'a' => 1234
+
+    assert_match /booyeah/, res
+    assert_match /from nested/, res
+  end
+
+  def test_work_with_nested_templates_if_middle_template_skips_a_block
+    template = Liquid::Template.parse %{
+      {% extends 'nested2' %}
+
+      {% block another %}
+      win
+      {% endblock %}
+    }
+
+    res = template.render
+
+    assert_match /win/, res
+  end
+
+  def test_render_parent_for_block_super
+    template = Liquid::Template.parse %{
+      {% extends 'complex' %}
+
+      {% block thing %}
+      {{ block.super }}
+      {% endblock %}
+    }
+
+    res = template.render 'a' => 1234
+
+    assert_match /rarrgh/, res
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: liquid-blocks
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Webb
+- Silas Sewell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Django-style template inheritance for Liquid
+email:
+- silas@sewell.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/liquid_blocks.rb
+- lib/liquid_blocks/block.rb
+- lib/liquid_blocks/extends.rb
+- lib/liquid_blocks/version.rb
+- LICENSE
+- test/test_liquid_blocks.rb
+homepage: https://github.com/silas/liquid-blocks
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4152518546430610030
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: liquid-blocks
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Liquid Blocks
+test_files:
+- test/test_liquid_blocks.rb