liquid-template-inheritance 2.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9130d16cdaf8ed2cb372346545efea5dbb35f685
+  data.tar.gz: bcf3e62f18f8566bb219c9d0740ec4de62980524
+SHA512:
+  metadata.gz: 336c6800298678906606546c124976aee4a0e6824d3da719bcb67bfadf32a99b7811b5d6ab4c28f9ad45315658a2e51ce5111acb0936176837accadd5b7054ad
+  data.tar.gz: 6c0ddc5655035e1065e76783e0668ef5cb21e38d7fd9f5710c9dccb8c63967bee5121e1b3848a44b2e42b503b104b99b4984052c1396c23bb05afa86a8c5f781

data/.gitignore

@@ -0,0 +1,35 @@
+Gemfile.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'liquid', github: 'Shopify/liquid'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 LocomotiveCMS
+
+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/README.md

@@ -0,0 +1,27 @@
+Template inheritance add-on for Liquid
+===
+
+Implementation of template inheritance, similar to what offers [Django](https://docs.djangoproject.com/en/dev/topics/templates/).
+
+See the discussion with the Shopify team about it [here](https://github.com/Shopify/liquid/pull/336).
+
+**Important**. That's not a fork of the Liquid gem, it's rather a kind of add-on for Liquid. It requires a version of Liquid higher than the 3.0.0.
+
+## Installation
+
+Add this line to your application's Gemfile, just after the one related to Liquid.
+
+    gem 'liquid-template-inheritance'
+
+And then execute:
+
+    $ bundle install
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/locomotivecms/liquid-template-inheritance )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rake/testtask'
+
+require_relative "lib/liquid/template_inheritance/version"
+
+task :default => 'test'
+
+desc 'run test suite'
+Rake::TestTask.new(:test) do |t|
+  t.libs << '.' << 'lib' << 'test'
+  t.test_files = FileList['test/{integration,unit}/**/*_test.rb']
+  t.verbose = false
+end
+
+task :gem => :build
+task :build do
+  system "gem build liquid-template-inheritance.gemspec"
+end
+
+task :install => :build do
+  system "gem install liquid-template-inheritance-#{Liquid::TemplateInheritance::VERSION}.gem"
+end
+
+task :release => :build do
+  system "git tag -a v#{Liquid::TemplateInheritance::VERSION} -m 'Tagging #{Liquid::TemplateInheritance::VERSION}'"
+  system "git push --tags"
+  system "gem push liquid-template-inheritance-#{Liquid::TemplateInheritance::VERSION}.gem"
+  system "rm liquid-template-inheritance-#{Liquid::TemplateInheritance::VERSION}.gem"
+end

data/lib/liquid-template-inheritance.rb

@@ -0,0 +1,5 @@
+require 'liquid'
+
+require 'liquid/template_inheritance/i18n'
+
+Dir[File.dirname(__FILE__) + '/liquid/template_inheritance/{tags,drops}/*.rb'].each { |f| require f }

data/lib/liquid/template_inheritance/drops/inherited_block_drop.rb

@@ -0,0 +1,26 @@
+module Liquid
+  module TemplateInheritance
+
+    # Used to render the content of the parent block.
+    #
+    #   {% extends home %}
+    #   {% block content }{{ block.super }}{% endblock %}
+    #
+    class InheritedBlockDrop < Drop
+
+      def initialize(block)
+        @block = block
+      end
+
+      def name
+        @block.name
+      end
+
+      def super
+        @block.call_super(@context)
+      end
+
+    end
+
+  end
+end

data/lib/liquid/template_inheritance/i18n.rb

@@ -0,0 +1,32 @@
+module Liquid
+  class I18n
+
+    TEMPLATE_INHERITANCE_DEFAULT_LOCALE = File.join(File.expand_path(File.dirname(__FILE__)), "locales", "en.yml")
+
+    def locale_with_template_inheritance
+      if @path != DEFAULT_LOCALE
+        # we assume that the developers already included the keys concerning the template inheritance.
+        locale_without_template_inheritance
+      else
+        # memoization
+        return @locale if @locale
+
+        default = locale_without_template_inheritance
+        addon   = YAML.load_file(TEMPLATE_INHERITANCE_DEFAULT_LOCALE)
+
+        deep_merge(addon, default)
+      end
+    end
+
+    alias_method :locale_without_template_inheritance, :locale
+    alias_method :locale, :locale_with_template_inheritance
+
+    private
+
+    def deep_merge(locale_1, locale_2)
+      merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? deep_merge(v1, v2) : v2 }
+      locale_1.merge(locale_2, &merger)
+    end
+
+  end
+end

data/lib/liquid/template_inheritance/locales/en.yml

@@ -0,0 +1,5 @@
+---
+  errors:
+    syntax:
+      extends: "Syntax Error in 'extends' - Valid syntax: extends [template]"
+      inherited_block: "Syntax Error in 'block' - Valid syntax: block [name]"

data/lib/liquid/template_inheritance/tags/extends.rb

@@ -0,0 +1,79 @@
+module Liquid
+  module TemplateInheritance
+
+    # Extends allows designer to use template inheritance
+    #
+    #   {% extends home %}
+    #   {% block content }Hello world{% endblock %}
+    #
+    class Extends < Block
+      Syntax = /(#{QuotedFragment}+)/o
+
+      def initialize(tag_name, markup, options)
+        super
+
+        if markup =~ Syntax
+          @template_name = $1.gsub(/["']/o, '').strip
+        else
+          raise(SyntaxError.new(options[:locale].t("errors.syntax.extends".freeze)))
+        end
+      end
+
+      def parse(tokens)
+        # get the nodes of the template the object inherits from
+        parent_template = parse_parent_template
+
+        # find the blocks in case there is a call to
+        # the super method inside the current template
+        @options.merge!(:blocks => self.find_blocks(parent_template.root.nodelist))
+
+        # finally, process the rest of the tokens
+        # the tags/blocks other than the InheritedBlock type will be ignored.
+        super
+
+        # replace the nodes of the current template by the ones from the parent
+        @nodelist = parent_template.root.nodelist.clone
+      end
+
+      def blank?
+        false
+      end
+
+      protected
+
+      def find_blocks(nodelist, blocks = {})
+        if nodelist
+          nodelist.each_with_index do |node, index|
+            # is the node an inherited block?
+            if node.respond_to?(:call_super)
+              new_node = node.clone_it
+
+              nodelist.insert(index, new_node)
+              nodelist.delete_at(index + 1)
+
+              blocks[node.name] = new_node
+            end
+            if node.respond_to?(:nodelist)
+              # find nested blocks too
+              self.find_blocks(node.nodelist, blocks)
+            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
+
+  end
+
+  Template.register_tag('extends', TemplateInheritance::Extends)
+end

data/lib/liquid/template_inheritance/tags/inherited_block.rb

@@ -0,0 +1,94 @@
+module Liquid
+  module TemplateInheritance
+
+    # Blocks are used with the Extends tag to define
+    # the content of blocks. Nested blocks are allowed.
+    #
+    #   {% extends home %}
+    #   {% block content }Hello world{% endblock %}
+    #
+    class InheritedBlock < Block
+      Syntax = /(#{QuotedFragment}+)/o
+
+      attr_reader :name, :parent
+
+      def initialize(tag_name, markup, options)
+        super
+
+        if markup =~ Syntax
+          @name = $1.gsub(/["']/o, '').strip
+        else
+          raise(SyntaxError.new(options[:locale].t("errors.syntax.inherited_block".freeze)))
+        end
+
+        set_full_name!(options)
+
+        (options[:block_stack] ||= []).push(self)
+        options[:current_block] = self
+      end
+
+      def render(context)
+        context.stack do
+          context['block'] = InheritedBlockDrop.new(self)
+          render_all(@nodelist, context)
+        end
+      end
+
+      def end_tag
+        link_it_with_ancestor
+
+        # clean the stack
+        options[:block_stack].pop
+        options[:current_block] = options[:block_stack].last
+      end
+
+      def call_super(context)
+        if parent
+          parent.render(context)
+        else
+          ''
+        end
+      end
+
+      def clone_it
+        self.class.clone_it(self)
+      end
+
+      def attach_parent(parent, nodelist)
+        @parent   = parent
+        @nodelist = nodelist
+      end
+
+      def self.clone_it(block)
+        new_block = new(block.block_name, block.name, {})
+        new_block.attach_parent(block.parent, block.nodelist)
+        new_block
+      end
+
+      private
+
+      def set_full_name!(options)
+        if options[:current_block]
+          @name = options[:current_block].name + '/' + @name
+        end
+      end
+
+      def link_it_with_ancestor
+        options[:blocks] ||= {}
+
+        block = options[:blocks][@name]
+
+        if block
+          # copy/clone the existing block in order to make it a parent of the parsed block
+          cloned_block = block.clone_it
+
+          # replace the up-to-date version of the block in the parent template
+          block.attach_parent(cloned_block, @nodelist)
+        end
+      end
+
+    end
+  end
+
+  Template.register_tag('block', TemplateInheritance::InheritedBlock)
+end

data/lib/liquid/template_inheritance/version.rb

@@ -0,0 +1,7 @@
+module Liquid
+  module TemplateInheritance
+
+    VERSION = '2.6.1'
+
+  end
+end

data/liquid-template-inheritance.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "liquid/template_inheritance/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'liquid-template-inheritance'
+  spec.version       = Liquid::TemplateInheritance::VERSION
+  spec.authors       = ['Didier Lafforgue', 'Arnaud Sellenet', 'Joel Azemar']
+  spec.email         = ['did@locomotivecms.com', 'arnaud@sellenet.fr', 'joel.azemar@gmail.com']
+  spec.description   = %q{Liquid addon that enables template inheritance}
+  spec.summary       = %q{This is an addon for the liquid templating engine, that adds the ability to inherit from templates}
+  spec.homepage      = 'https://github.com/locomotivecms/liquid-template-inheritance'
+  #spec.repo          = 'https://github.com/locomotivecms/liquid-template-inheritance'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  #spec.add_development_dependency 'liquid', '~> 2.6.1'
+
+  spec.required_ruby_version = '~> 2.0.0'
+end

data/test/fixtures/en_locale.yml

@@ -0,0 +1,9 @@
+---
+  simple: "less is more"
+  whatever: "something %{something}"
+  errors:
+    i18n:
+      undefined_interpolation: "undefined key %{key}"
+      unknown_translation: "translation '%{name}' wasn't found"
+    syntax:
+      oops: "something wasn't right"

data/test/integration/tags/extends_tag_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+class LayoutFileSystem
+  def read_template_file(template_path, context)
+    case template_path
+    when "base"
+      "<body>base</body>"
+
+    when "inherited"
+      "{% extends base %}"
+
+    when "page_with_title"
+      "<body><h1>{% block title %}Hello{% endblock %}</h1><p>Lorem ipsum</p></body>"
+
+    when "product"
+      "<body><h1>Our product: {{ name }}</h1>{% block info %}{% endblock %}</body>"
+
+    when "product_with_warranty"
+      "{% extends product %}{% block info %}<p>mandatory warranty</p>{% endblock %}"
+
+    when "product_with_static_price"
+      "{% extends product %}{% block info %}<h2>Some info</h2>{% block price %}<p>$42.00</p>{% endblock %}{% endblock %}"
+
+    else
+      template_path
+    end
+  end
+end
+
+class ExtendsTagTest < Test::Unit::TestCase
+  include Liquid
+
+  def setup
+    Liquid::Template.file_system = LayoutFileSystem.new
+  end
+
+  def test_template_extends_another_template
+    assert_template_result "<body>base</body>",
+      "{% extends base %}"
+  end
+
+  def test_template_extends_an_inherited_template
+    assert_template_result "<body>base</body>",
+      "{% extends inherited %}"
+  end
+
+  def test_template_can_pass_variables_to_the_parent_template
+    assert_template_result "<body><h1>Our product: Macbook</h1></body>",
+      "{% extends product %}", 'name' => 'Macbook'
+  end
+
+  def test_template_can_pass_variables_to_the_inherited_parent_template
+    assert_template_result "<body><h1>Our product: PC</h1><p>mandatory warranty</p></body>",
+      "{% extends product_with_warranty %}", 'name' => 'PC'
+  end
+
+  def test_template_does_not_render_statements_outside_blocks
+    assert_template_result "<body>base</body>",
+      "{% extends base %} Hello world"
+  end
+
+  def test_template_extends_another_template_with_a_single_block
+    assert_template_result "<body><h1>Hello</h1><p>Lorem ipsum</p></body>",
+      "{% extends page_with_title %}"
+  end
+
+  def test_template_overrides_a_block
+    assert_template_result "<body><h1>Sweet</h1><p>Lorem ipsum</p></body>",
+      "{% extends page_with_title %}{% block title %}Sweet{% endblock %}"
+  end
+
+  def test_template_has_access_to_the_content_of_the_overriden_block
+    assert_template_result "<body><h1>Hello world</h1><p>Lorem ipsum</p></body>",
+      "{% extends page_with_title %}{% block title %}{{ block.super }} world{% endblock %}"
+  end
+
+  def test_template_accepts_nested_blocks
+    assert_template_result "<body><h1>Our product: iPhone</h1><h2>Some info</h2><p>$42.00</p><p>(not on sale)</p></body>",
+      "{% extends product_with_static_price %}{% block info/price %}{{ block.super }}<p>(not on sale)</p>{% endblock %}", 'name' => 'iPhone'
+  end
+
+end # ExtendsTagTest

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'test/unit/assertions'
+begin
+  require 'ruby-debug'
+rescue LoadError
+  puts "Couldn't load ruby-debug. gem install ruby-debug if you need it."
+end
+
+require 'liquid.rb'
+require 'liquid-template-inheritance'
+
+module Test
+  module Unit
+    module Assertions
+      include Liquid
+
+      def assert_template_result(expected, template, assigns = {}, message = nil)
+        assert_equal expected, Template.parse(template).render(assigns)
+      end
+
+      def assert_template_result_matches(expected, template, assigns = {}, message = nil)
+        return assert_template_result(expected, template, assigns, message) unless expected.is_a? Regexp
+
+        assert_match expected, Template.parse(template).render(assigns)
+      end
+    end # Assertions
+  end # Unit
+end # Test

data/test/unit/i18n_unit_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class I18nUnitTest < Test::Unit::TestCase
+  include Liquid
+
+  def setup
+    @i18n = I18n.new
+  end
+
+  def test_assign_error
+    assert_equal "Syntax Error in 'assign' - Valid syntax: assign [var] = [source]", @i18n.translate("errors.syntax.assign")
+  end
+
+  def test_extends_error
+    assert_equal "Syntax Error in 'extends' - Valid syntax: extends [template]", @i18n.translate("errors.syntax.extends")
+  end
+
+  def test_inherited_block_error
+    assert_equal "Syntax Error in 'block' - Valid syntax: block [name]", @i18n.translate("errors.syntax.inherited_block")
+  end
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: liquid-template-inheritance
+version: !ruby/object:Gem::Version
+  version: 2.6.1
+platform: ruby
+authors:
+- Didier Lafforgue
+- Arnaud Sellenet
+- Joel Azemar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Liquid addon that enables template inheritance
+email:
+- did@locomotivecms.com
+- arnaud@sellenet.fr
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/liquid-template-inheritance.rb
+- lib/liquid/template_inheritance/drops/inherited_block_drop.rb
+- lib/liquid/template_inheritance/i18n.rb
+- lib/liquid/template_inheritance/locales/en.yml
+- lib/liquid/template_inheritance/tags/extends.rb
+- lib/liquid/template_inheritance/tags/inherited_block.rb
+- lib/liquid/template_inheritance/version.rb
+- liquid-template-inheritance.gemspec
+- test/fixtures/en_locale.yml
+- test/integration/tags/extends_tag_test.rb
+- test/test_helper.rb
+- test/unit/i18n_unit_test.rb
+homepage: https://github.com/locomotivecms/liquid-template-inheritance
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This is an addon for the liquid templating engine, that adds the ability
+  to inherit from templates
+test_files:
+- test/fixtures/en_locale.yml
+- test/integration/tags/extends_tag_test.rb
+- test/test_helper.rb
+- test/unit/i18n_unit_test.rb