initial commit

Author: benbalter

.gitignore

@@ -0,0 +1,2 @@
+spec/examples.txt
+*.gem

.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+Metrics/BlockLength:
+    Exclude:
+      - spec/**/*

.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 2.2
+before_install: gem install bundler
+language: ruby
+script: script/cibuild
+sudo: false
+cache: bundler

Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    jekyll-include-cache (0.1.0)
+      jekyll (~> 3.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ast (2.3.0)
+    colorator (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.14)
+    forwardable-extended (2.6.0)
+    jekyll (3.3.1)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.0)
+      sass (~> 3.4)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    kramdown (1.13.1)
+    liquid (3.0.6)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    mercenary (0.3.6)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    pathutil (0.14.0)
+      forwardable-extended (~> 2.6)
+    powerpack (0.1.1)
+    public_suffix (2.0.4)
+    rainbow (2.1.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rouge (1.11.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    safe_yaml (1.0.4)
+    sass (3.4.22)
+    unicode-display_width (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll-include-cache!
+  rspec (~> 3.5)
+  rubocop (~> 0.43)
+
+BUNDLED WITH
+   1.13.6

README.md

@@ -0,0 +1,57 @@
+# Jekyll Include Cache
+
+*A Jekyll plugin to cache the rendering of Liquid includes*
+
+## What it does
+
+If you have a computationally expensive include (such as a sidebar or navigation), Jekyll Include Cache renders the include once, and then reuses the output any time that includes is called with the same arguments, potentially speeding up your site's build significantly.
+
+## Usage
+
+1. Add the following to your site's Gemfile:
+
+  ```ruby
+  gem 'jekyll-include-cache'
+  ```
+
+2. Add the following to your site's config file:
+
+  ```yml
+  gems:
+    - jekyll-include_cache
+  ```
+
+3. Replace `{% include foo.html %}` in your template with `{% include_cached foo.html %}`
+
+## One potential gotcha
+
+For Jekyll Include Cache to work, you cannot rely on the page context to pass variables to your include (e.g., `assign foo=bar` or `page.title`). Instead, you must explicitly pass all variables to the include as arguments, and reference them within the include as `include.foo` (instead of `page.foo` or just `foo`).
+
+### Good
+
+In your template:
+
+```liquid
+{% include_cached shirt.html size=medium color=red %}
+```
+
+In your include:
+
+```liquid
+Buy our {{ include.color }} shirt in {{ include.size }}!
+```
+
+### Bad
+
+In your template:
+
+```liquid
+{% assign color=blue %}
+{% include_cached shirt.html %}
+```
+
+In your include:
+
+```liquid
+Buy our {{ color }} shirt in {{ page.size }}!
+```

jekyll-include-cache.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'jekyll-include-cache/version'
+
+Gem::Specification.new do |s|
+  s.name          = "jekyll-include-cache"
+  s.version       = JekyllIncludeCache::VERSION
+  s.authors       = ["Ben Balter"]
+  s.email         = ["ben.balter@github.com"]
+  s.homepage      = "https://github.com/benbalter/jekyll-include-cache"
+  s.summary       = "A Jekyll plugin to cache the rendering of Liquid includes"
+
+  s.files         = `git ls-files app lib`.split("\n")
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.license       = "MIT"
+
+  s.add_dependency "jekyll", "~> 3.3"
+  s.add_development_dependency "rubocop", "~> 0.43"
+  s.add_development_dependency "rspec", "~> 3.5"
+end

lib/jekyll-include-cache.rb

@@ -0,0 +1,7 @@
+require "jekyll"
+
+module JekyllIncludeCache
+  autoload :Tag, "jekyll-include-cache/tag"
+end
+
+Liquid::Template.register_tag("include_cached", JekyllIncludeCache::Tag)

lib/jekyll-include-cache/tag.rb

@@ -0,0 +1,36 @@
+require "digest/md5"
+
+module JekyllIncludeCache
+  class Tag < Jekyll::Tags::IncludeTag
+    def render(context)
+      path   = path(context)
+      params = parse_params(context) if @params
+      return unless path
+
+      key    = key(path, params)
+      cached = cache(context)[key]
+
+      if cached
+        cached
+      else
+        cache(context)[key] = super
+      end
+    end
+
+    private
+
+    def path(context)
+      site   = context.registers[:site]
+      file   = render_variable(context) || @file
+      locate_include_file(context, file, site.safe)
+    end
+
+    def key(path, params)
+      Digest::MD5.hexdigest(path.to_s + params.to_s)
+    end
+
+    def cache(context)
+      context.registers[:cached_includes] ||= {}
+    end
+  end
+end