jekyll-conrefifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fd6a5071f7e5ace52c45ef3f8847acac7aae9db
+  data.tar.gz: 64f0ce2548156487bfa205675ed0e54fbec2a387
+SHA512:
+  metadata.gz: a08a27b34f9ad08e591294f0eebb97ca1ac2f0b855925dfec43a1bfdb0cbaaa7e933b31e794c5b5ccbe35f85e4d6c5b1fc043a1e27ba59a2c99170134ee17869
+  data.tar.gz: 79b585769a377eae919f873c0c48e71cd50a8f4141477cadc39de9a5397a3c00de531e6cbdeffef345a37e100302999fa6f961f90755bca6a9cc886d81979db7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures/_site

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0
+  - 1.9.3
+script: "script/cibuild"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-html-pipeline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Garen J. Torikian
+
+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,56 @@
+# jekyll-conrefifier
+
+A set of monkey patches that allows you to use Liquid variables in a variety of places in Jekyll.
+
+## Substitutions within frontmatter
+
+You can include Liquid variables in your frontmatter, like this:
+
+``` markdown
+---
+title: This is very {{ site.data.conrefs.product_type }}
+---
+
+Some page.
+```
+
+In this case, title would equals the value of `product_type` in [a data file](http://jekyllrb.com/docs/datafiles/) called *conrefs*.
+
+## Per-audience filtering
+
+You can scope your variables to an audience value. For example, given a conref file that looks like this:
+
+``` yaml
+product_name:
+  dotcom: GitHub
+  2.0: GitHub Enterprise
+  11.10.340: GitHub Enterprise
+```
+
+And a file that looks like this:
+
+``` markdown
+---
+title: Welcome to {{ site.data.conrefs.product_name[site.audience] }}
+---
+
+Some other page.
+```
+
+The title renders through `product_name`, then the value of `site.audience` to become "Welcome to GitHub".
+
+## Substitutions within data files
+
+Your data files can also rely on Liquid substitution. For example, given a data file called *categories.yml* that looks like this:
+
+``` yaml
+Bootcamp:
+  - Set Up Git
+  - Create A Repo
+  - Fork A Repo
+  - Be Social
+  - '{{ site.data.conrefs.product_name[site.audience] }} Glossary'
+  - Good Resources for Learning Git and GitHub
+```
+
+The value renders out to "GitHub Glossary", just like above.

data/Rakefile

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

data/jekyll-conrefifier.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-conrefifier"
+  spec.version       = JekyllConrefifier::VERSION
+  spec.authors       = ["Garen J. Torikian"]
+  spec.email         = ["gjtorikian@gmail.com"]
+  spec.summary       = %q{Allows you to use Liquid variables in various places in Jekyll}
+  spec.description   = %q{A set of monkey patches that allows you to use Liquid variables in a variety of places in Jekyll, like frontmatter or data files.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "jekyll",    "~> 2.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/jekyll-conrefifier.rb

@@ -0,0 +1,43 @@
+module Jekyll
+  class Document
+    alias_method :old_read, :read
+
+    # allow us to use any variable within Jekyll Frontmatter; for example:
+    # title: What are {{ site.data.conrefs.product_name[site.audience] }} Pages?
+    # renders as "GitHub Pages?" for dotcom, but "GitHub Enterprise Pages?" for Enterprise
+    def read(opts = {})
+      old_read(opts)
+      @data.each_pair do |key, value|
+        if value =~ /\{\{.+?\}\}/
+          value = Liquid::Template.parse(value).render({ "site" => { "data" => @site.data }.merge(@site.config) })
+          @data[key] = value
+        end
+      end
+    end
+  end
+
+  class Site
+    alias_method :old_read, :read
+
+    # allow us to use any variable within Jekyll data files; for example:
+    # - '{{ site.data.conrefs.product_name[site.audience] }} Glossary'
+    # renders as "GitHub Glossary" for dotcom, but "GitHub Enterprise Glossary" for Enterprise
+    def read
+      old_read
+      data.each_pair do |data_file, data_set|
+        if data_set.is_a? Hash
+          data_set.each_pair do |key, values|
+            if values.is_a? Array
+              values.each_with_index do |value, i|
+                if value =~ /\{\{.+?\}\}/
+                  value = Liquid::Template.parse(value).render({ "site" => { "data" => data }.merge(config) })
+                  data[data_file][key][i] = value
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module JekyllConrefifier
+  VERSION = "0.0.1"
+end

data/script/cibuild

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+script/bootstrap > /dev/null 2>&1
+bundle exec rake spec

data/spec/conrefifier_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe("Conrefifier") do
+  it "writes the proper page for simple substitutions" do
+    expect(@dest.join("articles", "this-is-very-amazing", "index.html")).to exist
+  end
+
+  it "writes the proper page for compicated substitutions" do
+    expect(@dest.join("articles", "welcome-to-github", "index.html")).to exist
+  end
+
+  it "writes the proper content after fetching info from a data file" do
+    index_file = @dest.join("index.html")
+    expect(index_file).to exist
+    index_contents = File.read(index_file)
+    expect(index_contents).to include("GitHub Glossary")
+  end
+end

data/spec/fixtures/_articles/filtered_frontmatter.md

@@ -0,0 +1,5 @@
+---
+title: Welcome to {{ site.data.conrefs.product_name[site.audience] }}
+---
+
+Some other page.

data/spec/fixtures/_articles/simple_frontmatter.md

@@ -0,0 +1,5 @@
+---
+title: This is very {{ site.data.conrefs.product_type }}
+---
+
+Some page.

data/spec/fixtures/_config.yml

@@ -0,0 +1,9 @@
+gems:
+  - jekyll-conrefifier
+
+collections:
+  articles:
+    output: true
+    permalink: /articles/:title/
+
+audience: 'dotcom'

data/spec/fixtures/_data/categories.yml

@@ -0,0 +1,7 @@
+Bootcamp:
+  - Set Up Git
+  - Create A Repo
+  - Fork A Repo
+  - Be Social
+  - '{{ site.data.conrefs.product_name[site.audience] }} Glossary'
+  - Good Resources for Learning Git and GitHub

data/spec/fixtures/_data/conrefs.yml

@@ -0,0 +1,6 @@
+product_name:
+  dotcom: GitHub
+  2.0: GitHub Enterprise
+  11.10.340: GitHub Enterprise
+
+product_type: 'Amazing'

data/spec/fixtures/index.html

@@ -0,0 +1,26 @@
+---
+---
+<ul id="categories">
+{% for category_hash in site.data.categories %}
+  {% assign category_title    = category_hash[0] %}
+  {% assign category_articles = category_hash[1] %}
+
+  <li class="category">
+
+    <h5>
+      <span class="handle"></span>
+      <a href="{{ site.baseurl }}/categories/{{ category_title | slugify }}">{{ category_title }}</a>
+    </h5>
+
+    <ul class="chevron list">
+    {% for title in category_articles %}
+      <li class="article">
+        <a href="{{ site.baseurl }}/articles/{{ title | slugify }}" class="km-article-link">{{ title }}</a>
+      </li>
+    {% endfor %}
+    </ul>
+
+  </li>
+
+{% endfor %}
+</ul>

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+require "jekyll"
+require File.expand_path("lib/jekyll-conrefifier.rb")
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:each) do
+    Jekyll.logger.log_level = :error
+
+    @fixtures_path = Pathname.new(__FILE__).parent.join("fixtures")
+    @dest        = @fixtures_path.join("_site")
+    @posts_src   = @fixtures_path.join("_posts")
+    @layouts_src = @fixtures_path.join("_layouts")
+    @plugins_src = @fixtures_path.join("_plugins")
+
+    @site = Jekyll::Site.new(Jekyll.configuration({
+      "source"      => @fixtures_path.to_s,
+      "destination" => @dest.to_s,
+      "plugins"     => @plugins_src.to_s,
+      "collections" => {
+        "articles" => {"output" => true},
+        "authors"  => {}
+      }
+    }))
+
+    @dest.rmtree if @dest.exist?
+    @site.process
+  end
+
+  # config.after(:each) do
+  #   @dest.rmtree if @dest.exist?
+  # end
+
+  def unpublished_doc
+    @site.collections["authors"].docs.first
+  end
+
+  def setup_doc(doc_filename)
+    @site.collections["articles"].docs.find { |d| d.relative_path.match(doc_filename) }
+  end
+
+  def setup_post(file)
+    Jekyll::Post.new(@site, @fixtures_path.to_s, '', file)
+  end
+
+  def setup_page(file)
+    Jekyll::Page.new(@site, @fixtures_path.to_s, File.dirname(file), File.basename(file))
+  end
+
+  def destination_file_exists?(file)
+    File.exists?(File.join(@dest.to_s, file))
+  end
+
+  def destination_file_contents(file)
+    File.read(File.join(@dest.to_s, file))
+  end
+
+  def destination_doc_contents(collection, file)
+    File.read(File.join(@dest.to_s, collection, file))
+  end
+
+  def new_redirect_page(permalink)
+    page = JekyllRedirectFrom::RedirectPage.new(@site, @site.source, "", "")
+    page.data['permalink'] = permalink
+    page
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-conrefifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Garen J. Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A set of monkey patches that allows you to use Liquid variables in a
+  variety of places in Jekyll, like frontmatter or data files.
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-conrefifier.gemspec
+- lib/jekyll-conrefifier.rb
+- lib/version.rb
+- script/cibuild
+- spec/conrefifier_spec.rb
+- spec/fixtures/_articles/filtered_frontmatter.md
+- spec/fixtures/_articles/simple_frontmatter.md
+- spec/fixtures/_config.yml
+- spec/fixtures/_data/categories.yml
+- spec/fixtures/_data/conrefs.yml
+- spec/fixtures/index.html
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Allows you to use Liquid variables in various places in Jekyll
+test_files: []