jekyll-include-with-frontmatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a5b71118abd595b24591241083380854e1164f3f9f1cf6a0ee74be0c0c3c607
+  data.tar.gz: 4fb8b41eb56c7a7884025093309ed023bea65d0cecdd576f6726cdd8c5e1f292
+SHA512:
+  metadata.gz: c8529f69054697ce5e515b1233392f625520d2b9b30d6b2e53e1ee8ad328e3b349718ac638c0ba3b30e78e50613de09c4a52a5d140ba3444e1173b04ef4cbb9d
+  data.tar.gz: 52fba309410905f1cc734d82dab071e471ba5b56eed5397ebea8b3f2fa94bce7d6c244f41b43fe672d2600ebf730eeae5b8370b5d5da6cff3554ff108a033633

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enbled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Style/UnneededPercentQ:
+  Enabled: false
+Naming/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-include-with-frontmatter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    jekyll-include-with-frontmatter (0.1.0)
+      jekyll
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.4)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.9.25)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.5)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (2.1.2)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    minitest (5.11.3)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rouge (3.3.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    sass (3.7.2)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  jekyll-include-with-frontmatter!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kirk Haines
+
+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,62 @@
+# JekyllIncludeWithFrontmatterTag
+
+Jekyll's `include` and `include_relative` tags are straight includes -- they don't deal with files that have frontmatter.
+
+When working with a Jekyll site that uses Netlify CMS, though, one may want to be able to edit the includes via Netlify CMS. Netlify writes Markdown with frontmatter, though. The solution is to create a couple new tags, `includefm` and `includefm_relative`, which inherit from the Jekyll include tags, and add handling of frontmatter.
+
+Frontmatter gets treated as params passed into the include. If there is an include param with the same key as a frontmatter param, the include param takes precedence. Thus, frontmatter params can be thought of as defaults param values for the include.
+
+In all other ways, `includefm` and `includefm_relative` should work the same as `include` and `include_relative`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-include-with-frontmatter'
+```
+
+Also add a corresponding line to your Jekyll `config.yml`:
+
+```yaml
+plugins:
+  - jekyll-include-with-frontmatter
+
+```
+
+## Usage
+
+Files which are to be included can include frontmatter:
+
+```yaml
+---
+title: Documents
+---
+<div id="documents-column">
+  <div class="bg-blue">{{ include.title }}</div>
+  <div class="bg-grey"><a href="/media/pdfs/doc1.pdf" target="_blank">Document 1</a></div>
+  <div class="bg-grey"><a href="/media/pdfs/doc2.pdf" target="_blank">Document 2</a></div>
+  <div class="bg-grey"><a href="/media/pdfs/doc3.pdf" target="_blank">Document 3</a></div>
+</div>
+
+```
+
+In your post, page, or layout, you include with frontmatter like this:
+
+```liquid
+{% includefm documents.html %}
+```
+
+These tags should work just like the standard Jekyll include tags on files that do not include frontmatter, as well.
+
+## TODO
+
+There are, effectively, no tests. Tests are needed.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wyhaines/jekyll-include-with-frontmatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/jekyll-include-with-frontmatter.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path(File.join(__dir__,"lib"))
+puts "LIB IS #{lib}"
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-include-with-frontmatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-include-with-frontmatter'
+  spec.version       = JekyllIncludeWithFrontmatter::VERSION
+  spec.authors       = ['Kirk Haines']
+  spec.email         = ['wyhaines@gmail.com']
+
+  spec.summary       = %q(Jekyll include tags that will handle files with frontmatter.)
+  spec.description   = %q(The built in include tags don't handle files that have frontmatter. This will, and if the frontmatter is a hash, it will be used to populate params for the include.)
+  spec.homepage      = 'https://github.com/wyhaines/jekyll-include-with-frontmatter'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'jekyll'
+end

data/lib/jekyll-include-with-frontmatter.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'jekyll-include-with-frontmatter/version'
+require 'jekyll'
+require 'jekyll/tags/include'
+require 'yaml'
+
+# Implement includes that can handle frontmatter.
+class JekyllIncludeWithFrontmatter < Jekyll::Tags::IncludeTag
+  def render(context)
+    site = context.registers[:site]
+
+    file = render_variable(context) || @file
+    validate_file_name(file)
+
+    path = locate_include_file(context, file, site.safe)
+    return unless path
+
+    add_include_to_dependency(site, path, context)
+
+    partial, include_params = load_cached_partial(path, context)
+
+    context.stack do
+      parsed_params = @params ? parse_params(context) : nil
+
+      context['include'] = parsed_params ? include_params.merge(parsed_params) : include_params
+      begin
+        partial.render!(context)
+      rescue Liquid::Error => e
+        e.template_name = path
+        e.markup_context = 'included ' if e.markup_context.nil?
+        raise e
+      end
+    end
+  end
+
+  def load_cached_partial(path, context)
+    context.registers[:cached_partials] ||= {}
+    cached_partial = context.registers[:cached_partials]
+
+    unless cached_partial.key?(path)
+      unparsed_file = context.registers[:site]
+                             .liquid_renderer
+                             .file(path)
+      begin
+        file_data = read_file(path, context)
+        if (matchdata = file_data.match(/(---\n.*---\n)(.*)/m))
+          params = YAML.safe_load(matchdata[1])
+          cached_partial[path] = [unparsed_file.parse(matchdata[2]), params]
+        else
+          cached_partial[path] = [unparsed_file.parse(file_data), {}]
+        end
+      rescue Liquid::Error => e
+        e.template_name = path
+        e.markup_context = 'included ' if e.markup_context.nil?
+        raise e
+      end
+    end
+
+    cached_partial[path]
+  end
+end
+
+# Include relative to the source file. Blatantly stolen from Jekyll itself.
+class JekyllIncludeRelativeWithFrontmatter < JekyllIncludeWithFrontmatter
+  def tag_includes_dirs(context)
+    Array(page_path(context)).freeze
+  end
+
+  def page_path(context)
+    if context.registers[:page].nil?
+      context.registers[:site].source
+    else
+      site = context.registers[:site]
+      page_payload  = context.registers[:page]
+      resource_path = \
+        if page_payload['collection'].nil?
+          page_payload['path']
+        else
+          File.join(site.config['collections_dir'], page_payload['path'])
+        end
+      site.in_source_dir File.dirname(resource_path)
+    end
+  end
+end
+
+Liquid::Template.register_tag('includefm', JekyllIncludeWithFrontmatter)
+Liquid::Template.register_tag('includefm_relative', JekyllIncludeRelativeWithFrontmatter)

data/lib/jekyll-include-with-frontmatter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'jekyll/tags/include'
+class JekyllIncludeWithFrontmatter < Jekyll::Tags::IncludeTag
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-include-with-frontmatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirk Haines
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The built in include tags don't handle files that have frontmatter. This
+  will, and if the frontmatter is a hash, it will be used to populate params for the
+  include.
+email:
+- wyhaines@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-include-with-frontmatter.gemspec
+- lib/jekyll-include-with-frontmatter.rb
+- lib/jekyll-include-with-frontmatter/version.rb
+homepage: https://github.com/wyhaines/jekyll-include-with-frontmatter
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Jekyll include tags that will handle files with frontmatter.
+test_files: []