jekyll-plugin-include 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67a5391d4ca7a662d4dff68b38f89cf2298fdd0b
+  data.tar.gz: c93679e4e7c5c20988799f17df0442ac1097e0fe
+SHA512:
+  metadata.gz: dd80fb512d2079f508d041c28db5181cacf55dc65c8cbc32431592f5fff22ed352f3b654a87d34b65ae9662ca309486a550ba59384ae7f80af2ff2c53ddd5c01
+  data.tar.gz: f53b13e87781963957b397fcbc97744de4f09c71e7c51519d104d088a68dce527fe2048fdfd816debfa733457fb4f0c17440aeb9a834617906e3f3ae40df5150

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/RedundantReturn:
+  Enabled: False
+Style/TrailingCommaInArrayLiteral:
+  Enabled: False
+Style/TrailingCommaInHashLiteral:
+  Enabled: False
+
+Metrics/AbcSize:
+  Max: 25
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Christopher Peterson
+
+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,81 @@
+jekyll-plugin-include
+=====================
+
+A Jekyll liquid tag plugin which allows includes directly from plugins' `_include` directories, with optional ability to override with files present in site includes_dir (if they exist).
+
+Normally, Jekyll's `include` tag can only search for files in the site's single configured includes directory (and that of the *theme* plugin, if it using one). That means that if a plugin wants to provide you with a template/fragment via includes, the best it can do is ask you to copy it into your own repo manually.
+
+This plugin then makes it easy to use includes that ship *with* a plugin directly *from* a plugin. And if a modified version of the file is provided in the site's own includes directory, it can intelligently use that one instead!
+
+And for plugin developers, this provides a way to ship and use includes without leaning on the user to manage the unmodified files themselves.
+
+# Requirements
+
+* Jekyll static site generator
+* A build process that runs somewhere other than Github pages (as this is a custom plugin)
+
+# Installation
+
+You can add a Rubygems-hosted Jekyll plugin (like this one) to your site by either adding adding it to your `_config` or to your `Gemfile`. you can also use it in your own gem-based plugin by adding it to your gemspec.
+
+## gemfile install (recommended)
+
+Add to the `jekyll_plugins` group in your `Gemfile`.
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-plugin-include"
+end
+```
+
+## Jekyll `_config` install
+
+Add it to the array `plugins` in your `_config.yml`:
+```yaml
+plugins:
+  - jekyll-plugin-include
+```
+
+# For use in your own gem-based plugin (gemspec)
+
+Add something like this to your gemspec
+```ruby
+spec.add_runtime_dependency "jekyll-plugin-include", ">= 0.1.0"
+```
+# Usage
+
+Note: quotes are required for arguments with spaces, and whitespace after the `:` is acceptable
+
+This plugin provides a single custom Jekyll Liquid tag which provides enhanced include-like functionality, so it will look a lot like the standard `include`.
+
+In this example with the `jekyll-podcast` plugin, this will function much like Jekyll's normal `include` (inserting the rendered contents of `includefile.html`), but will look in the `_includes` directory of the specified plugin if it doesn't find the file in the site's configured includes directory.
+
+```liquid
+{% plugin_include plugin:"jekyll-podcast" file: "podcast_feed_episode_content_encoded.html" %}
+```
+
+It is also possible to *force* this plugin to skip the site's configured includes directory completely and look exclusively in the plugin's `_includes` directory with the `allow_override` parameter:
+
+```liquid
+{% plugin_include plugin:"jekyll-podcast" file: "podcast_feed_misc.xml" allow_override: false %}
+```
+
+## Include parameters
+
+Any parameters passed to the include besides `_plugin` and `_file` will be passed through as-is and will be available as `include.param_name` in the file.
+
+# Testing
+
+* syntax: a .rubocop.yml is provided. `rubocop lib/jekyll/plugin-include.rb`
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/decipher-media/jekyll-plugin-include.
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# Credits
+
+By [Christopher Peterson](https://chrispeterson.info) for [Decipher Media](https://github.com/decipher-media/jekyll-plugin-include).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/plugin/include"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-plugin-include.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll_plugin_include/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-plugin-include"
+  spec.version       = Jekyll::PluginInclude::VERSION
+  spec.authors       = ["Decipher Media"]
+  spec.email         = ["deciphermediatv@gmail.com"]
+  spec.summary       = %q{A Jekyll liquid tag plugin which allows includes directly from plugins' _include directories, with optional ability to override with equivalently-named files present in site includes_dir (if they exist).}
+  spec.description   = %q{A Jekyll liquid tag plugin which allows includes directly from plugins' `_include` directories, with optional ability to override with files present in site includes_dir (if they exist).
+
+Normally, Jekyll's `include` tag can only search for files in the site's single configured includes directory (and that of the *theme* plugin, if it using one). That means that if a plugin wants to provide you with a template/fragment via includes, the best it can do is ask you to copy it into your own repo manually.
+
+This plugin then makes it easy to use includes that ship *with* a plugin directly *from* a plugin. And if a modified version of the file is provided in the site's own includes directory, it can intelligently use that one instead!
+
+And for plugin developers, this provides a way to ship and use includes without leaning on the user to manage the unmodified files themselves.}
+  spec.homepage      = "https://github.com/decipher-media/jekyll-plugin-include"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", ['>= 3.8', '< 4.0']
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.59.1"
+end

data/lib/jekyll-plugin-include.rb

@@ -0,0 +1,96 @@
+require "jekyll_plugin_include/version"
+# rubocop:disable Metrics/MethodLength
+
+module Jekyll
+  module PluginInclude
+    class Tag < Liquid::Tag
+      VARIABLE_SYNTAX = /
+          (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
+          (?<params>.*)
+       /x
+
+      def initialize(tagname, content, tokens)
+        super
+
+        @attributes = { '_allow_override' => 'true' }
+        content.scan(::Liquid::TagAttributes) do |key, value|
+          # Strip quotes from around attribute values
+          @attributes[key] = value.gsub(/^['"]|['"]$/, '')
+        end
+
+        gem_root = Gem::Specification.find_by_name(@attributes['_plugin']).gem_dir
+        @gem_includes = File.join(gem_root, '_includes')
+        @site_root = Jekyll.configuration({})['source']
+        @site_includes_dir = File.join(
+          @site_root,
+          Jekyll.configuration({})['includes_dir']
+        )
+      end
+
+      def render(context)
+        searchpath = if @attributes['_allow_override'] == 'true'
+                       [
+                         @site_includes_dir,
+                         @gem_includes,
+                       ]
+                     else
+                       [
+                         @gem_includes,
+                         @site_includes_dir,
+                       ]
+                     end
+
+        file = render_variable(
+          context,
+          @attributes['_file']
+        ) || @attributes['_file']
+
+        # Pass on the include params minus ours
+        pass_params = @attributes
+        pass_params.delete('_plugin')
+        pass_params.delete('_file')
+        pass_params.delete('_allow_override')
+        context['include'] = pass_params
+
+        file = findfile(searchpath, file)
+        if file.nil?
+          raise 'podcast_include could not find the file '\
+            "\"#{@attributes['_file']}\"."
+        else
+          f = File.read(file, context.registers[:site].file_read_opts)
+          partial = Liquid::Template.parse(f)
+          partial.render!(context)
+        end
+      end
+
+      # Render the variable if required (@see https://goo.gl/N5sMV3)
+      def render_variable(context, var)
+        return unless var.match(VARIABLE_SYNTAX)
+
+        partial = context.registers[:site]
+                         .liquid_renderer
+                         .file('(variable)')
+                         .parse(var)
+        return partial.render!(context)
+      end
+
+      def findfile(path, filename)
+        file = nil
+
+        path.each do |dir|
+          testfile = File.join(dir, filename)
+          if File.file?(testfile)
+            file = testfile
+            break
+          end
+        end
+
+        return file
+      end
+
+      Liquid::Template.register_tag 'plugin_include', self
+    end
+  end
+end
+
+# rubocop:enable Metrics/MethodLength

data/lib/jekyll_plugin_include/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module PluginInclude
+      VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-plugin-include
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Decipher Media
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.1
+description: |-
+  A Jekyll liquid tag plugin which allows includes directly from plugins' `_include` directories, with optional ability to override with files present in site includes_dir (if they exist).
+
+  Normally, Jekyll's `include` tag can only search for files in the site's single configured includes directory (and that of the *theme* plugin, if it using one). That means that if a plugin wants to provide you with a template/fragment via includes, the best it can do is ask you to copy it into your own repo manually.
+
+  This plugin then makes it easy to use includes that ship *with* a plugin directly *from* a plugin. And if a modified version of the file is provided in the site's own includes directory, it can intelligently use that one instead!
+
+  And for plugin developers, this provides a way to ship and use includes without leaning on the user to manage the unmodified files themselves.
+email:
+- deciphermediatv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-plugin-include.gemspec
+- lib/jekyll-plugin-include.rb
+- lib/jekyll_plugin_include/version.rb
+homepage: https://github.com/decipher-media/jekyll-plugin-include
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: A Jekyll liquid tag plugin which allows includes directly from plugins' _include
+  directories, with optional ability to override with equivalently-named files present
+  in site includes_dir (if they exist).
+test_files: []