nanoc-conref-fs 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80883b64d0bb6285ba2dd26c11d991310170d5d3
-  data.tar.gz: b961ceb417cd9538101760a2c871e32e3bf86b2a
+  metadata.gz: cbf03675daecb4694ef342f40682105c08117466
+  data.tar.gz: b654f9aec04cb0b670be30f8a292bca44f154c79
 SHA512:
-  metadata.gz: 71dcfcc7919e46fe2bc62bf351149eb8af6ede84036e6236807508d72aab159aa05a40eb016d25b03bf40db42fb07a9ba737bc9133d51e12c29676fb3057a083
-  data.tar.gz: 3d73990232db307ab431627c5cd40dcbc286bf22dd35864bcbaa37f322c6b8ab7da31456a7b64a74f91e695c09a5858a6d814e80516938e9d92c2f148ee2c61b
+  metadata.gz: 21894f1ea9a1a74fdf32f0b8030687d424716bf8feae45fb0f9f8c965bdc0651de8ebd224337d3ac9d015f4c1b35b873bd831c1058692a510555208456a39001
+  data.tar.gz: 9d272820c3cc481104c5da4083e988b293335776fd595d453b5c0a83f575192d588f7a03eae571101136d23514feb196754b334fd89fa7ac339f416c4580be0c

data/Gemfile

@@ -1,11 +1,4 @@
 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'
+# Specify your gem's dependencies in jekyll-html-pipeline.gemspec
+gemspec

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

@@ -28,7 +28,7 @@ class ConrefFS < Nanoc::DataSource
   identifier :'conref-fs'
 
   # Before iterating over the file objects, this method loads the data folder
-  # and applies to to an ivar for later usage.
+  # and applies it to an ivar for later usage.
   def load_objects(dir_name, kind, klass)
     if klass == Nanoc::Int::Item && @variables.nil?
       data = Datafiles.process(@site_config)
@@ -47,16 +47,16 @@ class ConrefFS < Nanoc::DataSource
       association = page_vars[:data_association]
       toc = VariableMixin.fetch_data_file(association)
       meta[:parents] = if toc.is_a?(Array)
-                          find_array_parents(toc, meta['title'])
-                        elsif toc.is_a?(Hash)
-                          find_hash_parents(toc, meta['title'])
-                        end
+                         find_array_parents(toc, meta['title'])
+                       elsif toc.is_a?(Hash)
+                         find_hash_parents(toc, meta['title'])
+                       end
 
       meta[:children] = if toc.is_a?(Array)
-                           find_array_children(toc, meta['title'])
-                         elsif toc.is_a?(Hash)
-                           find_hash_children(toc, meta['title'])
-                         end
+                          find_array_children(toc, meta['title'])
+                        elsif toc.is_a?(Hash)
+                          find_hash_children(toc, meta['title'])
+                        end
     end
     page_vars.each_pair do |name, value|
       meta[name.to_s] = value
@@ -103,7 +103,6 @@ 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)
@@ -162,20 +161,28 @@ class ConrefFS < Nanoc::DataSource
       result = ''
       # This pass replaces any conditionals
       result = if content =~ Conrefifier::BLOCK_SUB
-                  Conrefifier.apply_liquid(content, page_vars)
+                 content.gsub(Conrefifier::BLOCK_SUB) do |match|
+                   Conrefifier.apply_liquid(match, page_vars).chomp
+                 end
                else
-                  content
+                 content
                end
 
       # This pass converts the frontmatter variables,
       # and inserts data variables into the body
-      result = if result =~ Conrefifier::SINGLE_SUB
-                result.gsub(Conrefifier::SINGLE_SUB) do |match|
-                  Conrefifier.apply_liquid(match, page_vars)
-                end
-               else
-                result
-               end
+      if result =~ Conrefifier::SINGLE_SUB
+        result = result.gsub(Conrefifier::SINGLE_SUB) do |match|
+          resolution = Conrefifier.apply_liquid(match, page_vars).strip
+          if resolution.start_with?('*')
+            if resolution[1] != '*'
+              resolution = resolution.sub(/\*(.+?)\*/, '<em>\1</em>')
+            else
+              resolution = resolution.sub(/\*{2}(.+?)\*{2}/, '<strong>\1</strong>')
+            end
+          end
+          resolution
+        end
+      end
 
       # This second pass renders any previously inserted
       # data conditionals within the body
@@ -186,7 +193,7 @@ class ConrefFS < Nanoc::DataSource
       end
 
       result
-    rescue Liquid::SyntaxError => e
+    rescue Liquid::SyntaxError
       # unrecognized Liquid, so just return the content
       # STDERR.puts "Could not convert #{filename}: #{e.message}"
       result

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

@@ -1,3 +1,3 @@
 module Conrefifier
-  VERSION = '0.4.3'
+  VERSION = '0.4.4'
 end

data/nanoc-conref-fs.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'nanoc', '>= 3.1.6'
+  spec.add_runtime_dependency 'nanoc', '~> 4.0'
   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'
+  spec.add_development_dependency 'awesome_print'
 end

data/test/conref_fs_test.rb

@@ -188,4 +188,28 @@ class DatafilesTest < MiniTest::Test
       assert_equal output_file, test_file
     end
   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
+      site.compile
+
+      output_file = read_output_file('maliciousness', 'asterisk_single')
+      test_file = read_test_file('maliciousness', 'asterisk_single')
+      assert_equal output_file, test_file
+    end
+  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
+      site.compile
+
+      output_file = read_output_file('maliciousness', 'asterisk_double')
+      test_file = read_test_file('maliciousness', 'asterisk_double')
+      assert_equal output_file, test_file
+    end
+  end
 end

data/test/datafiles_test.rb

@@ -6,8 +6,8 @@ class DatafilesTest < MiniTest::Test
   end
 
   def test_it_collects_the_files
-    files = Datafiles.collect_data(File.join(FIXTURES_DIR, 'data'))
-    names = %w(categories/category categories/simple reusables/intro reusables/names variables/empty variables/product)
+    files = Datafiles.collect_data(File.join(FIXTURES_DIR, 'data')).sort
+    names = %w(categories/category 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/Rules

@@ -9,20 +9,17 @@ compile '/**/*.md' do
     layout '/retrieve.*'
   elsif item[:filename] =~ /_children/
     layout '/children.*'
+  elsif item[:filename] =~ /asterisk/
+    layout '/asterisk.*'
   else
     layout '/default.*'
   end
 end
 
-
 route '/**/*.md' do
   item.identifier.without_ext + '/index.html'
 end
 
-route '/**/*.html}' do
-
-end
-
 route '/**/*' do
   item.identifier.to_s
 end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Asterisk
+  </title>
+</head>
+
+<body>
+  <strong>Two-factor authentication</strong>, 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!*
+
+</body>
+</html>

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

@@ -0,0 +1,6 @@
+---
+title: Asterisk
+intro: {{ site.data.variables.asterisks.about-two-factor-authentication-strong }}
+---
+
+*Ta-da!*

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Asterisk
+  </title>
+</head>
+
+<body>
+  <em>Two-factor authentication</em>, 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!*
+
+</body>
+</html>

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

@@ -0,0 +1,6 @@
+---
+title: Asterisk
+intro: {{ site.data.variables.asterisks.about-two-factor-authentication }}
+---
+
+*Ta-da!*

data/test/fixtures/data/variables/asterisks.yml

@@ -0,0 +1,5 @@
+about-two-factor-authentication: |
+  *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.
+
+about-two-factor-authentication-strong: |
+  **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.

data/test/fixtures/layouts/asterisk.html

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-conref-fs
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2015-11-26 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
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.6
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
 description: 
 email:
 - gjtorikian@gmail.com
@@ -121,6 +135,10 @@ files:
 - test/fixtures/content/frontmatter/different.md
 - test/fixtures/content/frontmatter/title.html
 - test/fixtures/content/frontmatter/title.md
+- test/fixtures/content/maliciousness/asterisk_double.html
+- test/fixtures/content/maliciousness/asterisk_double.md
+- test/fixtures/content/maliciousness/asterisk_single.html
+- test/fixtures/content/maliciousness/asterisk_single.md
 - test/fixtures/content/maliciousness/unknown.html
 - test/fixtures/content/maliciousness/unknown.md
 - test/fixtures/content/obfuscation/admonitions.html
@@ -139,8 +157,10 @@ files:
 - test/fixtures/data/categories/simple.yml
 - test/fixtures/data/reusables/intro.yml
 - test/fixtures/data/reusables/names.yml
+- test/fixtures/data/variables/asterisks.yml
 - test/fixtures/data/variables/empty.yml
 - test/fixtures/data/variables/product.yml
+- test/fixtures/layouts/asterisk.html
 - test/fixtures/layouts/children.html
 - test/fixtures/layouts/default.html
 - test/fixtures/layouts/retrieve.html
@@ -167,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A Nanoc filesystem to permit using conrefs/reusables in your content.
@@ -193,6 +213,10 @@ test_files:
 - test/fixtures/content/frontmatter/different.md
 - test/fixtures/content/frontmatter/title.html
 - test/fixtures/content/frontmatter/title.md
+- test/fixtures/content/maliciousness/asterisk_double.html
+- test/fixtures/content/maliciousness/asterisk_double.md
+- test/fixtures/content/maliciousness/asterisk_single.html
+- test/fixtures/content/maliciousness/asterisk_single.md
 - test/fixtures/content/maliciousness/unknown.html
 - test/fixtures/content/maliciousness/unknown.md
 - test/fixtures/content/obfuscation/admonitions.html
@@ -211,8 +235,10 @@ test_files:
 - test/fixtures/data/categories/simple.yml
 - test/fixtures/data/reusables/intro.yml
 - test/fixtures/data/reusables/names.yml
+- test/fixtures/data/variables/asterisks.yml
 - test/fixtures/data/variables/empty.yml
 - test/fixtures/data/variables/product.yml
+- test/fixtures/layouts/asterisk.html
 - test/fixtures/layouts/children.html
 - test/fixtures/layouts/default.html
 - test/fixtures/layouts/retrieve.html