nanoc-conref-fs 0.6.9 → 0.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58f928b401b32dbe172ff593c8d10d6931978e66
-  data.tar.gz: b9972a4724904bb445cd596e99f2ba4c454565bf
+  metadata.gz: af97546774d5b23e33b691e8d3aab9e115061fcd
+  data.tar.gz: 97ce0cf24a1b572201b2f2322d216774ae2039ca
 SHA512:
-  metadata.gz: a3872c011533ec5d6b10a3d5eea7c2370d357ad064c7edb7c80d78e1d015ed59e8329c8eef2e89292991c85b30d994fba0b9f10585d3aea5450efdd87f701cbd
-  data.tar.gz: f4759a8fc5b0f0e36e9a2089c1f834d92ae1c28cd6e664e26ce0aee3c37fe3d0fecbfa3b4d660be95bedb6c0bdeb0019027aea3317bf5501f282fd40f34921d2
+  metadata.gz: 8fa4d77ccfaf3cbdfdc68e930c98f860b30288b24519e1cfc1f11b8546843572ec71831104058759c0fe598c5b64d3bec919f1ae889da533ed795f5e3a65a065
+  data.tar.gz: b67e5b5ff20ea6754c65a81421d21f02608397c664bc953a061ede33de5eedb9a4c4ae145de0d8983094b9bbb800f38a68164b688e475859b1a12e5007174887

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

@@ -1,7 +1,10 @@
 require_relative 'conrefifier'
+require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 
 class ConrefFS < Nanoc::DataSources::Filesystem
+  DEFAULT_DATA_DIR = "data".freeze
+
   include NanocConrefFS::Variables
   include NanocConrefFS::Ancestry
 
@@ -10,22 +13,18 @@ class ConrefFS < Nanoc::DataSources::Filesystem
   # Before iterating over the file objects, this method loads the data folder
   # and applies it to an ivar for later usage.
   def up
-    data_files = NanocConrefFS::Datafiles.collect_data(data_dir_name)
+    data_files = NanocConrefFS::Datafiles.collect_data(ConrefFS.data_dir_name(config))
     NanocConrefFS::Variables.data_files = data_files
     NanocConrefFS::Variables.variables = {}
     reps = @config[:reps] || [:default]
     reps.each { |rep| ConrefFS.load_data_folder(@site_config, rep) }
   end
 
-  def data_dir_name
-    config.fetch(:data_dir) { |_| 'data' }
-  end
-
   def self.load_data_folder(config, rep)
     return unless NanocConrefFS::Variables.variables[rep].nil?
     data_files = NanocConrefFS::Variables.data_files
     data = NanocConrefFS::Datafiles.process(data_files, config, rep)
-    NanocConrefFS::Variables.variables[rep] = { 'site' => { 'config' => config, 'data' => data } }
+    NanocConrefFS::Variables.variables[rep] = { 'site' => { 'config' => config, data_dir_name => data } }
   end
 
   def self.apply_attributes(config, item, rep)
@@ -102,12 +101,46 @@ class ConrefFS < Nanoc::DataSources::Filesystem
     ParseResult.new(content: content, attributes: meta, attributes_data: pieces[2])
   end
 
+  # Some of the static class methods below (and elsewhere in the Gem) require 
+  # access to the `data_dir` value from the config. This need comes about
+  # *before* Nanoc has a chance to properly load up the configuration file,
+  # so we're doing a bare-bones load here to gain access to that configuration
+  # item.
+  #
+  # Parameters:
+  # - An optional already-loaded config, so that this can be used later in the
+  #   Nanoc pipeline.
+  #
+  # Returns:
+  # - Custom `data_dir` attribute from the 'conref-fs' data_source
+  # - Default `data_dir` of 'data' if none is configured in `nanoc.yaml`
+  def self.data_dir_name(config=nil)
+    config ||= YAML.load_file('nanoc.yaml')
+    config = config.to_h.with_indifferent_access()
+
+    # In certain parts of the nanoc pipeline the config is rooted at the
+    # data-source already.
+    data_dir = config.fetch("data_dir") { nil }
+    return data_dir if data_dir
+
+    data_sources = config.fetch("data_sources") { nil }
+    return DEFAULT_DATA_DIR unless data_sources
+
+    data_source = data_sources.find { |ds| ds["type"] == "conref-fs" }
+
+    data_dir = data_source.fetch("data_dir") { nil }
+    return DEFAULT_DATA_DIR unless data_dir
+    return data_dir
+  end
+
   def self.create_ignore_rules(rep, file)
     current_articles = NanocConrefFS::Variables.fetch_data_file(file, rep)
     current_articles = flatten_list(current_articles).flatten
     current_articles = fix_nested_content(current_articles)
 
-    basic_yaml = NanocConrefFS::Variables.data_files["data/#{file.tr!('.', '/')}.yml"]
+    basic_yaml_path = "#{data_dir_name}/#{file.tr!('.', '/')}.yml"
+    basic_yaml = NanocConrefFS::Variables.data_files[basic_yaml_path]
+    raise "Could not locate #{basic_yaml_path} in the data files." unless basic_yaml
     basic_yaml.gsub!(/\{%.+/, '')
     full_file = YAML.load(basic_yaml)
 

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

@@ -20,7 +20,7 @@ module NanocConrefFS
       end
 
       path = path.dup
-      path.slice!('data/')
+      path.slice!("#{ConrefFS.data_dir_name(config)}/") # Beware the slashes, they are important for tokenization
       path.sub!(/\.[yaml]{3,4}\z/, '')
       data_keys = path.split('/')
 

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

@@ -20,9 +20,13 @@ module NanocConrefFS
     def self.fetch_data_file(association, rep)
       return nil unless association
       reference = association.split('.')
-      data = @variables[rep]['site']['data']
+      data = @variables[rep]['site'][ConrefFS.data_dir_name]
       while key = reference.shift
-        data = data[key]
+        begin
+          data = data[key]
+        rescue Exception => ex
+          raise "Unable to locate #{key} in #{@variables[rep]['site'].inspect}"
+        end
       end
       data
     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.9'
+  spec.version       = '0.6.10'
   spec.authors       = ['Garen Torikian']
   spec.email         = ['gjtorikian@gmail.com']
   spec.summary       = 'A Nanoc filesystem to permit using conrefs/reusables in your content.'

data/test/datafiles_test.rb

@@ -22,8 +22,11 @@ class DatafilesTest < MiniTest::Test
     result = NanocConrefFS::Datafiles.apply_conditionals(CONFIG, path: file, content: content, rep: :default)
     assert_includes result.to_s, 'No caveats!'
 
-    CONFIG[:data_variables][0][:values][:version] = 'foof'
-    result = NanocConrefFS::Datafiles.apply_conditionals(CONFIG, path: file, content: content, rep: :default)
+    # Don't modify the global constant, you break other tests.
+    config = YAML.load_file(File.join(FIXTURES_DIR, 'nanoc.yaml')).deep_symbolize_keys
+    config[:data_variables][0][:values][:version] = 'foof'
+
+    result = NanocConrefFS::Datafiles.apply_conditionals(config, path: file, content: content, rep: :default)
     assert_includes result.to_s, 'Well.....there is one.'
   end
 
@@ -42,4 +45,12 @@ class DatafilesTest < MiniTest::Test
     assert_includes result.to_s, 'About gists'
     refute_includes result.to_s, 'Deleting an anonymous gist'
   end
+
+  def test_it_can_use_a_custom_datafile
+    file = File.join(FIXTURES_DIR, 'data_custom', 'categories', 'custom.yml')
+    content = File.read(file)
+    config = YAML.load_file(File.join(FIXTURES_DIR, 'nanoc.custom_data_dir.yaml')).deep_symbolize_keys
+    result = NanocConrefFS::Datafiles.apply_conditionals(config, path: file, content: content, rep: :default)
+    assert_includes result.to_s, 'How to Use a Custom Data Directory'
+  end
 end

data/test/fixtures/data_custom/categories/custom.yml

@@ -0,0 +1,4 @@
+{% if page.version != 'cloud' %}
+Custom Files:
+  - How to Use a Custom Data Directory
+{% endif %}

data/test/fixtures/nanoc.custom_data_dir.yaml

@@ -0,0 +1,87 @@
+data_variables:
+  -
+    scope:
+      path: ""
+    values:
+      version: "dotcom"
+  -
+    scope:
+      path: ""
+      reps:
+        - :X
+    values:
+      version: "X"
+
+page_variables:
+  -
+    scope:
+      path: ""
+    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"
+    values:
+      version: "2.0"
+  -
+    scope:
+      path: "empty-categories"
+    values:
+      version: "dotcom"
+      data_association: "categories.empty_category"
+      just_a_key: wow!
+  -
+    scope:
+      path: "multiple_versions"
+    values:
+      version: 2.2
+
+string_pattern_type: glob
+
+text_extensions: [ 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'ms', 'mustache', 'php', 'rb', 'rdoc', 'sass', 'scss', 'slim', 'txt', 'xhtml', 'xml' ]
+
+output_dir: output
+
+index_filenames: [ 'index.html' ]
+
+enable_output_diff: false
+
+prune:
+  auto_prune: true
+
+  exclude: [ '.git', '.hg', '.svn', 'CVS' ]
+
+data_sources:
+  -
+    # The type is the identifier of the data source.
+    type: conref-fs
+
+    data_dir: 'data_custom/'
+
+    items_root: /
+    layouts_root: /
+
+    encoding: utf-8
+
+    identifier_type: full
+    reps:
+      - :default
+      - :X
+
+checks:
+  internal_links:
+    exclude: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-conref-fs
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 0.6.10
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-17 00:00:00.000000000 Z
+date: 2017-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
@@ -175,10 +175,12 @@ files:
 - test/fixtures/data/variables/asterisks.yml
 - test/fixtures/data/variables/empty.yml
 - test/fixtures/data/variables/product.yml
+- test/fixtures/data_custom/categories/custom.yml
 - test/fixtures/layouts/asterisk.html
 - test/fixtures/layouts/children.html
 - test/fixtures/layouts/default.html
 - test/fixtures/layouts/retrieve.html
+- test/fixtures/nanoc.custom_data_dir.yaml
 - test/fixtures/nanoc.yaml
 - test/test_helper.rb
 - test/variable_mixin_test.rb
@@ -266,10 +268,12 @@ test_files:
 - test/fixtures/data/variables/asterisks.yml
 - test/fixtures/data/variables/empty.yml
 - test/fixtures/data/variables/product.yml
+- test/fixtures/data_custom/categories/custom.yml
 - test/fixtures/layouts/asterisk.html
 - test/fixtures/layouts/children.html
 - test/fixtures/layouts/default.html
 - test/fixtures/layouts/retrieve.html
+- test/fixtures/nanoc.custom_data_dir.yaml
 - test/fixtures/nanoc.yaml
 - test/test_helper.rb
 - test/variable_mixin_test.rb