nanoc-conref-fs 0.6.10 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af97546774d5b23e33b691e8d3aab9e115061fcd
-  data.tar.gz: 97ce0cf24a1b572201b2f2322d216774ae2039ca
+  metadata.gz: 62064e24b4596e3eff0b6ef03a865da1840efdc5
+  data.tar.gz: f097cb00de1ad5f31e33701bcbb4c394241e5b4b
 SHA512:
-  metadata.gz: 8fa4d77ccfaf3cbdfdc68e930c98f860b30288b24519e1cfc1f11b8546843572ec71831104058759c0fe598c5b64d3bec919f1ae889da533ed795f5e3a65a065
-  data.tar.gz: b67e5b5ff20ea6754c65a81421d21f02608397c664bc953a061ede33de5eedb9a4c4ae145de0d8983094b9bbb800f38a68164b688e475859b1a12e5007174887
+  metadata.gz: ed8578d2747086afd9e6cf48d80bc7e17880ec584aeaca948a81f1b3d443cf1af3bc6bbbb006c0b94381ef171c94b39828fd533ee8c47bf755ce70fceab63c54
+  data.tar.gz: 244555f171ef8570d934be049ecb5ba80770effafcd04c560419af2ce489f29cdae53b4eeed1ebe62b782b90f4472d9726868d5fa30bcdfffa8ef767e8901544

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+RequireParentheses:
+  Enabled: true

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - 2.3
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
@@ -10,3 +12,8 @@ cache: bundler
 
 git:
   depth: 10
+
+matrix:
+  include:
+    - script: bundle exec rake rubocop
+      rvm: 2.5.0

data/Rakefile

@@ -9,3 +9,7 @@ Rake::TestTask.new do |t|
 end
 
 task default: [:test]
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop)

data/lib/nanoc-conref-fs.rb

@@ -1,5 +1,6 @@
 begin
   require 'awesome_print'
+  require 'pry'
 rescue LoadError
 end
 

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

@@ -2,8 +2,21 @@ require_relative 'conrefifier'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 
+class Nanoc::DataSources::Filesystem::Parser
+  alias_method :old_parse_metadata, :parse_metadata
+  # There are a lot of problems when trying to parse liquid
+  # 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_metadata(data, filename)
+    wrapped_data = data.gsub(/^([^:]+): (\{\{.+)/, '\1: \'\2\'')
+
+    old_parse_metadata(wrapped_data, filename)
+  end
+end
+
 class ConrefFS < Nanoc::DataSources::Filesystem
-  DEFAULT_DATA_DIR = "data".freeze
+  DEFAULT_DATA_DIR = 'data'.freeze
 
   include NanocConrefFS::Variables
   include NanocConrefFS::Ancestry
@@ -29,7 +42,7 @@ class ConrefFS < Nanoc::DataSources::Filesystem
 
   def self.apply_attributes(config, item, rep)
     page_vars = NanocConrefFS::Conrefifier.file_variables(config[:page_variables], item[:filename], rep)
-    frontmatter_vars = { :page => page_vars }.merge(NanocConrefFS::Variables.variables[rep])
+    frontmatter_vars = { page: page_vars }.merge(NanocConrefFS::Variables.variables[rep])
 
     unless page_vars[:data_association].nil?
       association = page_vars[:data_association]
@@ -64,44 +77,7 @@ class ConrefFS < Nanoc::DataSources::Filesystem
     end
   end
 
-  # There are a lot of problems when trying to parse liquid
-  # 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_with_frontmatter(content_filename)
-    # Read data
-    data = read(content_filename)
-
-    # Check presence of metadata section
-    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)
-    if pieces.size < 4
-      raise RuntimeError.new(
-        "The file '#{content_filename}' appears to start with a metadata section (three or five dashes at the top) but it does not seem to be in the correct format.",
-      )
-    end
-
-    # N.B. the only change to the original function
-    pieces[2].gsub!(/^([^:]+): (\{\{.+)/, '\1: \'\2\'')
-
-    # Parse
-    begin
-      meta = YAML.load(pieces[2]) || {}
-    rescue Exception => e
-      raise "Could not parse YAML for #{content_filename}: #{e.message}"
-    end
-    verify_meta(meta, content_filename)
-    content = pieces[4]
-
-    # Done
-    ParseResult.new(content: content, attributes: meta, attributes_data: pieces[2])
-  end
-
-  # Some of the static class methods below (and elsewhere in the Gem) require 
+  # 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
@@ -114,21 +90,21 @@ class ConrefFS < Nanoc::DataSources::Filesystem
   # 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)
+  def self.data_dir_name(config = nil)
     config ||= YAML.load_file('nanoc.yaml')
-    config = config.to_h.with_indifferent_access()
+    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 }
+    data_dir = config.fetch('data_dir') { nil }
     return data_dir if data_dir
 
-    data_sources = config.fetch("data_sources") { nil }
+    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_source = data_sources.find { |ds| ds['type'] == 'conref-fs' }
 
-    data_dir = data_source.fetch("data_dir") { nil }
+    data_dir = data_source.fetch('data_dir') { nil }
     return DEFAULT_DATA_DIR unless data_dir
     return data_dir
   end

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

@@ -32,7 +32,7 @@ module NanocConrefFS
 
     def self.liquify(config, path:, content:, rep:)
       page_vars = NanocConrefFS::Conrefifier.file_variables(config[:page_variables], path, rep)
-      page_vars = { :page => page_vars }.merge(NanocConrefFS::Variables.variables[rep])
+      page_vars = { page: page_vars }.merge(NanocConrefFS::Variables.variables[rep])
 
       # we must obfuscate essential ExtendedMarkdownFilter content
       content = content.gsub(/\{\{\s*#(\S+)\s*\}\}/, '[[#\1]]')
@@ -62,7 +62,7 @@ module NanocConrefFS
 
     def self.apply_liquid(content, data_vars)
       data_vars['page'] = data_vars[:page].stringify_keys
-      result = Liquid::Template.parse(content, :error_mode => :warn).render(data_vars)
+      result = Liquid::Template.parse(content, error_mode: :warn).render(data_vars)
       # This second pass renders any previously inserted
       # data conditionals within the body. If a Liquid parse
       # returns a blank string, we'll return the original

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

@@ -9,7 +9,7 @@ module NanocConrefFS
 
     def self.apply_conditionals(config, path:, content:, rep:)
       vars = Conrefifier.file_variables(config[:data_variables], path, rep)
-      data_vars = { :page => vars, :site => { :config => config } }
+      data_vars = { page: vars, site: { config: config } }
 
       content = obfuscate_and_liquify(content, data_vars)
       begin

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

@@ -24,7 +24,7 @@ module NanocConrefFS
       while key = reference.shift
         begin
           data = data[key]
-        rescue Exception => ex
+        rescue StandardError => ex
           raise "Unable to locate #{key} in #{@variables[rep]['site'].inspect}"
         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.10'
+  spec.version       = '0.7.0'
   spec.authors       = ['Garen Torikian']
   spec.email         = ['gjtorikian@gmail.com']
   spec.summary       = 'A Nanoc filesystem to permit using conrefs/reusables in your content.'
@@ -15,11 +15,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'nanoc', '~> 4.3'
   spec.add_runtime_dependency 'activesupport', '~> 4.2'
-  spec.add_runtime_dependency 'liquid', '3.0.6'
+  spec.add_runtime_dependency 'liquid', '~> 4.0'
+  spec.add_runtime_dependency 'nanoc', '~> 4.9'
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest', '~> 5.8'
   spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'minitest-focus', '~> 1.1'
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-github'
 end

data/test/conref_fs_test.rb

@@ -42,16 +42,6 @@ class DatafilesTest < MiniTest::Test
     end
   end
 
-  def test_it_renders_nested_conrefs
-    with_site do |site|
-      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_applies_any_attribute
     with_site do |site|
       site.compile

data/test/fixtures/Rules

@@ -21,7 +21,7 @@ compile '/**/*.md' do
   end
 end
 
-compile '/multiple/single_var.md', :rep => :X do
+compile '/multiple/single_var.md', rep: :X do
   filter :'conref-fs-filter'
   filter :erb
   layout '/default.*'
@@ -31,7 +31,7 @@ route '/**/*.md' do
   item.identifier.without_ext + '/index.html'
 end
 
-route '/multiple/single_var.md', :rep => :X do
+route '/multiple/single_var.md', rep: :X do
   item.identifier.without_ext + '_x/index.html'
 end
 

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

@@ -9,7 +9,7 @@
 <body>
 
 
-Here they are!
+  Here they are!
 
 
   ["About branches", "Setting the default branch", "Viewing branches in your repository", "Creating and deleting branches within your repository"]

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

@@ -8,8 +8,8 @@
 
 <body>
 
-  
-Below should be an empty array.
+
+  Below should be an empty array.
 
 
   []

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

@@ -11,7 +11,7 @@
   We use SVNHub
 
 
-Inception
+  Inception
 
 
 </body>

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

@@ -9,8 +9,7 @@
 <body>
 
   GitHub Enterprise
-
-Fetchy
+  Fetchy
 
 </body>
 </html>

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

@@ -11,7 +11,7 @@
 
 
 
-Some other page.
+  Some other page.
 
 
 </body>

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

@@ -11,7 +11,7 @@
 
 
 
-Some other page.
+  Some other page.
 
 
 </body>

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

@@ -11,7 +11,7 @@
   Here I am, in the front.
 
 
-Some words.
+  Some words.
 
 
 </body>

data/test/fixtures/content/liquid/raw.html

@@ -8,7 +8,7 @@
 
 <body>
 
-For example, to list a project's name, you might write something like `The project is called {{ site.github.project_title }}` or to list an organization's open source repositories, you might use the following:
+  For example, to list a project's name, you might write something like `The project is called {{ site.github.project_title }}` or to list an organization's open source repositories, you might use the following:
 
 ``` liquid
 {% for repository in site.github.public_repositories %}

data/test/fixtures/content/maliciousness/asterisk_double.html

@@ -9,7 +9,7 @@
 <body>
   **Two-factor authentication**, or 2FA, is a way of logging into websites that requires more than just a password. Using a password to log into a website is susceptible to security threats, because it represents a _single_ piece of information a malicious person needs to acquire. The added security that 2FA provides is requiring _additional information_ to sign in.
 
-*Ta-da!*
+  *Ta-da!*
 
 </body>
 </html>

data/test/fixtures/content/maliciousness/asterisk_single.html

@@ -9,7 +9,7 @@
 <body>
   *Two-factor authentication*, or 2FA, is a way of logging into websites that requires more than just a password. Using a password to log into a website is susceptible to security threats, because it represents a _single_ piece of information a malicious person needs to acquire. The added security that 2FA provides is requiring _additional information_ to sign in.
 
-*Ta-da!*
+  *Ta-da!*
 
 </body>
 </html>

data/test/fixtures/content/maliciousness/unknown.html

@@ -8,7 +8,7 @@
 
 <body>
 
-You may also wish to add the `{% feed_meta %}` tag to your layout's `<head>` section to allow browsers to more easily discover your site's feed.
+  You may also wish to add the `{% feed_meta %}` tag to your layout's `<head>` section to allow browsers to more easily discover your site's feed.
 
 </body>
 </html>

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

@@ -9,8 +9,7 @@
 <body>
 
   Creating a new organization account
-
-Array parent.
+  Array parent.
 
 </body>
 </html>

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

@@ -11,7 +11,7 @@
 
 
 
-Little Orphan Annie.
+  Little Orphan Annie.
 
 
 </body>

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

@@ -10,8 +10,7 @@
 
 
   Keyboard Shortcuts
-
-Something something
+  Something something
 
 
 </body>

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

@@ -10,8 +10,7 @@
 
 
   Collaborating
-
-Two parents!
+  Two parents!
 
 
 </body>

data/test/test_helper.rb

@@ -6,6 +6,7 @@ require 'nanoc'
 require_relative '../lib/nanoc-conref-fs'
 require 'minitest/autorun'
 require 'minitest/pride'
+require 'minitest/focus'
 require 'active_support'
 
 FIXTURES_DIR = File.join(Dir.pwd, 'test', 'fixtures')

metadata

@@ -1,59 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-conref-fs
 version: !ruby/object:Gem::Version
-  version: 0.6.10
+  version: 0.7.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nanoc
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: liquid
+  name: nanoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.6
+        version: '4.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.6
+        version: '4.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.8'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.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: rubocop
+  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: rubocop-github
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -102,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt