nanoc-conref-fs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c521a9f295c33c7aa6f4dc47ca92045539c467e5
+  data.tar.gz: 42ac9a18696599fd0f298899f48b7f6b4484bd3f
+SHA512:
+  metadata.gz: 3fad6cd16943d5e3b4cbda7579d7c0cc6b3b30b0ddf7194a9a198d2d2f01138ed564c3b353d510e78076f7b5c11fe35a088e06cf1332c7d0e1f883fb2525dd12
+  data.tar.gz: ca660bcfaf0287c737ff8a50186d61196cae39b39861fffbb4925f62a2539e1cfa0a56d79c2ccd0bd71815a125a4c41e143e2dde2c9314cf52cb314e3221c7f5

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+out/
+sample.rb
+run_sample.rb
+src/
+docs/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.DS_Store
+
+test/fixtures/output
+test/fixtures/tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.2
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+sudo: false
+cache: bundler
+
+git:
+  depth: 10

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'nanoc', '~> 4.0.0rc3'
+gem 'liquid'
+gem 'kramdown'
+gem 'activesupport'
+
+gem 'rake'
+gem 'minitest'
+gem 'awesome_print'
+gem 'safe_yaml'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Garen J. Torikian
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# nanoc-conref-fs
+
+This gem adds a new Filesystem type called `ConrefFS` to nanoc.
+
+The idea is that you have a set of YAML files in a data folder which act as your reusables. You can apply thse reusables throughout your content and layout.
+
+[![Build Status](https://travis-ci.org/gjtorikian/nanoc-conref-fs.svg)](https://travis-ci.org/gjtorikian/nanoc-conref-fs)
+
+## Usage
+
+Nearly all the usage of this gem relies on a *data* folder, sibling to your *content* and *layouts* folders. See [the test fixture](test/fixtures/data) for an example.
+
+You'll also need some relevant keys added to your *nanoc.yaml* file:
+
+* The `data_variables` key applies additional/dynamic values to your data files, based on their path. For example, the following `data_variables` configuration adds a `version` attribute to every data file, whose value is `dotcom`:
+
+   ``` yaml
+   data_variables:
+     -
+       scope:
+         path: ""
+       values:
+         version: "dotcom"
+   ```
+
+   You could add to this key to indicate that any data file called *changed* instead has a version of `something_different`:
+
+   ``` yaml
+   data_variables:
+     -
+       scope:
+         path: ""
+       values:
+         version: "dotcom"
+     -
+       scope:
+         path: "changed"
+       values:
+         version: "2.0"
+  ```
+
+* Similarly, the `page_variables` also use `scope`s and `value`s to determine variables:
+
+  ``` yaml
+  page_variables:
+    -
+      scope:
+        path: ""
+      values:
+        version: "dotcom"
+    -
+      scope:
+        path: "different"
+      values:
+        version: "2.0"
+  ```
+
+  In this case, every file path will get a `version` of `dotcom`, but any file matching `different` will get a version of 2.0.
+
+See the tests for further usage of these conditionals. In both cases, `path` is converted into a Ruby regular expression before being matched against a filename.
+
+### 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.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: [:test]

data/lib/nanoc-conref-fs.rb

@@ -0,0 +1,3 @@
+require 'nanoc-conref-fs/conref-fs'
+require 'nanoc-conref-fs/conrefifier'
+require 'nanoc-conref-fs/datafiles'

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

@@ -0,0 +1,103 @@
+require_relative 'conrefifier'
+
+class ConrefFS < Nanoc::DataSource
+  include Nanoc::DataSources::Filesystem
+
+  identifier :conref_fs
+
+  # Before iterating over the file objects, this method loads the data folder
+  # and applies to to an ivar for later usage.
+  def load_objects(dir_name, kind, klass)
+    data = Datafiles.process(@site_config)
+    @vars = { 'site' => { 'config' => @site_config.to_h, 'data' => data } }
+    super
+  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 = @vars['site']['data']
+      while key = reference.shift
+        toc = toc[key]
+      end
+      meta['parents'] = find_parents(toc, meta['title'])
+    end
+    [meta, content]
+  end
+
+  # Given a category file, this method finds its parent.
+  def find_parents(toc, title)
+    parents = ''
+    toc.keys.each do |key|
+      toc[key].each do |item|
+        if item.is_a?(Hash)
+          if item.keys.include?(title)
+            parents = key
+            break
+          else
+            if item[item.keys.first].include?(title)
+              parents = key
+              break
+            end
+          end
+        elsif title == item
+          parents = key
+          break
+        end
+      end
+      break unless parents.empty?
+    end
+    parents
+  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
+  def read(filename)
+    begin
+      page_vars = Conrefifier.file_variables(@site_config[:page_variables], filename)
+      page_vars = { :page => page_vars }.merge(@vars)
+
+      data = File.read(filename)
+      return data unless filename.start_with?('content')
+
+      # This first pass converts the frontmatter variables,
+      # and inserts data variables into the body
+      result = Conrefifier.apply_liquid(data, page_vars)
+      # This second application renders the previously inserted
+      # data conditionals within the body
+      result = Conrefifier.apply_liquid(result, page_vars)
+    rescue => e
+      raise RuntimeError.new("Could not read #{filename}: #{e.inspect}")
+    end
+  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/lib/nanoc-conref-fs/conrefifier.rb

@@ -0,0 +1,18 @@
+require 'liquid'
+
+module Conrefifier
+  def self.file_variables(variables, path)
+    return {} if variables.nil?
+
+    data_vars = {}
+    scopes = 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
+    data_vars
+  end
+
+  def self.apply_liquid(content, data_vars)
+    ::Liquid::Template.parse(content).render(data_vars.deep_stringify_keys)
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'yaml'
+require 'active_support'
+require 'active_support/core_ext/hash'
+
+require_relative 'conrefifier'
+
+module Datafiles
+
+  def self.apply_conditionals(config, path, content)
+    data_vars = Conrefifier.file_variables(config[:data_variables], path)
+    data_vars = { :page => data_vars, :site => { :config => config } }
+
+    content = content.gsub(/(\s*\{% (?:if|unless).+? %\}.*?\{% end(?:if|unless) %\})/m) do |match|
+      # We must obfuscate Liquid variables while replacing conditionals
+      match = match.gsub(/{{/, '~~#~~')
+      match = Conrefifier.apply_liquid(match, data_vars)
+      match.gsub('~~#~~', '{{')
+    end
+
+    doc = YAML.load(content)
+    data_keys = "#{path}".gsub(%r{^data/}, '').gsub(%r{/}, '.').gsub(/\.yml/, '').split('.')
+    create_nested_hash(data_keys, doc)
+  end
+
+  def self.create_nested_hash(keys, final)
+    keys.reverse.inject do |mem, var|
+      if mem == keys.last
+        { var => { mem => final } }
+      else
+        { var => mem }
+      end
+    end
+  end
+
+  def self.collect_data(dir)
+    Dir["#{dir}/**/*.{yaml,yml}"]
+  end
+
+  def self.process(config)
+    data = {}
+    files = collect_data('data')
+    files.each do |file|
+      content = File.read(file)
+      data = data.deep_merge apply_conditionals(config, file, content)
+    end
+    data
+  end
+end

data/nanoc-conref-fs.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nanoc-conref-fs'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Garen Torikian']
+  spec.email         = ['gjtorikian@gmail.com']
+  spec.summary       = 'A Nanoc filesystem to permit using conrefs/reusables in your content.'
+  spec.homepage      = 'https://github.com/gjtorikian/nanoc-conref-fs'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'nanoc', '>= 3.1.6'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+  spec.add_runtime_dependency 'liquid', '~> 3.0'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+bundle install "$@"

data/test/conref_fs_test.rb

@@ -0,0 +1,100 @@
+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
+      site.compile
+
+      output_file = read_output_file('frontmatter', 'title')
+      test_file = read_test_file('frontmatter', 'title')
+      assert_equal output_file, test_file
+    end
+  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
+      site.compile
+
+      output_file = read_output_file('frontmatter', 'different')
+      test_file = read_test_file('frontmatter', 'different')
+      assert_equal output_file, test_file
+    end
+  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
+      site.compile
+
+      output_file = read_output_file('frontmatter', 'audience')
+      test_file = read_test_file('frontmatter', 'audience')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_it_renders_nested_conrefs
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('datafiles', 'deep')
+      test_file = read_test_file('datafiles', 'deep')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_it_renders_nested_conrefs
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('datafiles', 'deep')
+      test_file = read_test_file('datafiles', 'deep')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_it_renders_single_parents
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('parents', 'single_parent')
+      test_file = read_test_file('parents', 'single_parent')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_it_renders_two_parents
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('parents', 'two_parents')
+      test_file = read_test_file('parents', 'two_parents')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_missing_cateogory_title_does_not_blow_up_parents
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('parents', 'missing_title')
+      test_file = read_test_file('parents', 'missing_title')
+      assert_equal output_file, test_file
+    end
+  end
+end

data/test/datafiles_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class DatafilesTest < MiniTest::Test
+  def setup
+    @config = YAML.load_file(File.join(FIXTURES_DIR, 'nanoc.yaml')).deep_symbolize_keys
+  end
+
+  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.map! { |name| File.join(FIXTURES_DIR, 'data', "#{name}.yml") }
+    assert_equal files, names
+  end
+
+  def test_it_creates_nested_hash
+    string = %w(this is deep)
+    value = 42
+    hash = Datafiles.create_nested_hash(string, value)
+    value = { 'this' => { 'is' => { 'deep' => 42 } } }
+    assert_equal value, hash
+  end
+
+  def test_it_applies_conref_conditionals
+    file = File.join(FIXTURES_DIR, 'data', 'variables', 'product.yml')
+    content = File.read(file)
+    result = Datafiles.apply_conditionals(@config, file, content)
+    assert_includes result.to_s, 'No caveats!'
+
+    @config[:data_variables][0][:values][:version] = 'foof'
+    result = Datafiles.apply_conditionals(@config, file, content)
+    assert_includes result.to_s, 'Well.....there is one.'
+  end
+
+  def test_it_leaves_liquid_substitutions_alone
+    file = File.join(FIXTURES_DIR, 'data', 'reusables', 'intro.yml')
+    content = File.read(file)
+    result = Datafiles.apply_conditionals(@config, file, content)
+    assert_includes result.to_s, 'We use {{ site.data.reusables.names.new_name }}'
+    assert_includes result.to_s, '{{ site.data.variables.product.product_name }} is great'
+  end
+end

data/test/fixtures/Rules

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+compile '/**/*.html' do
+  layout '/default.*'
+end
+
+compile '/**/*.md' do
+  layout '/default.*'
+end
+
+route '/**/*.md' do
+  item.identifier.without_ext + '/index.html'
+end
+
+route '/**/*.html}' do
+
+end
+
+route '/**/*' do
+  item.identifier.to_s
+end
+
+layout '/**/*', :erb

data/test/fixtures/content/datafiles/deep.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Deep
+  </title>
+</head>
+
+<body>
+
+  We use SVNHub
+
+
+Inception
+
+
+</body>
+</html>

data/test/fixtures/content/datafiles/deep.md

@@ -0,0 +1,6 @@
+---
+title: Deep
+intro: {{ site.data.reusables.intro.svn_intro }}
+---
+
+Inception

data/test/fixtures/content/frontmatter/audience.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Welcome to GitHub
+  </title>
+</head>
+
+<body>
+
+
+
+
+Some other page.
+
+
+</body>
+</html>

data/test/fixtures/content/frontmatter/audience.md

@@ -0,0 +1,5 @@
+---
+title: Welcome to {{ site.data.variables.product.product_name[page.version] }}
+---
+
+Some other page.

data/test/fixtures/content/frontmatter/different.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Welcome to GitHub Enterprise
+  </title>
+</head>
+
+<body>
+
+
+
+
+Some other page.
+
+
+</body>
+</html>

data/test/fixtures/content/frontmatter/different.md

@@ -0,0 +1,5 @@
+---
+title: Welcome to {{ site.data.variables.product.product_name[page.version] }}
+---
+
+Some other page.

data/test/fixtures/content/frontmatter/title.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Substitution
+  </title>
+</head>
+
+<body>
+
+  Here I am, in the front.
+
+
+Some words.
+
+
+</body>
+</html>

data/test/fixtures/content/frontmatter/title.md

@@ -0,0 +1,6 @@
+---
+title: Substitution
+intro: {{ site.data.reusables.intro.frontmatter_intro }}
+---
+
+Some words.

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  OH WOW THIS IS NO WHERE
+  </title>
+</head>
+
+<body>
+
+
+
+
+Little Orphan Annie.
+
+
+</body>
+</html>

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

@@ -0,0 +1,5 @@
+---
+title: OH WOW THIS IS NO WHERE
+---
+
+Little Orphan Annie.

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Using keyboard shortcuts
+  </title>
+</head>
+
+<body>
+
+
+  Keyboard Shortcuts
+
+Something something
+
+
+</body>
+</html>

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

@@ -0,0 +1,5 @@
+---
+title: Using keyboard shortcuts
+---
+
+Something something

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Setting the default branch
+  </title>
+</head>
+
+<body>
+
+
+  Collaborating
+
+Two parents!
+
+
+</body>
+</html>

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

@@ -0,0 +1,5 @@
+---
+title: Setting the default branch
+---
+
+Two parents!

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

@@ -0,0 +1,9 @@
+Keyboard Shortcuts:
+  - Using keyboard shortcuts
+
+Collaborating:
+  - Managing branches in your repository:
+    - About branches
+    - Setting the default branch
+    - Viewing branches in your repository
+    - Creating and deleting branches within your repository

data/test/fixtures/data/reusables/intro.yml

@@ -0,0 +1,14 @@
+frontmatter_intro: Here I am, in the front.
+
+svn_intro: "We use {{ site.data.reusables.names.new_name }}"
+
+conditional_with_subs: |
+  {% if page.version == 'dotcom' %}
+
+  {{ site.data.variables.product.product_name }} is great for open source.
+
+  {% else %}
+
+  {{ site.data.variables.product.product_name }} is great for businesses.
+
+  {% endif %}

data/test/fixtures/data/reusables/names.yml

@@ -0,0 +1 @@
+new_name: 'SVNHub'

data/test/fixtures/data/variables/product.yml

@@ -0,0 +1,14 @@
+product_name:
+  dotcom: 'GitHub'
+  '2.0': 'GitHub Enterprise'
+
+caveat: |
+  {% if page.version == 'dotcom' %}
+
+  No caveats!
+
+  {% else %}
+
+  Well.....there is one.
+
+  {% endif %}

data/test/fixtures/layouts/default.html

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

data/test/fixtures/nanoc.yaml

@@ -0,0 +1,51 @@
+
+data_variables:
+  -
+    scope:
+      path: ""
+    values:
+      version: "dotcom"
+
+page_variables:
+  -
+    scope:
+      path: ""
+    values:
+      version: "dotcom"
+      data_association: "categories.category"
+  -
+    scope:
+      path: "different"
+    values:
+      version: "2.0"
+
+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
+
+    items_root: /
+    layouts_root: /
+
+    encoding: utf-8
+
+    identifier_type: full
+
+checks:
+  internal_links:
+    exclude: []

data/test/test_helper.rb

@@ -0,0 +1,75 @@
+require 'bundler/setup'
+require 'nanoc'
+require_relative '../lib/nanoc-conref-fs'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'active_support'
+
+FIXTURES_DIR = File.join(Dir.pwd, 'test', 'fixtures')
+
+def read_output_file(dir, name)
+  File.read(File.join('output', dir, name, 'index.html')).gsub(/^\s*$/, '')
+end
+
+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
+
+  # Yield site
+  FileUtils.cd(site_name) do
+    yield Nanoc::Int::SiteLoader.new.new_from_cwd
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-conref-fs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: 
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nanoc-conref-fs.rb
+- lib/nanoc-conref-fs/conref-fs.rb
+- lib/nanoc-conref-fs/conrefifier.rb
+- lib/nanoc-conref-fs/datafiles.rb
+- nanoc-conref-fs.gemspec
+- script/bootstrap
+- test/conref_fs_test.rb
+- test/datafiles_test.rb
+- test/fixtures/Rules
+- test/fixtures/content/datafiles/deep.html
+- test/fixtures/content/datafiles/deep.md
+- test/fixtures/content/frontmatter/audience.html
+- test/fixtures/content/frontmatter/audience.md
+- test/fixtures/content/frontmatter/different.html
+- test/fixtures/content/frontmatter/different.md
+- test/fixtures/content/frontmatter/title.html
+- test/fixtures/content/frontmatter/title.md
+- test/fixtures/content/parents/missing_title.html
+- test/fixtures/content/parents/missing_title.md
+- test/fixtures/content/parents/single_parent.html
+- test/fixtures/content/parents/single_parent.md
+- test/fixtures/content/parents/two_parents.html
+- test/fixtures/content/parents/two_parents.md
+- test/fixtures/data/categories/category.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/default.html
+- test/fixtures/nanoc.yaml
+- test/test_helper.rb
+homepage: https://github.com/gjtorikian/nanoc-conref-fs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Nanoc filesystem to permit using conrefs/reusables in your content.
+test_files:
+- test/conref_fs_test.rb
+- test/datafiles_test.rb
+- test/fixtures/Rules
+- test/fixtures/content/datafiles/deep.html
+- test/fixtures/content/datafiles/deep.md
+- test/fixtures/content/frontmatter/audience.html
+- test/fixtures/content/frontmatter/audience.md
+- test/fixtures/content/frontmatter/different.html
+- test/fixtures/content/frontmatter/different.md
+- test/fixtures/content/frontmatter/title.html
+- test/fixtures/content/frontmatter/title.md
+- test/fixtures/content/parents/missing_title.html
+- test/fixtures/content/parents/missing_title.md
+- test/fixtures/content/parents/single_parent.html
+- test/fixtures/content/parents/single_parent.md
+- test/fixtures/content/parents/two_parents.html
+- test/fixtures/content/parents/two_parents.md
+- test/fixtures/data/categories/category.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/default.html
+- test/fixtures/nanoc.yaml
+- test/test_helper.rb