jekyll-template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb4983307a8165900476e04a6bd8d5fb17769664
+  data.tar.gz: 86dfecc8cafe326dce8ea6196743d85d59795509
+SHA512:
+  metadata.gz: 3198b7b9334c33fbefdb5f81a3234a8625aa1d36c54d7e6dc88fee0d6ce6a365a09a9bd44163c4f6456ad96a62a942c579b7f1d2d28c32ab31c39094a1b036b3
+  data.tar.gz: 74d56f7273f2bdc8b3146dc60564f0126f632f804b0a8161e64aef088bc17fa24497178a29d007c90fe9835fff620d07748c16f1724c619f47c9eb77cc40773e

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+gem "jekyll", "3.1.2"
+gem "htmlcompressor", "~> 0.3.1"
+gem "unindent", "~> 1.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Help Scout
+
+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,19 @@
+# Jekyll::Template
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-template'
+```
+
+And then execute:
+```
+bundle
+```
+
+Or install it yourself as:
+```
+gem install jekyll-template
+```

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/template"
+
+# 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

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-template.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-template"
+  spec.version       = Jekyll::Template::VERSION
+  spec.authors       = ["ItsJonQ"]
+  spec.email         = ["itsjonq@gmail.com"]
+
+  spec.summary       = "Custom template blocks with YAML support"
+  spec.homepage      = "https://github.com/helpscout/jekyll-template"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency("jekyll", "3.1.2")
+  spec.add_runtime_dependency("htmlcompressor", "~> 0.3.1")
+  spec.add_runtime_dependency("unindent", "~> 1.0")
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jekyll/template/version.rb

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

data/lib/jekyll/template.rb

@@ -0,0 +1,199 @@
+require "htmlcompressor"
+require "jekyll"
+require "jekyll/template/version"
+require "unindent"
+
+module Jekyll
+  module Tags
+    class TemplateBlock < Liquid::Block
+      include Liquid::StandardFilters
+      Syntax = /(#{Liquid::QuotedFragment}+)?/
+
+      # YAML REGEXP
+      # https://github.com/jekyll/jekyll/blob/35c5e073625100b0f8f8eab6f7da6cb6d5734930/lib/jekyll/document.rb
+      YAML_FRONT_MATTER_REGEXP = %r!(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m
+
+      # initialize
+      # Description: Extends Liquid's default initialize method.
+      def initialize(tag_name, markup, tokens)
+        super
+        @root_path = false
+        @template_content = false
+
+        # @template_name = markup
+        if markup =~ Syntax
+
+          @template_name = $1
+          @attributes = {}
+          @sanitize = false
+
+          # Parse parameters
+          # Source: https://gist.github.com/jgatjens/8925165
+          markup.scan(Liquid::TagAttributes) do |key, value|
+            @attributes[key] = Liquid::Expression.parse(value)
+          end
+        else
+          raise SyntaxError.new(options[:locale].t("errors.syntax.include".freeze))
+        end
+      end
+
+      # parse_content
+      # Description: Extends Liquid's default parse_content method.
+      def parse_content(context, content)
+        content
+      end
+
+      # render
+      # Description: Extends Liquid's default render method. This method also
+      # adds additional features:
+      # - YAML front-matter parsing and handling
+      # - properly handles indentation and whitespace (resolves renderin issues)
+      # - ability to parse content as markdown vs. html
+      # - supports custom attributes to be used in template
+      def render(context)
+        content = super
+        # Remove leading whitespace
+        # content = content.lstrip
+        compressor = HtmlCompressor::Compressor.new
+        site = context.registers[:site]
+        template = load_template(context)
+
+        # Define the default template attributes
+        # Source:
+        # https://github.com/Shopify/liquid/blob/9a7778e52c37965f7b47673da09cfb82856a6791/lib/liquid/tags/include.rb
+        context["template_name"] = context.evaluate(@template_name)
+        context["partial"] = true
+        context["template"] = Hash.new
+
+        # Parse and extend template's front-matter with content front-matter
+        content = parse_front_matter(content)
+
+        # Setting template attributes from @attributes
+        # This allows for @attributes to be used within the template as
+        # {{ template.atttribute_name }}
+        if @attributes
+          @attributes.each do |key, value|
+            # Render the attribute(s) with context
+            if value.instance_of? Liquid::VariableLookup
+              # val = value.name
+              val = context.evaluate(value)
+            else
+              val = context.evaluate(value)
+            end
+            context["template"][key] = val
+
+            # Adjust sanitize if parse: html
+            if (key == "parse") && (val == "html")
+              @sanitize = true
+            end
+          end
+        end
+
+        content = parse_content(context, content)
+
+        # sanitize
+        # Determines whether to parse as HTML or markdown
+        unless @sanitize
+          converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
+          content = content.to_s.unindent
+          @content = converter.convert(content)
+        else
+          @content = content.to_s.unindent
+        end
+
+        # handling empty content
+        if @content.empty?
+          @content = "<!-- Template: #{ @template_name } -->"
+        end
+
+        # setting the template content
+        context["template"]["content"] = @content
+
+        # rendering the template with the content
+        @output = template.render( context )
+        # normalizes whitespace and indentation
+        @output = compressor.compress(@output)
+      end
+
+      # get_template_content(template)
+      # Description: Opens, reads, and returns template content as string.
+      # Returns: Template content
+      # @param    template    { string }
+      def get_template_content(template)
+        # default template path
+        view = "_templates/" + template
+        file_path = File.join(@root_path, view)
+        path = File.read(file_path.strip)
+        # returns template content
+        path
+      end
+
+      # load_template(template)
+      # Description: Extends Liquid's default load_template method. Also provides
+      # extra enhancements:
+      # - parses and sets template front-matter content
+      # Returns: Template class
+      def load_template(context)
+        # Set the root_path
+        @root_path = context.registers[:site].source
+        # Set the template_content
+        @template_content = get_template_content(@template_name)
+        # Parse front matter
+        @template_content = parse_front_matter(@template_content)
+
+        if @template_content
+          Liquid::Template.parse(@template_content)
+        else
+          raise Liquid::SyntaxError, "Could not find #{view} in your templates"
+        end
+      end
+
+      # unindent(content)
+      # Description: Removes initial indentation.
+      # Returns: Content (string).
+      # @param    content    { string }
+      def unindent(content)
+        # Remove initial whitespace
+        content = content.gsub(/^\s*\n/, "")
+
+        # Remove indentations
+        whitespace_regex = %r!^\s*!m
+        if content =~ whitespace_regex
+          indentation = Regexp.last_match(0)
+          content = content.gsub(indentation, "")
+        end
+
+        content
+      end
+
+      # parse_front_matter(content)
+      # Description: Parses and sets YAML front-matter content.
+      # Returns: Template content, with front-matter removed.
+      # @param    content    { string }
+      def parse_front_matter(content)
+        # Strip leading white-spaces
+        compressor = HtmlCompressor::Compressor.new({
+          :preserve_line_breaks => true
+        })
+        content = unindent(content)
+
+        if content =~ YAML_FRONT_MATTER_REGEXP
+          front_matter = Regexp.last_match(0)
+          # Push YAML data to the template's attributes
+          values = SafeYAML.load(front_matter)
+          # Set YAML data to @attributes
+          values.each do |key, value|
+            @attributes[key] = value
+          end
+          # Returns content with stripped front-matter
+          content = content.gsub(front_matter, "")
+        end
+
+        compressor.compress(content)
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_tag("template", Jekyll::Tags::TemplateBlock)

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ItsJonQ
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: htmlcompressor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: unindent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: 
+email:
+- itsjonq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-template.gemspec
+- lib/jekyll/template.rb
+- lib/jekyll/template/version.rb
+homepage: https://github.com/helpscout/jekyll-template
+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
+signing_key: 
+specification_version: 4
+summary: Custom template blocks with YAML support
+test_files: []