nanoc-conref-fs 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 508e4f55f3d5e47116a42a9dd4faa80ec5d2d670
-  data.tar.gz: 34ae5fbcc93d229eb095b5bf12b11375b9d3b0f9
+  metadata.gz: c20f57a9b8ade6bcb512e52fe3926b5045019bcb
+  data.tar.gz: 4e8728448547dcd9518b02483ac54f776cdd0af1
 SHA512:
-  metadata.gz: fe6fd13c2fd07c5e3650b7ba71fab39fee7cb299b039cd06e5969a087b02aed24fd30625d5a5f0bac270cbe7c8a169c2673522a3f1b3e6d3daf0c987b5db0d59
-  data.tar.gz: 1f6eff45cb2348efd4421e7c385484e6ab6c03fa38e451db6f8cb9b5395a0d4075180f6c74e59f3376d8108da95936311539442e5a4292df78ee29122ff7eb5a
+  metadata.gz: 9039bce1972245ee83270d29deadeeb26c15f8e8188f009d0d4925cca1c939949341f6351f8673e46ddd0d4a33b3eef602fa44fa90a6ffe8d97c724a08467f7a
+  data.tar.gz: 48f3c11bd6e5ca9cb75fb88fbbbe62e6e6431154ba175d25ac23e3c745ffce843a3b52d58dd07aa100ff5659ae35980791d8e0d574f01dde1f45e3fab1be5b7e

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

@@ -37,6 +37,7 @@ module NanocConrefFS
     def find_hash_parents(toc, title)
       parents = ''
       toc.each_key do |key|
+        next if toc[key].nil?
         toc[key].each do |item|
           if item.is_a?(Hash)
             if item.keys.include?(title)
@@ -61,37 +62,46 @@ module NanocConrefFS
 
     # Given a category file that's an array, this method finds
     # the children of an item, probably a map topic
+    #
+    # toc - the array containing the table of contents
+    # title - the text title to return the children of
+    #
+    # Returns a flattened array of all descendants which could be empty.
     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
+            return children
           end
         end
-        break unless children.empty?
       end
-      children
+      # Found no children
+      Array.new
     end
     module_function :find_array_children
 
     # Given a category file that's a hash, this method finds
     # the children of an item, probably a map topic
+    #
+    # toc - the hash containing the table of contents
+    # title - the text title to return the children of
+    #
+    # Returns a flattened array of all descendants which could be empty.
     def find_hash_children(toc, title)
-      children = ''
       toc.each_key do |key|
+        next if toc[key].nil?
         toc[key].each do |item|
           next unless item.is_a?(Hash)
-          unless item[title].nil?
+          if item[title]
             children = item.values.flatten
-            break
+            return children
           end
         end
-        break unless children.empty?
       end
-      children
+      # Found no children
+      Array.new
     end
     module_function :find_hash_children
   end

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

@@ -1,8 +1,7 @@
 require_relative 'conrefifier'
 require 'active_support/core_ext/string'
 
-class ConrefFS < Nanoc::DataSource
-  include Nanoc::DataSources::Filesystem
+class ConrefFS < Nanoc::DataSources::Filesystem
   include NanocConrefFS::Variables
   include NanocConrefFS::Ancestry
 
@@ -70,12 +69,14 @@ class ConrefFS < Nanoc::DataSource
   # out of the frontmatter—all of them dealing with collision between
   # the { character in Liquid and its signfigance in YAML. We'll overload
   # the parse method here to resolve those issues ahead of time.
-  def parse(content_filename, meta_filename, _kind)
+  def parse_with_frontmatter(content_filename)
     # Read data
     data = read(content_filename)
 
     # Check presence of metadata section
-    return [{}, data] if data !~ /\A-{3,5}\s*$/
+    if data !~ /\A-{3,5}\s*$/
+      return ParseResult.new(content: data, attributes: {}, attributes_data: '')
+    end
 
     # Split data
     pieces = data.split(/^(-{5}|-{3})[ \t]*\r?\n?/, 3)
@@ -98,7 +99,7 @@ class ConrefFS < Nanoc::DataSource
     content = pieces[4]
 
     # Done
-    [meta, content]
+    ParseResult.new(content: content, attributes: meta, attributes_data: pieces[2])
   end
 
   def self.create_ignore_rules(rep, file)
@@ -147,29 +148,4 @@ class ConrefFS < Nanoc::DataSource
     end
     articles
   end
-
-  # This method is extracted from the Nanoc default FS
-  def filename_for(base_filename, ext)
-    if ext.nil?
-      nil
-    elsif ext.empty?
-      base_filename
-    else
-      base_filename + '.' + ext
-    end
-  end
-
-  # This method is extracted from the Nanoc default FS
-  def identifier_for_filename(filename)
-    if config[:identifier_type] == 'full'
-      return Nanoc::Identifier.new(filename)
-    end
-
-    if filename =~ /(^|\/)index(\.[^\/]+)?$/
-      regex = @config && @config[:allow_periods_in_identifiers] ? /\/?(index)?(\.[^\/\.]+)?$/ : /\/?index(\.[^\/]+)?$/
-    else
-      regex = @config && @config[:allow_periods_in_identifiers] ? /\.[^\/\.]+$/ : /\.[^\/]+$/
-    end
-    Nanoc::Identifier.new(filename.sub(regex, ''), type: :legacy)
-  end
 end

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.6.5'
+  spec.version       = '0.6.6'
   spec.authors       = ['Garen Torikian']
   spec.email         = ['gjtorikian@gmail.com']
   spec.summary       = 'A Nanoc filesystem to permit using conrefs/reusables in your content.'
@@ -15,9 +15,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'nanoc', '~> 4.0'
+  spec.add_runtime_dependency 'nanoc', '~> 4.3.0'
   spec.add_runtime_dependency 'activesupport', '~> 4.2'
-  spec.add_runtime_dependency 'liquid', '~> 3.0'
+  spec.add_runtime_dependency 'liquid', '3.0.6'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest', '~> 5.8'

data/test/ancestry_test.rb

@@ -2,9 +2,7 @@ require 'test_helper'
 
 class AncestryTest < MiniTest::Test
   def test_it_renders_single_parents
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('parents', 'single_parent')
@@ -14,9 +12,7 @@ class AncestryTest < MiniTest::Test
   end
 
   def test_it_renders_two_parents
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('parents', 'two_parents')
@@ -26,9 +22,7 @@ class AncestryTest < MiniTest::Test
   end
 
   def test_it_renders_array_parents
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('parents', 'array_parents')
@@ -38,9 +32,7 @@ class AncestryTest < MiniTest::Test
   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
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('parents', 'missing_title')
@@ -49,10 +41,18 @@ class AncestryTest < MiniTest::Test
     end
   end
 
-  def test_it_renders_hash_children
-    with_site(name: FIXTURES_DIR) do |site|
+  def test_it_renders_content_with_no_children
+    with_site do |site|
+      site.compile
 
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      output_file = read_output_file('children', 'no_children')
+      test_file = read_test_file('children', 'no_children')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_it_renders_hash_children
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('children', 'hash_children')
@@ -66,9 +66,7 @@ class AncestryTest < MiniTest::Test
   end
 
   def test_it_renders_array_children
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('children', 'array_children')

data/test/conref_fs_test.rb

@@ -3,9 +3,7 @@ require 'test_helper'
 class DatafilesTest < MiniTest::Test
 
   def test_it_renders_conrefs_in_frontmatter
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('frontmatter', 'title')
@@ -15,9 +13,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_renders_conrefs_in_frontmatter_at_different_path
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('frontmatter', 'different')
@@ -27,9 +23,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_renders_conrefs_in_frontmatter_with_audience
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('frontmatter', 'audience')
@@ -39,9 +33,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_renders_nested_conrefs
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('datafiles', 'deep')
@@ -51,9 +43,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_renders_nested_conrefs
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('datafiles', 'deep')
@@ -63,9 +53,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_applies_any_attribute
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('attributes', 'attribute')
@@ -75,9 +63,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_does_not_obfuscate_content
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('obfuscation', 'admonitions')
@@ -91,9 +77,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_fetches_variables
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
       output_file = read_output_file('datafiles', 'retrieve')
       test_file = read_test_file('datafiles', 'retrieve')
@@ -102,9 +86,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_ignores_unknown_tags
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('maliciousness', 'unknown')
@@ -114,9 +96,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_works_if_an_asterisk_is_the_first_character
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('maliciousness', 'asterisk_single')
@@ -126,9 +106,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_works_if_asterisks_are_the_first_two_characters
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('maliciousness', 'asterisk_double')
@@ -138,9 +116,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_raw_tags
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('liquid', 'raw')
@@ -151,9 +127,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_multiple_version_blocks
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       output_file = read_output_file('liquid', 'multiple_versions')
@@ -164,9 +138,7 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_multiple_outputs
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+    with_site do |site|
       site.compile
 
       single_var_github = read_output_file('multiple', 'single_var')

data/test/datafiles_test.rb

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

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  No children
+  </title>
+</head>
+
+<body>
+
+  
+Below should be an empty array.
+
+
+  []
+
+</body>
+</html>

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

@@ -0,0 +1,5 @@
+---
+title: No children
+---
+
+Below should be an empty array.

data/test/fixtures/content/empty-categories/content-article.md

@@ -0,0 +1,4 @@
+---
+title: Content article
+---
+

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

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

data/test/fixtures/data/categories/empty_category.yml

@@ -0,0 +1,7 @@
+Category with a thing:
+  - Content article
+
+Empty Category:
+
+Further category:
+  - Content article

data/test/fixtures/nanoc.yaml

@@ -1,4 +1,3 @@
-
 data_variables:
   -
     scope:
@@ -38,6 +37,13 @@ page_variables:
       path: "different"
     values:
       version: "2.0"
+  -
+    scope:
+      path: "empty-categories"
+    values:
+      version: "dotcom"
+      data_association: "categories.empty_category"
+      just_a_key: wow!
   -
     scope:
       path: "multiple_versions"

data/test/test_helper.rb

@@ -21,61 +21,9 @@ def read_test_file(dir, name)
   File.read(File.join(FIXTURES_DIR, 'content', dir, "#{name}.html")).gsub(/^\s*$/, '')
 end
 
-def with_site(params = {})
-  # Build site name
-  site_name = params[:name]
-  if site_name.nil?
-    @site_num ||= 0
-    site_name = "site-#{@site_num}"
-    @site_num += 1
-  end
-
-  # Build rules
-  rules_content = <<EOS
-compile '*' do
-{{compilation_rule_content}}
-end
-
-route '*' do
-if item.binary?
-  item.identifier.chop + (item[:extension] ? '.' + item[:extension] : '')
-else
-  item.identifier + 'index.html'
-end
-end
-
-layout '*', :erb
-EOS
-  rules_content.gsub!('{{compilation_rule_content}}', params[:compilation_rule_content] || '')
-
-  # Create site
-  unless File.directory?(site_name)
-    FileUtils.mkdir_p(site_name)
-    FileUtils.cd(site_name) do
-      FileUtils.mkdir_p('content')
-      FileUtils.mkdir_p('layouts')
-      FileUtils.mkdir_p('lib')
-      FileUtils.mkdir_p('output')
-
-      if params[:has_layout]
-        File.open('layouts/default.html', 'w') do |io|
-          io.write('... <%= @yield %> ...')
-        end
-      end
-
-      File.open('nanoc.yaml', 'w') do |io|
-        io << 'string_pattern_type: legacy' << "\n"
-        io << 'data_sources:' << "\n"
-        io << '  -' << "\n"
-        io << '    type: filesystem' << "\n"
-        io << '    identifier_type: legacy' << "\n"
-      end
-      File.open('Rules', 'w') { |io| io.write(rules_content) }
-    end
-  end
-
+def with_site
   # Yield site
-  FileUtils.cd(site_name) do
+  FileUtils.cd(FIXTURES_DIR) do
     yield Nanoc::Int::SiteLoader.new.new_from_cwd
   end
 end

data/test/variable_mixin_test.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-conref-fs
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,10 +128,13 @@ files:
 - 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/children/no_children.html
+- test/fixtures/content/children/no_children.md
 - test/fixtures/content/datafiles/deep.html
 - test/fixtures/content/datafiles/deep.md
 - test/fixtures/content/datafiles/retrieve.html
 - test/fixtures/content/datafiles/retrieve.md
+- test/fixtures/content/empty-categories/content-article.md
 - test/fixtures/content/frontmatter/audience.html
 - test/fixtures/content/frontmatter/audience.md
 - test/fixtures/content/frontmatter/different.html
@@ -164,6 +167,7 @@ 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/empty_category.yml
 - test/fixtures/data/categories/nested.yml
 - test/fixtures/data/categories/simple.yml
 - test/fixtures/data/reusables/intro.yml
@@ -215,10 +219,13 @@ test_files:
 - 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/children/no_children.html
+- test/fixtures/content/children/no_children.md
 - test/fixtures/content/datafiles/deep.html
 - test/fixtures/content/datafiles/deep.md
 - test/fixtures/content/datafiles/retrieve.html
 - test/fixtures/content/datafiles/retrieve.md
+- test/fixtures/content/empty-categories/content-article.md
 - test/fixtures/content/frontmatter/audience.html
 - test/fixtures/content/frontmatter/audience.md
 - test/fixtures/content/frontmatter/different.html
@@ -251,6 +258,7 @@ 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/empty_category.yml
 - test/fixtures/data/categories/nested.yml
 - test/fixtures/data/categories/simple.yml
 - test/fixtures/data/reusables/intro.yml