jekyll-conrefifier 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b141310c3df7fca97c24ae754be72b0ff12ee0f
-  data.tar.gz: b8a63143e9b008761854ac7636cf8b5beaf5dad6
+  metadata.gz: a3be384c388b690824874267ef348482dda86d27
+  data.tar.gz: 157ee1105193aac294cbbd2b9c84e6113951de4c
 SHA512:
-  metadata.gz: 33fd2ef748ede4f79f9b978bcb791c87c2f05e84cd9852d04801f102810768e17c88046ea02295e16299cb96646150b07ba615a64a5c2fb166c390b779bde9cb
-  data.tar.gz: 1b18365f1e4115cb5ba7cce2a0ea465499b79abe073d64519ccf34e5d5fb19186af14ea1650a8fbcfac9faf880bbf298f82d48948f196f1e251dcf2b22043e02
+  metadata.gz: 262e12f3d372e557388b9a0d156392c7d2f9a856daaef6984cb8ddd144ace9bcd8dd585d67ae9bf527240fbd7c44bd9485e9f8c5130ba820ba63514033acb0a2
+  data.tar.gz: 51ab2c709f54d4915a8e6c9b69da097c57b3ee06c9a035312ae0c96fdab38b32ebcf29c432a7ac9d419d1977ecd3099f667a2c7ee7c7e432f7ced32867f70593

data/README.md

@@ -56,3 +56,61 @@ Bootcamp:
 ```
 
 The value renders out to "GitHub Glossary", just like above.
+
+## Liquid filtering within data files
+
+You can add filters within data files, to show or hide content depending on certain variable criteria.
+
+For example, given a data file that looks like this:
+
+``` yaml
+Listing:
+  {% if page.version == '2.0' %}
+  - Article v2.0
+  {% endif %}
+  {% if page.version != '2.0' %}
+  - Article v2.1
+  {% endif %}
+
+{% unless page.version == '2.0' %}
+Ignored:
+  - Item1
+  - Item 2
+{% endunless %}
+```
+
+If `page.version` is equal to `'2.0'`, only `Listing: - Artivle v2.0` will render.
+
+To support such a syntax, you'll need to add a new entry in your `config.yml` that defines your variables, like this:
+
+``` yaml
+
+data_file_variables:
+  -
+    scope:
+      path: ""
+    values:
+      version: "2.0"
+
+```
+
+`data_file_variables` is an array of hashes. The `scope` key defines which data files are affected by the variables; the data file must match the path define in `path`. Regular expression syntaxes are supported in `path`, and a blank `path` refers to every data file. The `values` key specifies every key you want to support in your data file.
+
+Here's a more complex example:
+
+``` yaml
+data_file_variables:
+  -
+    scope:
+      path: ""
+    values:
+      version: "2.0"
+  -
+    scope:
+      path: "ent\\w+_"
+    values:
+      version: "2.1"
+
+```
+
+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`.

data/lib/jekyll-conrefifier.rb

@@ -22,7 +22,7 @@ module Jekyll
       old_read(opts)
       @data.each_pair do |key, value|
         if value =~ /\{\{.+?\}\}/
-          value = Liquid::Template.parse(value).render({ "site" => { "data" => @site.data }.merge(@site.config) })
+          value = Liquid::Template.parse(value).render({ 'site' => { 'data' => @site.data }.merge(@site.config) })
           @data[key] = Jekyll::Renderer.new(@site, self).convert(value)
           @data[key] = @data[key].sub(/^<p>/, '').sub(/<\/p>$/, '').strip
         end
@@ -32,6 +32,61 @@ 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|
+        Jekyll.sanitized_path(base, path)
+      end
+    end
+
+    # allows us to filter data file content out on conditionals, eg. `{% if page.version == ... %}`
+    def read_data_to(dir, data)
+      return unless File.directory?(dir) && (!safe || !File.symlink?(dir))
+
+      entries = Dir.chdir(dir) do
+        Dir['*.{yaml,yml,json,csv}'] + Dir['*'].select { |fn| File.directory?(fn) }
+      end
+
+      entries.each do |entry|
+        path = in_source_dir(dir, entry)
+        next if File.symlink?(path) && safe
+
+        key = sanitize_filename(File.basename(entry, '.*'))
+        if File.directory?(path)
+          read_data_to(path, data[key] = {})
+        else
+          case File.extname(path).downcase
+          when '.csv'
+            data[key] = CSV.read(path, :headers => true).map(&:to_hash)
+          else
+            contents = File.read(path)
+            if (matches = contents.scan /(\{% (?:if|unless).+? %\}.*?\{% end(?:if|unless) %\})/m)
+              unless matches.empty?
+                filename = File.basename(path)
+                contents = apply_vars_to_datafile(contents, filename, matches, config['data_file_variables'])
+              end
+            end
+            data[key] = SafeYAML.load(contents)
+          end
+        end
+      end
+    end
+
+    def apply_vars_to_datafile(contents, filename, matches, data_file_variables)
+      return contents if data_file_variables.nil?
+      data_vars = {}
+      scopes = data_file_variables.select { |v| v['scope']['path'].empty? || Regexp.new(v['scope']['path']) =~ filename }
+      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
+    end
 
     # allow us to use any variable within Jekyll data files; for example:
     # - '{{ site.data.conrefs.product_name[site.audience] }} Glossary'

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllConrefifier
-  VERSION = "0.1.2"
+  VERSION = '0.2.0'
 end

data/spec/conrefifier_spec.rb

@@ -29,4 +29,28 @@ describe("Conrefifier") do
     index_contents = File.read(index_file)
     expect(index_contents).to include("<strong>wow!</strong>")
   end
+
+  it 'filters simple items' 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("Fork A Repo")
+    expect(filtered_index_contents).to include("Article v2.0")
+    expect(filtered_index_contents).to include("Still show")
+    expect(filtered_index_contents).to_not include("Article v2.1")
+    expect(filtered_index_contents).to_not include("Ignored")
+  end
+
+  it 'filters items when a prefix is provided' 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("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
 end

data/spec/fixtures/_config.yml

@@ -15,3 +15,15 @@ defaults:
       layout: "article"
 
 audience: 'dotcom'
+
+data_file_variables:
+  -
+    scope:
+      path: ""
+    values:
+      version: "2.0"
+  -
+    scope:
+      path: "ent\\w+_"
+    values:
+      version: "2.1"

data/spec/fixtures/_data/categories.yml

@@ -7,4 +7,4 @@ Bootcamp:
   - Good Resources for Learning Git and GitHub
 
 '{{ site.data.conrefs.product_type }}':
-  - Something something
+  - Something something

data/spec/fixtures/_data/enterprise_filtered_categories.yml

@@ -0,0 +1,25 @@
+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
+
+Listing:
+  {% if page.version == '2.0' %}
+  - Article v2.0
+  {% endif %}
+  {% if page.version != '2.0' %}
+  - Article v2.1
+  {% endif %}
+  - Wow
+  {% if page.version == '2.0' or page.version == '2.1' %}
+  - Still show
+  {% endif %}
+
+{% unless page.version == '2.1' %}
+Ignored:
+  - Item1
+  - Item 2
+{% endunless %}

data/spec/fixtures/_data/filtered_categories.yml

@@ -0,0 +1,25 @@
+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
+
+Listing:
+  {% if page.version == '2.0' %}
+  - Article v2.0
+  {% endif %}
+  {% if page.version != '2.0' %}
+  - Article v2.1
+  {% endif %}
+  - Wow
+  {% if page.version == '2.0' or page.version == '2.1' %}
+  - Still show
+  {% endif %}
+
+{% unless page.version == '2.0' %}
+Ignored:
+  - Item1
+  - Item 2
+{% endunless %}

data/spec/fixtures/enterprise_filtered_index.html

@@ -0,0 +1,26 @@
+---
+---
+<ul id="categories">
+{% for category_hash in site.data.enterprise_filtered_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/fixtures/filtered_index.html

@@ -0,0 +1,26 @@
+---
+---
+<ul id="categories">
+{% for category_hash in site.data.filtered_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>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-conrefifier
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -77,7 +77,11 @@ files:
 - spec/fixtures/_config.yml
 - spec/fixtures/_data/categories.yml
 - spec/fixtures/_data/conrefs.yml
+- spec/fixtures/_data/enterprise_filtered_categories.yml
+- spec/fixtures/_data/filtered_categories.yml
 - spec/fixtures/_layouts/article.html
+- spec/fixtures/enterprise_filtered_index.html
+- spec/fixtures/filtered_index.html
 - spec/fixtures/index.html
 - spec/spec_helper.rb
 homepage: ''