jekyll-liquid-plus 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de976d38b8549a3022f3178705c3981e3638c9d0
-  data.tar.gz: 993189b53393131442fe4ebf8c486c3be17bcd40
+  metadata.gz: 050beadf8660b7b1e2067aa1ff5153d06bf8e85e
+  data.tar.gz: 9b2d3e942011d756f602a51bb63f412c36c814f8
 SHA512:
-  metadata.gz: eaad7e1bad7865cb335d33753847146990891cc537e2e484c4a181a8a51c3e3224eebc2be69b76a76214736db3d743e6f0d7e7d223ecb8f7ab4b60a1e3b9ec29
-  data.tar.gz: 03d2e10cde1244326eec35df1b974e4846305523940f2fdb803398ef43e5e6bf80af7cc17463ddadd7cc980c8b89147600ac716eb80716b5f1d78b750091e368
+  metadata.gz: 86414e474bc4521e42a450e3a315e501c95bcba4927832efce95403f6d13e1623e8aae3b15bab40719bcb182ff960f2c03578dc8c25fbc9bdb45824d56a29749
+  data.tar.gz: 42f11dbbbdfa82f461e68f602ef7ffe35ee979d0a11b09f712acbbd2228a54b31f0f830d4b486ecf6ee6c39034d517e66e0696b53d407eabd087ddb72e687784

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.2.0 (2013-11-03)
+- Fix: Render tag now properly renders {{ content }}.
+
 ## 1.1.0 (2013-11-03)
 - New: Render tag works with absolute paths and user relative paths.
 

data/jekyll-liquid-plus.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($/)
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "jekyll", "~> 1.1.2"
+  spec.add_runtime_dependency "jekyll", "~> 1.3.0"
   spec.add_runtime_dependency "liquid", "~> 2.5.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/jekyll-liquid-plus.rb

@@ -1,4 +1,5 @@
 require 'liquid'
+require 'jekyll'
 
 $:.unshift File.dirname(__FILE__)
 
@@ -8,17 +9,16 @@ module LiquidPlus
   autoload :Cache,         'jekyll-liquid-plus/helpers/cache'
   autoload :IncludeTag,    'jekyll-liquid-plus/tags/include'
   autoload :WrapTag,       'jekyll-liquid-plus/tags/wrap'
-  autoload :RenderTag,     'jekyll-liquid-plus/tags/render'
   autoload :AssignTag,     'jekyll-liquid-plus/tags/assign'
   autoload :CaptureTag,    'jekyll-liquid-plus/tags/capture'
   autoload :ReturnTag,     'jekyll-liquid-plus/tags/return'
 end
 
 Liquid::Template.register_tag('include', LiquidPlus::IncludeTag)
+Liquid::Template.register_tag('render', LiquidPlus::IncludeTag)
 Liquid::Template.register_tag('wrap', LiquidPlus::WrapTag)
 Liquid::Template.register_tag('wrap_include', LiquidPlus::WrapTag)
-Liquid::Template.register_tag('render', LiquidPlus::RenderTag)
-Liquid::Template.register_tag('render_partial', LiquidPlus::RenderTag)
+Liquid::Template.register_tag('render_partial', LiquidPlus::IncludeTag)
 Liquid::Template.register_tag('assign', LiquidPlus::AssignTag)
 Liquid::Template.register_tag('capture', LiquidPlus::CaptureTag)
 Liquid::Template.register_tag('return', LiquidPlus::ReturnTag)

data/lib/jekyll-liquid-plus/helpers/include.rb

@@ -3,32 +3,11 @@ require File.join File.expand_path('../../', __FILE__), 'helpers/path'
 module LiquidPlus
   class Include
     LOCALS = /(.*?)(([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+)))(.*)?/
-
     class << self
 
       def render(markup, context)
-
-        markup, params = split_params markup
-        file = Path.parse(markup, context, '_includes')
-
-        if file
-          if File.exist? Path.expand(File.join('_includes', file), context)
-            markup = file
-            markup += params if params
-            tag = Jekyll::Tags::IncludeTag.new('', markup, [])
-            tag.render(context)
-          else
-            dir = '_includes'
-            dir = File.join dir, File.dirname(file) unless File.dirname(file) == '.'
-
-            msg  = "From #{context.registers[:page]['path']}: "
-            msg += "File '#{file}' not found"
-            msg += " in '#{dir}/' directory"
-
-            puts msg.red
-            return msg
-          end
-        end
+        tag = IncludeTag.new('include', markup, [])
+        tag.render(context)
       end
 
       def split_params(markup)

data/lib/jekyll-liquid-plus/tags/include.rb

@@ -1,16 +1,138 @@
-require File.join File.expand_path('../../', __FILE__), 'helpers/include'
+require File.join File.expand_path('../../', __FILE__), 'helpers/path'
+require File.join File.expand_path('../../', __FILE__), 'helpers/cache'
+
+module Jekyll
+
+  # Create a new page class to allow partials to trigger Jekyll Page Hooks.
+  class ConvertiblePage
+    include Convertible
+    
+    attr_accessor :name, :content, :site, :ext, :output, :data
+    
+    def initialize(site, name, content)
+      @site     = site
+      @name     = name
+      @ext      = File.extname(name)
+      @content  = content
+      @data     = { layout: "no_layout" } # hack
+      
+    end
+    
+    def render(payload)
+      do_layout(payload, { no_layout: nil })
+    end
+  end
+end
 
 module LiquidPlus
-  class IncludeTag < Liquid::Tag
+  class IncludeTag < Jekyll::Tags::IncludeTag
+    LOCALS = /(.*?)(([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+)))(.*)?/
+
+    alias_method :default_render, :render
+
 
     def initialize(tag_name, markup, tokens)
+      @tag = tag_name.strip
       @markup = markup.strip
-      super
-    end
+      # If raw, strip from the markup as not to confuse the Path syntax parsing
+      if @markup =~ /^(\s*raw\s)?(.+?)(\sraw\s*)?$/
+        @markup = $2.strip
+        @raw = true unless $1.nil? and $3.nil?
+      end
 
+      split_params
+    end
+    
     def render(context)
-      Include.render(@markup, context)
+      validate_params if @params
+      @file = get_path(context)
+      if @tag == 'include' && @file && Cache.exists(Path.expand(File.join(INCLUDES_DIR, @file), context))
+        include_tag(context)
+      elsif @tag =~ /render/ && @file && Cache.exists(@file)
+        render_tag(context)
+      elsif @file
+        not_found(context)
+      end
+    end
+
+    def include_tag(context)
+      @markup = @file
+      @markup += @params if @params
+      @page = context.registers[:page]['path']
+      content = default_render(context)
+      parse_convertible(content, context)
+    end
+
+    def render_tag(context)
+      @markup = @file
+      @markup += @params if @params
+      content = read_raw
+
+      unless @raw
+        partial = Liquid::Template.parse(content)
+
+        content = context.stack do
+          context['render'] = Jekyll::Tags::IncludeTag.new('include', @markup, []).parse_params(context) if @params
+          context['page'] = context['page'].deep_merge(@local_vars) if @local_vars and @local_vars.keys.size > 0
+          partial.render!(context)
+        end
+        content = parse_convertible(content, context)
+      end
+      content
+    end
+
+    def not_found(context)
+      @file = File.join(INCLUDES_DIR, @file) if @tag == 'include'
+      name = File.basename(@file)
+      dir  = @file.to_s.sub(context.registers[:site].source + '/', '').sub(name, '')
+      msg = "File '#{name}' not found"
+      msg +=  " in '#{dir}'" if dir.length > 0 && name != dir
+      raise IOError.new msg
+    end
+
+    def parse_convertible(content, context)
+      page = Jekyll::ConvertiblePage.new(context.registers[:site], @file, content)
+      page.render({})
+      content = page.output.strip
+    end
+
+    def split_params
+      if @markup =~ LOCALS
+        @params = ' ' + $2
+        @markup = $1 + $7
+      end
+    end
+
+    def get_path(context)
+      root = (@tag == 'include') ? INCLUDES_DIR : nil
+      if file = Path.parse(@markup, context, root)
+        file = Path.expand(file, context) if @tag =~ /render/
+        @markup = file
+        file
+      end
+    end
+
+    #Strip out yaml header from partials
+    def strip_yaml(content)
+      if content =~ /\A-{3}(.+[^\A])-{3}\n(.+)/m
+        $2.strip
+      end
+      content
+    end
+
+    def read_raw
+      path = Pathname.new @file
+      Dir.chdir(File.dirname(path)) do
+        content = path.read
+        if content =~ /\A-{3}(.+[^\A])-{3}\n(.+)/m
+          @local_vars = YAML.safe_load($1.strip)
+          content = $2.strip
+        end
+        content
+      end
     end
   end
 end
 
+
+

data/lib/jekyll-liquid-plus/tags/wrap.rb

@@ -1,5 +1,4 @@
 require File.join File.expand_path('../../', __FILE__), 'helpers/include'
-require File.join File.expand_path('../../', __FILE__), 'tags/render'
 
 module LiquidPlus
   class WrapTag < Liquid::Block
@@ -17,7 +16,8 @@ module LiquidPlus
         back = $3
 
         partial = if @tag == 'wrap'
-          RenderTag.new('', @markup, []).render(context)
+          tag = IncludeTag.new('render', @markup, [])
+          tag.render(context)
         elsif @tag == 'wrap_include'
           Include.render(@markup, context)
         end

data/lib/jekyll-liquid-plus/version.rb

@@ -1,3 +1,3 @@
 module LiquidPlus
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/test/source/_includes/custom/include_layout.html

@@ -0,0 +1 @@
+*{{ content }}*

data/test/source/_layouts/custom/render_layout.html

@@ -0,0 +1 @@
+*{{ content }}*

data/test/source/_layouts/include.html

@@ -0,0 +1 @@
+{% include custom/include_layout.html %}

data/test/source/_layouts/render.html

@@ -0,0 +1 @@
+{% render _layouts/custom/render_layout.html %}

data/test/source/include.html

@@ -23,7 +23,6 @@ file.html → {% include (some_bool ? file.html : file2.html) %}
 ## Cascading include
 file.html → {% include not_there.html || file.html %}
 '' → '{% include not_there.html || none %}'
-From include.html: File 'not_there.html' not found in '_includes/' directory → {% include nothing || not_there.html %}
 
 ## Complex includes
 file2.html and variable → {% include (some_bool ? not_here : file.html) || file2.html var='variable' %}

data/test/source/include_layout.html

@@ -0,0 +1,4 @@
+---
+layout: include
+---
+success

data/test/source/render.html

@@ -27,7 +27,6 @@ file.html → {% render (some_bool ? f/file.html : f/file2.html) %}
 ## Cascading include
 file.html → {% render not_there.html || f/file.html %}
 '' → '{% render not_there.html or none %}'
-From render.html: File 'not_there.html' not found → {% render nothing || not_there.html %}
 
 ## Complex includes
 file2.html and variable → {% render (some_bool ? not_here : f/file.html) || f/file2.html var='variable' %}
@@ -39,3 +38,4 @@ file2.html and variable → {% render (some_bool ? not_here : f/file.html) || f/
 
 ## Render raw
 {% raw %}**{{ page.test_var }}{{ render.foo }}**{% endraw %} → {% render raw f/file3.md %}
+

data/test/source/render_layout.html

@@ -0,0 +1,4 @@
+---
+layout: render
+---
+success

data/test/source/wrap.html

@@ -20,7 +20,6 @@ layout: nil
 ## Cascading wrap
 [- file.html -] → {% wrap not_there.html || f/file.html %}[- {=yield} -]{% endwrap %}
 '' → '{% wrap not_there.html || none %}[- {=yield} -]{% endwrap %}'
-[- From wrap.html: File 'not_there.html' not found in '_includes/' directory -] → {% wrap_include nothing || not_there.html %}[- {=yield} -]{% endwrap_include %}
 
 ## Complex wraps
 [- file2.html and variable -] → {% wrap (some_bool ? not_here : f/file.html) || f/file2.html var='variable' %}[- {=yield} -]{% endwrap %}

data/test/test.rb

@@ -7,7 +7,10 @@ has_failed = false
 def test(path)
   path = Pathname.new path + '.html'
   failure = []
-  start = 0
+  start = 1
+  tests = ''
+  passed = 0
+  failed = 0
 
   f = File.new("source/#{path}")
   # Get the starting line (after the YAML FM) for source map
@@ -16,25 +19,57 @@ def test(path)
       break start = f.lineno + 1 
     end
   end
+  total = f.read.count('→')
 
   Dir.chdir('_site') do
     File.readlines(path).each_with_index do |line, i|
       if line =~ /(.+?)→(.+)/
         if $1.strip != $2.strip
+          failed += 1
+          tests << 'F'.red
           failure << " - line #{i+start}: #{$1}!=#{$2}"
+        else
+          passed += 1
+          tests << '.'.green
         end
       end
     end
   end
-  if failure.size > 0
-    puts "failed".red + ": #{path}"
+  if failed < 1 && passed < 1
+    puts "missed".yellow + ": #{path} " + "0/#{total}".yellow
+    has_failed = true
+  elsif failure.size > 0
+    puts "failed".red + ": #{path} #{tests} " + "#{passed}/#{total}".red
     puts failure.join "\n"
     has_failed = true
   else
-    puts "passed".green + ": #{path}" 
+    puts "passed".green + ": #{path} #{tests} " + "#{passed}/#{total}".green
+  end
+end
+
+def test_layout(path)
+  path = Pathname.new path + '.html'
+  failure = []
+  start = 0
+
+  f = File.new("source/#{path}")
+  # Get the starting line (after the YAML FM) for source map
+  f.each do |line|
+    if line =~ /---/ and f.lineno > 1
+      break start = f.lineno + 1 
+    end
+  end
+  Dir.chdir('_site') do
+    if path.read !~ /success/
+      puts "failed".red + ": #{path} 1/1".red
+      has_failed = true
+    else
+      puts "passed".green + ": #{path} " + "1/1".green
+    end
   end
 end
 
+
 `rm -rf _site/; bundle exec jekyll build --trace`
 
 # Test include
@@ -45,5 +80,8 @@ test 'wrap'
 test 'assign'
 test 'capture'
 test 'return'
+test_layout 'include_layout'
+test_layout 'render_layout'
+
 
 abort if has_failed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-liquid-plus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -90,16 +90,18 @@ files:
 - lib/jekyll-liquid-plus/tags/assign.rb
 - lib/jekyll-liquid-plus/tags/capture.rb
 - lib/jekyll-liquid-plus/tags/include.rb
-- lib/jekyll-liquid-plus/tags/render.rb
 - lib/jekyll-liquid-plus/tags/return.rb
 - lib/jekyll-liquid-plus/tags/wrap.rb
 - lib/jekyll-liquid-plus/version.rb
 - test/_config.yml
 - test/source/.gitignore
+- test/source/_includes/custom/include_layout.html
 - test/source/_includes/file.html
 - test/source/_includes/file2.html
 - test/source/_includes/file3.html
-- test/source/_layouts/default.html
+- test/source/_layouts/custom/render_layout.html
+- test/source/_layouts/include.html
+- test/source/_layouts/render.html
 - test/source/_plugins/liquid-plus.rb
 - test/source/assign.html
 - test/source/capture.html
@@ -109,7 +111,9 @@ files:
 - test/source/f/file4.html
 - test/source/f/file5.html
 - test/source/include.html
+- test/source/include_layout.html
 - test/source/render.html
+- test/source/render_layout.html
 - test/source/return.html
 - test/source/wrap.html
 - test/test.rb

data/lib/jekyll-liquid-plus/tags/render.rb

@@ -1,132 +0,0 @@
-# Title: Render Partial Tag for Jekyll
-# Author: Brandon Mathis
-# Description: Import files on your filesystem into any blog post and render them inline.
-# Note: Paths are relative to the source directory, if you import a file with yaml front matter, the yaml will be stripped out.
-#
-# Syntax {% render_partial path/to/file %}
-#
-# Example 1:
-# {% render_partial about/_bio.markdown %}
-#
-# This will import source/about/_bio.markdown and render it inline.
-# In this example I used an underscore at the beginning of the filename to prevent Jekyll
-# from generating an about/bio.html (Jekyll doesn't convert files beginning with underscores)
-#
-# Example 2:
-# {% render_partial ../README.markdown %}
-#
-# You can use relative pathnames, to include files outside of the source directory.
-# This might be useful if you want to have a page for a project's README without having
-# to duplicated the contents
-#
-#
-
-require File.join File.expand_path('../../', __FILE__), 'helpers/path'
-require File.join File.expand_path('../../', __FILE__), 'helpers/include'
-require 'jekyll'
-require 'yaml'
-require 'pathname'
-
-module Jekyll
-
-  # Create a new page class to allow partials to trigger Jekyll Page Hooks.
-  class ConvertiblePage
-    include Convertible
-    
-    attr_accessor :name, :content, :site, :ext, :output, :data
-    
-    def initialize(site, name, content)
-      @site     = site
-      @name     = name
-      @ext      = File.extname(name)
-      @content  = content
-      @data     = { layout: "no_layout" } # hack
-      
-    end
-    
-    def render(payload, info)
-      do_layout(payload, { no_layout: nil })
-    end
-  end
-end
-
-module LiquidPlus
-  class RenderTag < Liquid::Tag
-    def initialize(tag_name, markup, tokens)
-      @markup = markup.strip
-      super
-    end
-
-    def parse_markup
-      # If raw, strip from the markup as not to confuse the Path syntax parsing
-      if @markup =~ /^(\s*raw\s)?(.+?)(\sraw\s*)?$/
-        @markup = $2.strip
-        @raw = true unless $1.nil? and $3.nil?
-      end
-
-      # Separate params from markup
-      @markup, @params = Include.split_params(@markup)
-    end
-
-    def get_path(context)
-      if file = Path.parse(@markup, context)
-        path = Pathname.new Path.expand(file, context)
-        @markup = file
-        path
-      end
-    end
-
-    def render(context)
-      parse_markup
-      path = get_path(context)
-      if path and Cache.exists(path)
-
-        Dir.chdir(File.dirname(path)) do
-          content = path.read
-          
-          #Strip out yaml header from partials
-          if content =~ /\A-{3}(.+[^\A])-{3}\n(.+)/m
-            @local_vars = YAML.safe_load($1.strip)
-            content = $2.strip
-          end
-
-          if @raw
-            content
-          else
-            content = parse_params(content, context) if @params or @local_vars
-
-            page = Jekyll::ConvertiblePage.new(context.registers[:site], path, content)
-            payload = { 'page' => context.registers[:page] }.merge(context.registers[:site].site_payload)
-            page.render(payload, { registers: context.registers })
-            page.output.strip
-          end
-        end
-      elsif path
-        name = File.basename(path)
-        dir  = path.to_s.sub(context.registers[:site].source + '/', '')
-
-        msg  = "From #{context.registers[:page]['path']}: "
-        msg += "File '#{name}' not found"
-        msg += " in '#{dir}' directory" unless name == dir
-
-        puts msg.red
-        return msg
-      end
-    end
-
-    def parse_params(content, context)
-      if @params
-        markup = @markup + @params
-      end
-      partial = Liquid::Template.parse(content)
-
-      context.stack do
-        context['render'] = Jekyll::Tags::IncludeTag.new('', markup, []).parse_params(context) if @params
-        context['page'] = context['page'].deep_merge(@local_vars) if @local_vars and @local_vars.keys.size > 0
-        content = partial.render(context)
-      end
-      content
-    end
-  end
-end
-

data/test/source/_layouts/default.html

@@ -1,11 +0,0 @@
-<!DOCTYPE html>
-<html>
-    <head>
-        <meta charset="utf-8">
-        <title>{{ page.title }}</title>
-        <meta name="viewport" content="width=device-width">
-    </head>
-    <body>
-      {{ content }}
-    </body>
-</html>