jekyll-conrefifier 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 065d8f8c53f11bc9a9e5a8657fba8844228da1d1
-  data.tar.gz: 5cd34e692c71e470491b88c5ed4629fff3ad0e6a
+  metadata.gz: db0d778b5e1e0ab68919ef23d08c1f1715304823
+  data.tar.gz: 28a2c9ccdf9de238f5ed558f1ae4d079b46699a6
 SHA512:
-  metadata.gz: b67b2493701b2b63cd47bf639837dfe6435df9707b12062fd56ad39c9a9ec24b3c38e668520e070fc71742821e4d4429722cbe012f96080f3994d5dd1c74f221
-  data.tar.gz: ef625b18abef60fae8b637c7c9b492dc813faba80c3b2bdf0d0413758b14a80e17b3636c3ed94b51bb0333d2670878b037f56cca5aefd968b0e49e1d838ad9c4
+  metadata.gz: ca4756a3697919d534c876cf379bfd7e025e261674884ebc18a37b672166684f7bb136ad9400b7c7bc598fe2dd02f5763b10b8f37df6e5aa652026adb1de8805
+  data.tar.gz: 7855026b72a8fff240054bc38842080b04d37bc9a9554247e02ffab0e88763051944fabc649b312c1ed83a37055dce25cc7dbe79f76c5bad12f68b2e5071ab9a

data/README.md

@@ -114,3 +114,30 @@ data_file_variables:
 ```
 
 In this case, every data file has a `page.version` of `2.0`. However, only data files prefixed with `ent`, containing one or more word characters (`\w+`), and followed by an underscore (`_`), have a value of `2.1`.
+
+## Rendering filtered data files in layouts
+
+As an addition to the above, a new tag, `data_render`, can be used to iterate over filtered data files.
+
+You can call this filter by:
+
+* Passing a data file name to `data_render`
+* Passing any optional variables to this filter
+* The YAML information will be temporarily stored within `site.data.data_render`
+* You can iterate over `site.data.data_render` to walk along the data
+* Multiple calls to `data_render` rewrite to `site.data.data_render`
+
+Here's an example:
+
+``` liquid
+{% data_render site.data.filtered_categories(:version => 2.0) %}
+
+{% for category_hash in site.data.data_render %}
+  {% assign category_title    = category_hash[0] %}
+  {% assign category_articles = category_hash[1] %}
+  {{ category_title }}
+  {{ category_articles }}
+{% endfor %}
+```
+
+Note that data files are read *once*, to improve performance. The variables passed in are evaluated for each call.

data/lib/jekyll-conrefifier.rb

@@ -1,16 +1,3 @@
-class Hash
-  def insert_before(key, kvpair)
-    arr = to_a
-    pos = arr.index(arr.assoc(key))
-    if pos
-      arr.insert(pos, kvpair)
-    else
-      arr << kvpair
-    end
-    replace Hash[arr]
-  end
-end
-
 module Jekyll
   class Document
     alias_method :old_read, :read
@@ -32,7 +19,6 @@ module Jekyll
 
   class Site
     alias_method :old_read, :read
-    alias_method :old_read_data_to, :read_data_to
 
     def in_source_dir(*paths)
       paths.reduce(source) do |base, path|
@@ -40,7 +26,7 @@ module Jekyll
       end
     end
 
-    # allows us to filter data file content out on conditionals, eg. `{% if page.version == ... %}`
+    # allows us to filter data file contents via conditionals, eg. `{% if page.version == ... %}`
     def read_data_to(dir, data)
       return unless File.directory?(dir) && (!safe || !File.symlink?(dir))
 
@@ -48,8 +34,9 @@ module Jekyll
         Dir['*.{yaml,yml,json,csv}'] + Dir['*'].select { |fn| File.directory?(fn) }
       end
 
+      # all of this is copied from the Jekyll source, except...
       entries.each do |entry|
-        path = in_source_dir(dir, entry)
+        path = self.in_source_dir(dir, entry)
         next if File.symlink?(path) && safe
 
         key = sanitize_filename(File.basename(entry, '.*'))
@@ -60,61 +47,107 @@ module Jekyll
           when '.csv'
             data[key] = CSV.read(path, :headers => true).map(&:to_hash)
           else
+            # if we hit upon if/unless conditionals, we'll need to pause and render them
             contents = File.read(path)
             if (matches = contents.scan /(\{% (?:if|unless).+? %\}.*?\{% end(?:if|unless) %\})/m)
-              unless matches.empty?
-                contents = apply_vars_to_datafile(contents, path, matches, config['data_file_variables'])
+              unless data_file_variables(path).nil?
+                contents = contents.gsub(/\{\{/, '[[')
+                contents = apply_vars_to_datafile(contents, matches, path)
               end
             end
             data[key] = SafeYAML.load(contents)
           end
         end
       end
+
+      # once we're all done, we need to iterate once more to parse out `{{ }}` blocks.
+      # two reasons for this: one, we need to collect every data file before attempting to
+      # parse these vars; two, the Liquid parse above obliterates these tags, so we
+      # first need to convert them into `[[ }}`, and *then* continue with the parse
+      data.each_pair do |datafile, value|
+        yaml_dump = YAML::dump value
+        yaml_dump = yaml_dump.gsub(/\[\[/, '{{')
+
+        data[datafile] = SafeYAML.load transform_liquid_variables(yaml_dump, datafile)
+      end
+    end
+
+    # apply the custom scoope plus the rest of the `site.data` information
+    def apply_vars_to_datafile(contents, matches, path)
+      return contents if matches.empty?
+
+      data_vars = path.nil? ? {} : data_file_variables(path)
+
+      config = { 'page' => data_vars }
+      config = { 'site' => { 'data' => self.data } }.merge(config)
+
+      matches.each do |match|
+        contents = contents.sub(match.first, Liquid::Template.parse(match.first).render(config))
+      end
+
+      contents
     end
 
-    def apply_vars_to_datafile(contents, path, matches, data_file_variables)
-      return contents if data_file_variables.nil?
+    # fetch the custom scope vars, as defined in _config.yml
+    def data_file_variables(path)
       data_vars = {}
-      scopes = data_file_variables.select { |v| v['scope']['path'].empty? || Regexp.new(v['scope']['path']) =~ path }
+      scopes = config['data_file_variables'].select { |v| v['scope']['path'].empty? || Regexp.new(v['scope']['path']) =~ path }
       scopes.each do |scope|
         data_vars = data_vars.merge(scope['values'])
       end
-      temp_config = self.config.merge({ 'page' => data_vars })
-      matches.each do |match|
-        contents = contents.sub(match.first, Liquid::Template.parse(match.first).render(temp_config))
-      end
 
-      contents
+      data_vars
     end
 
     # 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
-      keys_to_modify = {}
-      old_read
-      data.each_pair do |data_file, data_set|
-        if data_set.is_a? Hash
-          data_set.each_pair do |key, values|
-            if key =~ /\{\{.+?\}\}/
-              new_key = Liquid::Template.parse(key).render({ "site" => { "data" => data }.merge(config) })
-              keys_to_modify[key] = new_key
-            end
-            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
-          keys_to_modify.each_pair do |old_key, new_key|
-            data[data_file].insert_before(old_key, [new_key, data[data_file][old_key]])
-            data[data_file].delete(old_key)
-          end
-        end
+    def transform_liquid_variables(contents, path=nil)
+      if (matches = contents.scan /(\{\{.+?\}\})/)
+        contents = apply_vars_to_datafile(contents, matches, path)
       end
+
+      contents
     end
   end
+
+  class DataRenderTag < Liquid::Tag
+    def initialize(tag_name, text, tokens)
+      super
+
+      keys = text.strip.split('.', 3)
+      keys.shift(2) # this is just site.data
+      paren_arg = keys.last.match(/\((.+?)\)/)
+      unless paren_arg.nil?
+        last_key = keys.last.sub(paren_arg[0], '')
+        keys.pop
+        keys << last_key
+        @hash_args = paren_arg[1].gsub(/[{}:]/,'').split(', ').map{|h| h1,h2 = h.split('=>'); {h1.strip => h2.strip}}.reduce(:merge)
+      end
+      @keys = keys
+      @id = keys.join('-')
+    end
+
+    def fetch_datafile(context, keys)
+      data_file = context.registers[:site].data["data_render_#{@id}"]
+      return data_file unless data_file.nil?
+
+      path = @id.sub('.', '/')
+      data_source = File.join(context.registers[:site].source, context.registers[:site].config['data_source'])
+      data_file = File.read("#{data_source}/#{path}.yml")
+      context.registers[:site].data["data_render_#{@id}"] = data_file
+    end
+
+    def render(context)
+      datafile = fetch_datafile(context, @keys)
+
+      config = { 'page' => @hash_args }
+      config = { 'site' => { "data" => context.registers[:site].data } }.merge(config)
+      versioned_yaml = SafeYAML.load(Liquid::Template.parse(datafile).render(config))
+      context.registers[:site].data['data_render'] = versioned_yaml
+      nil
+    end
+  end
+
+  Liquid::Template.register_tag('data_render', Jekyll::DataRenderTag)
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllConrefifier
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/conrefifier_spec.rb

@@ -10,7 +10,7 @@ describe("Conrefifier") do
   end
 
   it "writes the proper content for values after fetching info from a data file" do
-    index_file = @dest.join("index.html")
+    index_file = @dest.join('index.html')
     expect(index_file).to exist
     index_contents = File.read(index_file)
     expect(index_contents).to include("GitHub Glossary")
@@ -34,7 +34,7 @@ describe("Conrefifier") do
     filtered_index_file = @dest.join("filtered_index.html")
     expect(filtered_index_file).to exist
     filtered_index_contents = File.read(filtered_index_file)
-    expect(filtered_index_contents).to include("GitHub Glossary")
+    expect(filtered_index_contents).to include("GitHub Enterprise Glossary")
     expect(filtered_index_contents).to include("Fork A Repo")
     expect(filtered_index_contents).to include("Article v2.0")
     expect(filtered_index_contents).to include("Still show")
@@ -46,11 +46,22 @@ describe("Conrefifier") do
     enterprise_filtered_index = @dest.join("enterprise_filtered_index.html")
     expect(enterprise_filtered_index).to exist
     filtered_index_contents = File.read(enterprise_filtered_index)
-    expect(filtered_index_contents).to include("GitHub Glossary")
+    expect(filtered_index_contents).to include("GitHub Enterprise Glossary")
     expect(filtered_index_contents).to include("Fork A Repo")
     expect(filtered_index_contents).to include("Article v2.1")
     expect(filtered_index_contents).to include("Still show")
     expect(filtered_index_contents).to_not include("Article v2.0")
     expect(filtered_index_contents).to_not include("Ignored")
   end
+
+  it 'uses the data_render tag to provide filtered data in a layout' do
+    filtering_layout = @dest.join("filtering_layout.html")
+    expect(filtering_layout).to exist
+    filtering_layout_contents = File.read(filtering_layout)
+    expect(filtering_layout_contents).to include('GitHub Enterprise Glossary')
+    expect(filtering_layout_contents.scan(/Bootcamp/).count).to eq(2)
+    expect(filtering_layout_contents.scan(/Article v2.1/).count).to eq(1)
+    expect(filtering_layout_contents.scan(/Article v2.0/).count).to eq(1)
+    expect(filtering_layout_contents.scan(/Ignored/).count).to eq(1)
+  end
 end

data/spec/fixtures/_config.yml

@@ -22,6 +22,11 @@ data_file_variables:
       path: ""
     values:
       version: "2.0"
+  -
+    scope:
+      path: "^categories"
+    values:
+      version: "dotcom"
   -
     scope:
       path: "ent\\w+_"

data/spec/fixtures/_data/categories.yml

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

data/spec/fixtures/_data/conrefs.yml

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

data/spec/fixtures/_data/enterprise_filtered_categories.yml

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

data/spec/fixtures/_data/filtered_categories.yml

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

data/spec/fixtures/_layouts/filtering_layout.html

@@ -0,0 +1,20 @@
+
+{% data_render site.data.filtered_categories(:version => 2.0) %}
+
+{% for category_hash in site.data.data_render %}
+  {% assign category_title    = category_hash[0] %}
+  {% assign category_articles = category_hash[1] %}
+  {{ category_title }}
+  {{ category_articles }}
+{% endfor %}
+
+{{ content }}
+
+{% data_render site.data.filtered_categories(:version => 2.1) %}
+
+{% for category_hash in site.data.data_render %}
+  {% assign category_title    = category_hash[0] %}
+  {% assign category_articles = category_hash[1] %}
+  {{ category_title }}
+  {{ category_articles }}
+{% endfor %}

data/spec/fixtures/filtering_layout.html

@@ -0,0 +1,5 @@
+---
+layout: filtering_layout
+---
+
+test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-conrefifier
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -80,8 +80,10 @@ files:
 - spec/fixtures/_data/enterprise_filtered_categories.yml
 - spec/fixtures/_data/filtered_categories.yml
 - spec/fixtures/_layouts/article.html
+- spec/fixtures/_layouts/filtering_layout.html
 - spec/fixtures/enterprise_filtered_index.html
 - spec/fixtures/filtered_index.html
+- spec/fixtures/filtering_layout.html
 - spec/fixtures/index.html
 - spec/spec_helper.rb
 homepage: ''