octopress-include-tag 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7a1eb9731c22637a2e63d07314c62301f14dbd9
-  data.tar.gz: ad2ee24cb9e540a07e2c5394a249c87804d88bc3
+  metadata.gz: 03549c58c4562c87f8cd15ac4e77470ddf764295
+  data.tar.gz: d790afdfb814d2e87174eb5891c22f5964c88d70
 SHA512:
-  metadata.gz: b50a57b7dfdd3e95e6ad51387a5a04d584dea262f29d9d7aab02799874a33714e21b17aa42aa0e621b68f5287a49f6681957a030b2d1477de0c5b52a5b869389
-  data.tar.gz: 3d4515c852bdfb5ee6aea0be22dd5e19419fd9ef1f614c2abdc8cb1592f5f4fe9595545754061737a992c6f01e1aee688188aebc723fd7183b867810b3d82d39
+  metadata.gz: f1a1056e268c4df190f8db75dd6e3cf115da9816539b94730d962c87e8f445230d3b49f187d6c37f65e496a3f2c5672fae7e145382644b359ae5f5d91b202b27
+  data.tar.gz: 52eddae1fe00e1492cbeb09f4261eef7b7a5503eb6c22e92808395f398be3307e0b5812742f0e6e6839f63f06340687d12daefb5d45f20bd64d2d306d029b731

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.jekyll-metadata

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.1.2 - 2015-05-12
+- Fix: Liquid 3 support improved
+- Minor: Now supports Jekyll 2 and 3.
+
 ### 1.1.1 - 2015-05-11
 
 - Minor: loosened Jekyll dependency version for Jekyll 3 support.

data/lib/octopress-include-tag.rb

@@ -5,50 +5,67 @@ require "jekyll"
 module Octopress
   module Tags
     module Include
-      class Tag < Liquid::Tag
-        PLUGIN_SYNTAX = /(.+?):(\S+)/
+      class Tag < Jekyll::Tags::IncludeTag
+        PLUGIN_SYNTAX = /(?<plugin>.+?):(?<path>\S+)\s?(?<other>.*)/
+        attr_accessor :path
+        attr_reader :tag_markup
+        attr_reader :tag_name
+        attr_accessor :filters
 
         def initialize(tag_name, markup, tokens)
-          super
-          @og_markup = @markup = markup
+          @tag_markup = markup
+          @tag_name = tag_name
+
+          if matched = markup.strip.match(PLUGIN_SYNTAX)
+            @plugin = matched['plugin'].strip
+            @path = matched['path'].strip
+          end
+
+          # Trigger Jekyll's Include tag with compatible markup
+          #
+          super(tag_name, safe_markup(markup).join(' '), tokens)
         end
 
-        def render(context)
-          return unless markup = TagHelpers::Conditional.parse(@markup, context)
-          if markup =~ TagHelpers::Var::HAS_FILTERS
-            markup = $1
-            filters = $2
+        # Strip specials out of markup so that it is suitable for Jekyll include tag
+        #
+        def safe_markup(markup)
+          file = markup.strip.match(/\S+/)[0]
+          params = ''
+
+          if matched = markup.match(VALID_SYNTAX)
+            params = matched[0]
           end
-          markup = TagHelpers::Var.evaluate_ternary(markup, context)
-          markup = TagHelpers::Path.parse(markup, context)
 
-          include_tag = Jekyll::Tags::IncludeTag.new('include', markup, [])
+          if matched = tag_markup.match(VARIABLE_SYNTAX)
+            file = matched['variable']
+          end
+
+          [file, params]
+        end
+
+        def render(context)
+
+          # Parse special markup until markup is simplified
+          return unless markup = parse_markup(context)
 
           # If markup references a plugin e.g. plugin-name:include-file.html
-          if markup.strip =~ PLUGIN_SYNTAX
-            plugin = $1
-            path = $2
-            begin
-              content = Octopress::Ink::Plugins.include(plugin, path).read
-            rescue => error
-              msg = "Include failed: {% #{@tag_name} #{@og_markup}%}.\n"
-              if !defined?(Octopress::Ink)
-                msg += "To include plugin partials, first install Octopress Ink."
-              else
-                msg += "The plugin '#{plugin}' does not have an include named '#{path}'."
-              end
-              raise IOError.new(msg)
-            end
-            partial = Liquid::Template.parse(content)
-            content = context.stack {
-              context['include'] = include_tag.parse_params(context)
-              context['plugin'] = Octopress::Ink::Plugins.plugin(plugin).config(context['lang'])
-              partial.render!(context)
-            }.strip
+          #
+          if matched = markup.strip.match(PLUGIN_SYNTAX)
+
+            # Call Octopress Ink to render the plugin's include file
+            #
+            content = render_ink_include(matched['plugin'], matched['path'], context)
             
-          # Otherwise, use Jekyll's default include tag
           else
-            content = include_tag.render(context).strip
+
+            # use Jekyll's default include tag
+            #
+            # Why safe_markup again? In initialize we didn't know what the path would be becuase 
+            # we needed the context to parse vars and conditions. Now that we know them, we'll 
+            # reset @file and @params as intended in order to render with Jekyll's include tag.
+            # 
+            @file, @params = safe_markup(markup)
+            content = super(context).strip
           end
 
           unless content.nil? || filters.nil?
@@ -57,6 +74,57 @@ module Octopress
 
           content
         end
+
+        # Parses special markup, handling vars, conditions, and filters
+        # Returns:
+        #  - include path or nil if markup conditionals evaluate false
+        #
+        def parse_markup(context)
+          # If conditional statements are present, only continue if they are true
+          #
+          return unless markup = TagHelpers::Conditional.parse(tag_markup, context)
+
+          # If there are filters, store them for use later and strip them out of markup
+          #
+          if matched = markup.match(TagHelpers::Var::HAS_FILTERS)
+            markup = matched['markup']
+            @filters = matched['filters']
+          end
+
+          # If there is a ternary expression, replace it with the true result
+          #
+          markup = TagHelpers::Var.evaluate_ternary(markup, context)
+
+          # Paths may be variables, check context to retrieve proper path
+          #
+          markup = TagHelpers::Path.parse(markup, context)
+
+          markup
+        end
+
+        # Call Octopress Ink to render the plugin's include file
+        #
+        def render_ink_include(plugin, file, context)
+          begin
+            content = Octopress::Ink::Plugins.include(plugin, path).read
+          rescue => error
+            msg = "Include failed: {% #{tag_name} #{tag_markup}%}.\n"
+            if !defined?(Octopress::Ink)
+              msg += "To include plugin partials, first install Octopress Ink."
+            else
+              msg += "The plugin '#{plugin}' does not have an include named '#{path}'."
+            end
+            raise IOError.new(msg)
+          end
+
+          partial = Liquid::Template.parse(content)
+
+          context.stack {
+            context['include'] = parse_params(context)
+            context['plugin'] = Octopress::Ink::Plugins.plugin(plugin).config(context['lang'])
+            partial.render!(context)
+          }.strip
+        end
       end
     end
   end

data/lib/octopress-include-tag/version.rb

@@ -1,7 +1,7 @@
 module Octopress
   module Tags
     module Include
-      VERSION = "1.1.1"
+      VERSION = "1.1.2"
     end
   end
 end

data/octopress-include-tag.gemspec

@@ -25,4 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "clash"
   spec.add_development_dependency "octopress-ink"
   spec.add_development_dependency "octopress"
+
+  if RUBY_VERSION >= "2"
+    spec.add_development_dependency "pry-byebug"
+  end
 end

data/test/_expected/includes.html

@@ -5,6 +5,7 @@ Testing Include → Testing Include
 
 ## Include from var
 Testing Include → Testing Include
+Testing Include → Testing Include
 
 ## Local var passing
 Testing Include var_test → Testing Include var_test

data/test/_ink_plugins/test-plugin/test.rb

@@ -3,6 +3,7 @@ require 'octopress-ink'
 Octopress::Ink.add_plugin({
   name:        'Test Plugin',
   slug:        'test-plugin',
+  type:        'plugin',
   assets_path: File.expand_path(File.dirname(__FILE__)),
   description: "Test some plugins y'all"
 })

data/test/includes.html

@@ -8,6 +8,7 @@ Testing Include → {% include foo.html %}
 
 ## Include from var
 Testing Include → {% include page.partial %}
+Testing Include → {% include {{ page.partial }} %}
 
 ## Local var passing
 Testing Include var_test → {% include foo.html some_var="var_test" %}
@@ -26,4 +27,4 @@ Testing Include var_test → {% include foo.html some_var="var_test" if some_boo
 
 ## Ternary include
 Testing Include → {% include (false ? bar.html : foo.html ) %}
-Testing Include → {% include (some_bool ? foo.html : theme:greet.html) %}
+Testing Include → {% include (some_bool ? foo.html : test-plugin:greet.html) %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-include-tag
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-tag-helpers
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - brandon@imathis.com