nanoc-conref-fs 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb197585dc561db562827e176ec5e27d9df500c4
-  data.tar.gz: 8d990f45b2470c99d3894a40d6e0542ef43bf467
+  metadata.gz: 8cf69ee6e85496e24ff25128d9013457aba33741
+  data.tar.gz: dbed8da256b719eb52d1bda8640919060b3ab3e0
 SHA512:
-  metadata.gz: 3072389a547de1101eca906624333c9d75184a2247bc07c3d97313924da6fa0109d2c9de38824918fbde11f56f372c38f14edec215a12e6fe3568172b9920f68
-  data.tar.gz: 9ac746f06c7256cb58bc0ec16f3f02ebe1ed93b648e9c15719c5ba1f754d899af8acdb84562662dd30e65b5da241e6ff165355b1769531a59bfcdad9b397988b
+  metadata.gz: ab9faf957d43bc03944a47499989ae4f3fca7bcefe1a0976ad0c81a9776bc4315736a5d60fec3eac23203888a592882617f6b767dedb974845313bc7c7688c20
+  data.tar.gz: 751bdef5e71b825daffc335964334be1e14c237cbd5be52055ca83fcc5fcd2d8aa69c971614aac9bede21efffd8df655d2e184747dc609727f3a1d4cc1559f8b

data/README.md

@@ -76,8 +76,15 @@ See the tests for further usage of these conditionals. In both cases, `path` is
 
 ### Associating files with data
 
-If you have a special `data_association` value, additional metadata to items will be applied. Right now, this only adds a `parent` type to each item.
+If you have a special `data_association` value, additional metadata to items will be applied:
+
+* An attribute called `:parents`, which adds the parent "map topic" to an item.
+* An attribute called `:children`, which adds any children of a "map topic."
 
 ### Retrieving variables
 
 You can retrieve the stored data at any time (for example, in a layout) by calling `VariableMixin.variables`.
+
+### Retrieving data files
+
+You can fetch anything in the *data* folder by passing in a string, demarcated with `.`s, to `VariableMixin.fetch_data_file`. For example, `VariableMixin.fetch_data_file('reusables.intro')` will fetch the file in *data/reusables/intro.yml*.

data/lib/nanoc-conref-fs/conref-fs.rb

@@ -9,6 +9,16 @@ module VariableMixin
   def self.variables=(variables)
     @variables = variables
   end
+
+  def self.fetch_data_file(association)
+    reference = association.split('.')
+    variables = VariableMixin.variables
+    data = variables['site']['data']
+    while key = reference.shift
+      data = data[key]
+    end
+    data
+  end
 end
 
 class ConrefFS < Nanoc::DataSource
@@ -28,28 +38,47 @@ class ConrefFS < Nanoc::DataSource
     super
   end
 
-  def self.fetch_variables
-    @variables
-  end
-
   # This function calls the parent super, then adds additional metadata to the item.
   def parse(content_filename, meta_filename, _kind)
     meta, content = super
     page_vars = Conrefifier.file_variables(@site_config[:page_variables], content_filename)
     unless page_vars[:data_association].nil?
       association = page_vars[:data_association]
-      reference = association.split('.')
-      toc = @variables['site']['data']
-      while key = reference.shift
-        toc = toc[key]
-      end
-      meta['parents'] = find_parents(toc, meta['title'])
+      toc = VariableMixin.fetch_data_file(association)
+      meta['parents'] = if toc.is_a?(Array)
+                          find_array_parents(toc, meta['title'])
+                        else
+                          find_hash_parents(toc, meta['title'])
+                        end
+
+      meta['children'] = if toc.is_a?(Array)
+                           find_array_children(toc, meta['title'])
+                         else
+                           find_hash_children(toc, meta['title'])
+                         end
+    end
+    page_vars.each_pair do |name, value|
+      meta[name.to_s] = value
     end
     [meta, content]
   end
 
-  # Given a category file, this method finds its parent.
-  def find_parents(toc, title)
+  # Given a category file that's an array, this method finds
+  # the parent of an item
+  def find_array_parents(toc, title)
+    parents = ''
+    toc.each do |item|
+      if item.is_a?(Hash)
+        parents = find_hash_parents(item, title)
+        break unless parents.empty?
+      end
+    end
+    parents
+  end
+
+  # Given a category file that's a hash, this method finds
+  # the parent of an item
+  def find_hash_parents(toc, title)
     parents = ''
     toc.keys.each do |key|
       toc[key].each do |item|
@@ -73,6 +102,41 @@ class ConrefFS < Nanoc::DataSource
     parents
   end
 
+
+    # Given a category file that's an array, this method finds
+    # the children of an item, probably a map topic
+    def find_array_children(toc, title)
+      children = ''
+      toc.each do |item|
+        next unless item.is_a?(Hash)
+        item.each_pair do |key, values|
+          if key == title
+            children = values.flatten
+            break
+          end
+        end
+        break unless children.empty?
+      end
+      children
+    end
+
+    # Given a category file that's a hash, this method finds
+    # the children of an item, probably a map topic
+    def find_hash_children(toc, title)
+      children = ''
+      toc.keys.each do |key|
+        toc[key].each do |item|
+          next unless item.is_a?(Hash)
+          unless item[title].nil?
+            children = item.values.flatten
+            break
+          end
+        end
+        break unless children.empty?
+      end
+      children
+    end
+
   # This file reads each piece of content as it comes in. It also applies the conref variables
   # (demarcated by Liquid's {{ }} tags) using both the data/ folder and any variables defined
   # within the nanoc.yaml config file

data/nanoc-conref-fs.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'nanoc-conref-fs'
-  spec.version       = '0.2.1'
+  spec.version       = '0.3.0'
   spec.authors       = ['Garen Torikian']
   spec.email         = ['gjtorikian@gmail.com']
   spec.summary       = 'A Nanoc filesystem to permit using conrefs/reusables in your content.'

data/test/conref_fs_test.rb

@@ -86,7 +86,19 @@ class DatafilesTest < MiniTest::Test
     end
   end
 
-  def test_missing_cateogory_title_does_not_blow_up_parents
+  def test_it_renders_array_parents
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('parents', 'array_parents')
+      test_file = read_test_file('parents', 'array_parents')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_missing_category_title_does_not_blow_up_parents
     with_site(name: FIXTURES_DIR) do |site|
 
       site = Nanoc::Int::SiteLoader.new.new_from_cwd
@@ -98,6 +110,18 @@ class DatafilesTest < MiniTest::Test
     end
   end
 
+  def test_it_applies_any_attribute
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('attributes', 'attribute')
+      test_file = read_test_file('attributes', 'attribute')
+      assert_equal output_file, test_file
+    end
+  end
+
   def test_it_obfuscates_content
     with_site(name: FIXTURES_DIR) do |site|
 
@@ -124,4 +148,32 @@ class DatafilesTest < MiniTest::Test
       assert_equal output_file, test_file
     end
   end
+
+  def test_it_renders_hash_children
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('children', 'hash_children')
+      test_file = read_test_file('children', 'hash_children')
+      assert_equal output_file, test_file
+
+      output_file = read_output_file('children', 'later_hash_children')
+      test_file = read_test_file('children', 'later_hash_children')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_it_renders_array_children
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('children', 'array_children')
+      test_file = read_test_file('children', 'array_children')
+      assert_equal output_file, test_file
+    end
+  end
 end

data/test/datafiles_test.rb

@@ -7,7 +7,7 @@ class DatafilesTest < MiniTest::Test
 
   def test_it_collects_the_files
     files = Datafiles.collect_data(File.join(FIXTURES_DIR, 'data'))
-    names = %w(categories/category reusables/intro reusables/names variables/empty variables/product)
+    names = %w(categories/category categories/simple reusables/intro reusables/names variables/empty variables/product)
     names.map! { |name| File.join(FIXTURES_DIR, 'data', "#{name}.yml") }
     assert_equal files, names
   end

data/test/fixtures/Rules

@@ -7,6 +7,8 @@ end
 compile '/**/*.md' do
   if item[:filename] =~ /retrieve/
     layout '/retrieve.*'
+  elsif item[:filename] =~ /_children/
+    layout '/children.*'
   else
     layout '/default.*'
   end

data/test/fixtures/content/attributes/attribute.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Testing attributes
+  </title>
+</head>
+
+<body>
+  wow!
+
+</body>
+</html>

data/test/fixtures/content/attributes/attribute.md

@@ -0,0 +1,3 @@
+---
+title: Testing attributes
+---

data/test/fixtures/content/children/array_children.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Creating a new organization account
+  </title>
+</head>
+
+<body>
+
+  ["About organizations", "Creating a new organization from scratch"]
+
+</body>
+</html>

data/test/fixtures/content/children/array_children.md

@@ -0,0 +1,3 @@
+---
+title: Creating a new organization account
+---

data/test/fixtures/content/children/hash_children.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Managing branches in your repository
+  </title>
+</head>
+
+<body>
+
+
+Here they are!
+
+
+  ["About branches", "Setting the default branch", "Viewing branches in your repository", "Creating and deleting branches within your repository"]
+
+</body>
+</html>

data/test/fixtures/content/children/hash_children.md

@@ -0,0 +1,5 @@
+---
+title: Managing branches in your repository
+---
+
+Here they are!

data/test/fixtures/content/children/later_hash_children.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Some other things
+  </title>
+</head>
+
+<body>
+
+
+
+  ["Blah1", "Blah2"]
+
+</body>
+</html>

data/test/fixtures/content/children/later_hash_children.md

@@ -0,0 +1,3 @@
+---
+title: Some other things
+---

data/test/fixtures/content/parents/array_parents.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Creating a new organization from scratch
+  </title>
+</head>
+
+<body>
+
+  Creating a new organization account
+
+Array parent.
+
+</body>
+</html>

data/test/fixtures/content/parents/array_parents.md

@@ -0,0 +1,5 @@
+---
+title: Creating a new organization from scratch
+---
+
+Array parent.

data/test/fixtures/data/categories/category.yml

@@ -7,3 +7,7 @@ Collaborating:
     - Setting the default branch
     - Viewing branches in your repository
     - Creating and deleting branches within your repository
+
+  - Some other things:
+    - Blah1
+    - Blah2

data/test/fixtures/data/categories/simple.yml

@@ -0,0 +1,5 @@
+- Set Up Git
+- Create A Repo
+- Creating a new organization account:
+  - About organizations
+  - Creating a new organization from scratch

data/test/fixtures/layouts/children.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  <%= @item[:title] %>
+  </title>
+</head>
+
+<body>
+
+  <%= yield %>
+
+  <%= @item[:children] %>
+
+</body>
+</html>

data/test/fixtures/layouts/default.html

@@ -7,7 +7,7 @@
 </head>
 
 <body>
-
+  <% if @item[:title] =~ /Testing attributes/ %><%= @item[:just_a_key] %><% end %>
   <%= @item[:intro] %>
   <%= @item[:parents] %>
   <%= yield %>

data/test/fixtures/nanoc.yaml

@@ -13,6 +13,19 @@ page_variables:
     values:
       version: "dotcom"
       data_association: "categories.category"
+      just_a_key: wow!
+  -
+    scope:
+      path: "array_parents"
+    values:
+      version: "dotcom"
+      data_association: "categories.simple"
+  -
+    scope:
+      path: "array_children"
+    values:
+      version: "dotcom"
+      data_association: "categories.simple"
   -
     scope:
       path: "different"

data/test/variable_mixin_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class VariableMixinTest < MiniTest::Test
+
+  def test_it_fetches_variables
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      assert_equal VariableMixin.variables.keys, ['site']
+      assert_equal VariableMixin.variables['site']['data'].keys, %w(categories reusables variables)
+    end
+  end
+
+  def test_it_fetches_datafiles
+    file = VariableMixin.fetch_data_file('reusables.intro')
+    assert_equal file['frontmatter_intro'], 'Here I am, in the front.'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-conref-fs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
@@ -102,6 +102,14 @@ files:
 - test/conref_fs_test.rb
 - test/datafiles_test.rb
 - test/fixtures/Rules
+- test/fixtures/content/attributes/attribute.html
+- test/fixtures/content/attributes/attribute.md
+- test/fixtures/content/children/array_children.html
+- test/fixtures/content/children/array_children.md
+- test/fixtures/content/children/hash_children.html
+- test/fixtures/content/children/hash_children.md
+- test/fixtures/content/children/later_hash_children.html
+- test/fixtures/content/children/later_hash_children.md
 - test/fixtures/content/datafiles/deep.html
 - test/fixtures/content/datafiles/deep.md
 - test/fixtures/content/datafiles/retrieve.html
@@ -116,6 +124,8 @@ files:
 - test/fixtures/content/obfuscation/admonitions.md
 - test/fixtures/content/obfuscation/octicon.html
 - test/fixtures/content/obfuscation/octicon.md
+- test/fixtures/content/parents/array_parents.html
+- test/fixtures/content/parents/array_parents.md
 - test/fixtures/content/parents/missing_title.html
 - test/fixtures/content/parents/missing_title.md
 - test/fixtures/content/parents/single_parent.html
@@ -123,14 +133,17 @@ files:
 - test/fixtures/content/parents/two_parents.html
 - test/fixtures/content/parents/two_parents.md
 - test/fixtures/data/categories/category.yml
+- test/fixtures/data/categories/simple.yml
 - test/fixtures/data/reusables/intro.yml
 - test/fixtures/data/reusables/names.yml
 - test/fixtures/data/variables/empty.yml
 - test/fixtures/data/variables/product.yml
+- test/fixtures/layouts/children.html
 - test/fixtures/layouts/default.html
 - test/fixtures/layouts/retrieve.html
 - test/fixtures/nanoc.yaml
 - test/test_helper.rb
+- test/variable_mixin_test.rb
 homepage: https://github.com/gjtorikian/nanoc-conref-fs
 licenses:
 - MIT
@@ -159,6 +172,14 @@ test_files:
 - test/conref_fs_test.rb
 - test/datafiles_test.rb
 - test/fixtures/Rules
+- test/fixtures/content/attributes/attribute.html
+- test/fixtures/content/attributes/attribute.md
+- test/fixtures/content/children/array_children.html
+- test/fixtures/content/children/array_children.md
+- test/fixtures/content/children/hash_children.html
+- test/fixtures/content/children/hash_children.md
+- test/fixtures/content/children/later_hash_children.html
+- test/fixtures/content/children/later_hash_children.md
 - test/fixtures/content/datafiles/deep.html
 - test/fixtures/content/datafiles/deep.md
 - test/fixtures/content/datafiles/retrieve.html
@@ -173,6 +194,8 @@ test_files:
 - test/fixtures/content/obfuscation/admonitions.md
 - test/fixtures/content/obfuscation/octicon.html
 - test/fixtures/content/obfuscation/octicon.md
+- test/fixtures/content/parents/array_parents.html
+- test/fixtures/content/parents/array_parents.md
 - test/fixtures/content/parents/missing_title.html
 - test/fixtures/content/parents/missing_title.md
 - test/fixtures/content/parents/single_parent.html
@@ -180,11 +203,14 @@ test_files:
 - test/fixtures/content/parents/two_parents.html
 - test/fixtures/content/parents/two_parents.md
 - test/fixtures/data/categories/category.yml
+- test/fixtures/data/categories/simple.yml
 - test/fixtures/data/reusables/intro.yml
 - test/fixtures/data/reusables/names.yml
 - test/fixtures/data/variables/empty.yml
 - test/fixtures/data/variables/product.yml
+- test/fixtures/layouts/children.html
 - test/fixtures/layouts/default.html
 - test/fixtures/layouts/retrieve.html
 - test/fixtures/nanoc.yaml
 - test/test_helper.rb
+- test/variable_mixin_test.rb