nanoc-conref-fs 0.5.0 → 0.6.0

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

@@ -1,23 +1,87 @@
 require 'liquid'
 
-module Conrefifier
+module NanocConrefFS
+  module Conrefifier
+    SINGLE_SUB = /(\{\{[^\}]+\}\})/m
+    BLOCK_SUB = /\{% (?:if|unless).+? %\}.*?\{% end(?:if|unless) %\}/m
+    PATH_TO_VARS = {}
 
-  SINGLE_SUB = /(\{\{[^\}]+\}\})/m
-  BLOCK_SUB = /\{% (?:if|unless).+? %\}.*?\{% end(?:if|unless) %\}/m
+    def self.file_variables(variables, path, rep)
+      return {} if variables.nil?
 
-  def self.file_variables(variables, path)
-    return {} if variables.nil?
+      data_vars = {}
 
-    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])
+      # this saves a bunch of time because we don't need to
+      # recalculate the paths (looping over scopes, etc)
+      if PATH_TO_VARS[rep] && PATH_TO_VARS[rep][path]
+        data_vars = PATH_TO_VARS[rep][path]
+      else
+        scopes = variables.select do |v|
+          scope_block = v[:scope]
+          scoped_path = scope_block[:path].empty? || Regexp.new(scope_block[:path]) =~ path
+          scoped_rep  = scope_block[:reps].nil? || scope_block[:reps].include?(rep)
+          scoped_path && scoped_rep
+        end
+        # I benchmarked that assignment is much faster than
+        # merging an empty hash
+        if scopes.length == 1
+          data_vars = scopes.first[:values]
+        else
+          scopes.each do |scope|
+            data_vars = data_vars.merge(scope[:values])
+          end
+        end
+        # stash for later use
+        PATH_TO_VARS[rep] = {}
+        PATH_TO_VARS[rep][path] = data_vars
+      end
+
+      data_vars
     end
-    data_vars
-  end
 
-  def self.apply_liquid(content, data_vars)
-    data_vars['page'] = data_vars[:page].stringify_keys
-    Liquid::Template.parse(content, :error_mode => :warn).render(data_vars)
+    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])
+
+      # we must obfuscate essential ExtendedMarkdownFilter content
+      content = content.gsub(/\{\{\s*#(\S+)\s*\}\}/, '[[#\1]]')
+      content = content.gsub(/\{\{\s*\/(\S+)\s*\}\}/, '[[/\1]]')
+      content = content.gsub(/\{\{\s*(octicon-\S+\s*[^\}]+)\s*\}\}/, '[[\1]]')
+
+      begin
+        result = content
+
+        # This pass replaces any matched conditionals
+        if result =~ NanocConrefFS::Conrefifier::BLOCK_SUB || result =~ NanocConrefFS::Conrefifier::SINGLE_SUB
+          result = NanocConrefFS::Conrefifier.apply_liquid(result, page_vars)
+        end
+      rescue Liquid::SyntaxError => e
+        # unrecognized Liquid, so just return the content
+        STDERR.puts "Could not convert #{filename}: #{e.message}"
+      rescue => e
+        raise "#{e.message}: #{e.inspect}"
+      end
+
+      result = result.gsub(/\[\[\s*#(\S+)\s*\]\]/, '{{#\1}}')
+      result = result.gsub(/\[\[\s*\/(\S+)\s*\]\]/, '{{/\1}}')
+      result = result.gsub(/\[\[\s*(octicon-\S+\s*[^\]]+)\s*\]\]/, '{{\1}}')
+
+      result
+    end
+
+    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)
+      # 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
+      if result =~ NanocConrefFS::Conrefifier::SINGLE_SUB
+        result = result.gsub(NanocConrefFS::Conrefifier::SINGLE_SUB) do |match|
+          liquified = NanocConrefFS::Conrefifier.apply_liquid(match, data_vars)
+          liquified.empty? ? match : liquified
+        end
+      end
+      result
+    end
   end
 end

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

@@ -3,50 +3,67 @@ require 'active_support/core_ext/hash'
 
 require_relative 'conrefifier'
 
-module Datafiles
+module NanocConrefFS
+  module Datafiles
+    def self.apply_conditionals(config, path:, content:, rep:)
+      vars = Conrefifier.file_variables(config[:data_variables], path, rep)
+      data_vars = { :page => vars, :site => { :config => config } }
 
-  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 = obfuscate_liquid(content, data_vars)
+      begin
+        doc = YAML.load(content)
+      rescue Psych::SyntaxError => e
+        STDERR.puts "Could not convert \n#{content}"
+        raise "#{e.message}: #{e.inspect}"
+      end
+
+      path = path.dup
+      path.slice!('data/')
+      path.sub!(/\.[yaml]{3,4}\z/, '')
+      data_keys = path.split('/')
 
-    content = content.gsub(Conrefifier::BLOCK_SUB) do |match|
-      # We must obfuscate Liquid variables while replacing conditionals
-      match = match.gsub(/{{/, '~~#~~')
-      match = Conrefifier.apply_liquid(match, data_vars)
-      match.gsub('~~#~~', '{{')
+      # we don't need to create a nested hash for root-level data files
+      if data_keys.length == 1
+        { data_keys.first => doc }
+      else
+        create_nested_hash(data_keys, doc)
+      end
     end
 
-    doc = YAML.load(content)
-    data_keys = "#{path}".gsub(%r{^data/}, '').gsub(%r{/}, '.').gsub(/\.yml/, '').split('.')
-    # we don't need to create a nested hash for root-level data files
-    if data_keys.length == 1
-      { data_keys.first => doc }
-    else
-      create_nested_hash(data_keys, doc)
+    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
-  end
 
-  def self.create_nested_hash(keys, final)
-    keys.reverse.inject do |mem, var|
-      if mem == keys.last
-        { var => { mem => final } }
-      else
-        { var => mem }
+    def self.collect_data(dir)
+      data_files = {}
+      Dir["#{dir}/**/*.{yaml,yml}"].each do |filename|
+        data_files[filename] = File.read(filename)
       end
+      data_files
     end
-  end
 
-  def self.collect_data(dir)
-    Dir["#{dir}/**/*.{yaml,yml}"]
-  end
+    def self.process(data_files, config, rep)
+      data = {}
+      data_files.each_pair do |filename, content|
+        conditionals = apply_conditionals(config, path: filename, content: content, rep: rep)
+        data = data.deep_merge(conditionals)
+      end
+      data
+    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)
+    def self.obfuscate_liquid(content, data_vars)
+      content.gsub(Conrefifier::BLOCK_SUB) do |match|
+        # We must obfuscate Liquid variables while replacing conditionals
+        match = match.gsub(/{{/, '~~#~~')
+        match = Conrefifier.apply_liquid(match, data_vars)
+        match.gsub('~~#~~', '{{')
+      end
     end
-    data
   end
 end

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

@@ -0,0 +1,30 @@
+module NanocConrefFS
+  # Unsure why attr_accessor does not work here
+  module Variables
+    def self.variables
+      @variables
+    end
+
+    def self.variables=(variables)
+      @variables = variables
+    end
+
+    def self.data_files
+      @data_files
+    end
+
+    def self.data_files=(data_files)
+      @data_files = data_files
+    end
+
+    def self.fetch_data_file(association, rep)
+      return nil unless association
+      reference = association.split('.')
+      data = @variables[rep]['site']['data']
+      while key = reference.shift
+        data = data[key]
+      end
+      data
+    end
+  end
+end

data/lib/nanoc-conref-fs.rb

@@ -1,3 +1,11 @@
-require 'nanoc-conref-fs/conref-fs'
+begin
+  require 'awesome_print'
+rescue LoadError
+end
+
+require 'nanoc-conref-fs/ancestry'
 require 'nanoc-conref-fs/conrefifier'
 require 'nanoc-conref-fs/datafiles'
+require 'nanoc-conref-fs/variables'
+require 'nanoc-conref-fs/conref-fs'
+require 'nanoc-conref-fs/conref-filter'

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.5.0'
+  spec.version       = '0.6.0'
   spec.authors       = ['Garen Torikian']
   spec.email         = ['gjtorikian@gmail.com']
   spec.summary       = 'A Nanoc filesystem to permit using conrefs/reusables in your content.'

data/test/ancestry_test.rb

@@ -0,0 +1,79 @@
+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
+      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_it_renders_array_parents
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('parents', 'array_parents')
+      test_file = read_test_file('parents', 'array_parents')
+      assert_equal output_file, test_file
+    end
+  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
+      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
+
+  def test_it_renders_hash_children
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('children', 'hash_children')
+      test_file = read_test_file('children', 'hash_children')
+      assert_equal output_file, test_file
+
+      output_file = read_output_file('children', 'later_hash_children')
+      test_file = read_test_file('children', 'later_hash_children')
+      assert_equal output_file, test_file
+    end
+  end
+
+  def test_it_renders_array_children
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      output_file = read_output_file('children', 'array_children')
+      test_file = read_test_file('children', 'array_children')
+      assert_equal output_file, test_file
+    end
+  end
+end

data/test/conref_fs_test.rb

@@ -62,54 +62,6 @@ class DatafilesTest < MiniTest::Test
     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_it_renders_array_parents
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
-      site.compile
-
-      output_file = read_output_file('parents', 'array_parents')
-      test_file = read_test_file('parents', 'array_parents')
-      assert_equal output_file, test_file
-    end
-  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
-      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
-
   def test_it_applies_any_attribute
     with_site(name: FIXTURES_DIR) do |site|
 
@@ -122,7 +74,7 @@ class DatafilesTest < MiniTest::Test
     end
   end
 
-  def test_it_obfuscates_content
+  def test_it_does_not_obfuscate_content
     with_site(name: FIXTURES_DIR) do |site|
 
       site = Nanoc::Int::SiteLoader.new.new_from_cwd
@@ -149,34 +101,6 @@ class DatafilesTest < MiniTest::Test
     end
   end
 
-  def test_it_renders_hash_children
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
-      site.compile
-
-      output_file = read_output_file('children', 'hash_children')
-      test_file = read_test_file('children', 'hash_children')
-      assert_equal output_file, test_file
-
-      output_file = read_output_file('children', 'later_hash_children')
-      test_file = read_test_file('children', 'later_hash_children')
-      assert_equal output_file, test_file
-    end
-  end
-
-  def test_it_renders_array_children
-    with_site(name: FIXTURES_DIR) do |site|
-
-      site = Nanoc::Int::SiteLoader.new.new_from_cwd
-      site.compile
-
-      output_file = read_output_file('children', 'array_children')
-      test_file = read_test_file('children', 'array_children')
-      assert_equal output_file, test_file
-    end
-  end
-
   def test_it_ignores_unknown_tags
     with_site(name: FIXTURES_DIR) do |site|
 
@@ -238,4 +162,18 @@ class DatafilesTest < MiniTest::Test
       assert_equal output_file, test_file
     end
   end
+
+  def test_multiple_outputs
+    with_site(name: FIXTURES_DIR) do |site|
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      site.compile
+
+      single_var_github = read_output_file('multiple', 'single_var')
+      assert_match(/Welcome to GitHub/, single_var_github)
+
+      single_var_x = read_output_file('multiple', 'single_var_x')
+      assert_match(/Welcome to GitHub X/, single_var_x)
+    end
+  end
 end

data/test/datafiles_test.rb

@@ -1,12 +1,8 @@
 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')).sort
+    files = NanocConrefFS::Datafiles.collect_data(File.join(FIXTURES_DIR, 'data')).keys.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
@@ -15,7 +11,7 @@ class DatafilesTest < MiniTest::Test
   def test_it_creates_nested_hash
     string = %w(this is deep)
     value = 42
-    hash = Datafiles.create_nested_hash(string, value)
+    hash = NanocConrefFS::Datafiles.create_nested_hash(string, value)
     value = { 'this' => { 'is' => { 'deep' => 42 } } }
     assert_equal value, hash
   end
@@ -23,18 +19,18 @@ class DatafilesTest < MiniTest::Test
   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)
+    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 = Datafiles.apply_conditionals(@config, file, content)
+    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
 
   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)
+    result = NanocConrefFS::Datafiles.apply_conditionals(CONFIG, path: file, content: content, rep: :default)
     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

data/test/fixtures/Rules

@@ -1,10 +1,12 @@
 #!/usr/bin/env ruby
 
-compile '/**/*.html' do
-  layout '/default.*'
+preprocess do
 end
 
+ignore '/**/*.html'
+
 compile '/**/*.md' do
+  filter :'conref-fs-filter'
   if item[:filename] =~ /retrieve/
     layout '/retrieve.*'
   elsif item[:filename] =~ /_children/
@@ -16,10 +18,20 @@ compile '/**/*.md' do
   end
 end
 
+compile '/multiple/single_var.md', :rep => :X do
+  filter :'conref-fs-filter'
+  filter :erb
+  layout '/default.*'
+end
+
 route '/**/*.md' do
   item.identifier.without_ext + '/index.html'
 end
 
+route '/multiple/single_var.md', :rep => :X do
+  item.identifier.without_ext + '_x/index.html'
+end
+
 route '/**/*' do
   item.identifier.to_s
 end

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

@@ -7,7 +7,7 @@
 </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.
+  **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!*
 

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

@@ -7,7 +7,7 @@
 </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.
+  *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!*
 

data/test/fixtures/content/multiple/single_var.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Single var
+  </title>
+</head>
+
+<body>
+
+Welcome to GitHub.
+
+</body>
+</html>

data/test/fixtures/content/multiple/single_var.md

@@ -0,0 +1,5 @@
+---
+title: Single var
+---
+
+Welcome to {{ site.data.variables.product.multi_name }}.

data/test/fixtures/content/multiple/single_var_x.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>
+  Single var
+  </title>
+</head>
+
+<body>
+
+Welcome to GitHub X.
+
+</body>
+</html>

data/test/fixtures/content/obfuscation/admonitions.html

@@ -8,33 +8,33 @@
 
 <body>
 
-  [[#tip]]
+  {{#tip}}
 
 Here's a hot tip: **line one**
 Here's a hot tip: line two
 
-[[/tip]]
+{{/tip}}
 
-[[#note]]
+{{#note}}
 
 This is something you should know! line one
 This is something you should know! line two
 
-[[/note]]
+{{/note}}
 
-[[#warning]]
+{{#warning}}
 
 Yo, check this out: line one
 Yo, check this out: line two
 
-[[/warning]]
+{{/warning}}
 
-[[#danger]]
+{{#danger}}
 
 Sheeeeit, this is a problem: ~~line one~~
 Sheeeeit, this is a problem: line two
 
-[[/danger]]
+{{/danger}}
 
 </body>
 </html>

data/test/fixtures/content/obfuscation/octicon.html

@@ -8,9 +8,9 @@
 
 <body>
 
-  [[octicon-cat This is a cat]]
+  {{octicon-cat This is a cat}}
 
-[Click [[octicon-gear Settings ]]](http://alink.com)
+[Click {{octicon-gear Settings }}](http://alink.com)
 
 </body>
 </html>

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

@@ -2,6 +2,15 @@ product_name:
   dotcom: 'GitHub'
   '2.0': 'GitHub Enterprise'
 
+multi_name:
+  {% if page.version == 'dotcom' %}
+    'GitHub'
+  {% elsif page.version == 'X' %}
+    'GitHub X'
+  {% else %}
+    'GitHub Enterprise'
+  {% endif %}
+
 caveat: |
   {% if page.version == 'dotcom' %}