nanoc 4.3.7 → 4.3.8

data/lib/nanoc/cli/commands/deploy.rb

@@ -27,7 +27,7 @@ module Nanoc::CLI::Commands
     private
 
     def list_deployers
-      deployers      = Nanoc::Int::PluginRegistry.instance.find_all(Nanoc::Extra::Deployer)
+      deployers      = Nanoc::Int::PluginRegistry.instance.find_all(Nanoc::Deploying::Deployer)
       deployer_names = deployers.keys.sort_by(&:to_s)
       puts 'Available deployers:'
       deployer_names.each do |name|
@@ -85,7 +85,7 @@ module Nanoc::CLI::Commands
     end
 
     def check
-      runner = Nanoc::Extra::Checking::Runner.new(site)
+      runner = Nanoc::Checking::Runner.new(site)
       if runner.dsl_present?
         puts 'Running issue checks…'
         is_success = runner.run_for_deploy
@@ -105,13 +105,13 @@ module Nanoc::CLI::Commands
     end
 
     def deployer_class_for_config(config)
-      names = Nanoc::Extra::Deployer.all.keys
+      names = Nanoc::Deploying::Deployer.all.keys
       name = config.fetch(:kind) do
         $stderr.puts 'Warning: The specified deploy target does not have a kind attribute. Assuming rsync.'
         'rsync'
       end
 
-      deployer_class = Nanoc::Extra::Deployer.named(name)
+      deployer_class = Nanoc::Deploying::Deployer.named(name)
       if deployer_class.nil?
         raise Nanoc::Int::Errors::GenericTrivial, "The specified deploy target has an unrecognised kind “#{name}” (expected one of #{names.join(', ')})."
       end

data/lib/nanoc/cli/commands/prune.rb

@@ -19,9 +19,9 @@ module Nanoc::CLI::Commands
       site.compiler.build_reps
 
       if options.key?(:yes)
-        Nanoc::Extra::Pruner.new(site, exclude: prune_config_exclude).run
+        Nanoc::Pruner.new(site.config, site.compiler.reps, exclude: prune_config_exclude).run
       elsif options.key?(:'dry-run')
-        Nanoc::Extra::Pruner.new(site, exclude: prune_config_exclude, dry_run: true).run
+        Nanoc::Pruner.new(site.config, site.compiler.reps, exclude: prune_config_exclude, dry_run: true).run
       else
         $stderr.puts 'WARNING: Since the prune command is a destructive command, it requires an additional --yes flag in order to work.'
         $stderr.puts

data/lib/nanoc/cli/commands/show-plugins.rb

@@ -72,14 +72,14 @@ module Nanoc::CLI::Commands
     PLUGIN_CLASS_ORDER = [
       Nanoc::Filter,
       Nanoc::DataSource,
-      Nanoc::Extra::Deployer,
-    ].freeze unless defined? PLUGIN_CLASS_ORDER
+      Nanoc::Deploying::Deployer,
+    ].freeze
 
     PLUGIN_CLASSES = {
       Nanoc::Filter          => 'Filters',
       Nanoc::DataSource      => 'Data Sources',
-      Nanoc::Extra::Deployer => 'Deployers',
-    }.freeze unless defined? PLUGIN_CLASSES
+      Nanoc::Deploying::Deployer => 'Deployers',
+    }.freeze
 
     def name_for_plugin_class(klass)
       PLUGIN_CLASSES[klass]

data/lib/nanoc/data_sources/filesystem.rb

@@ -252,7 +252,7 @@ module Nanoc::DataSources
 
     # Returns all files in the given directory and directories below it.
     def all_files_in(dir_name)
-      Nanoc::Extra::FilesystemTools.all_files_in(dir_name, config[:extra_files])
+      Nanoc::DataSources::Filesystem::Tools.all_files_in(dir_name, config[:extra_files])
     end
 
     # Returns the filename for the given base filename and the extension.
@@ -435,3 +435,5 @@ module Nanoc::DataSources
     end
   end
 end
+
+require_relative 'filesystem/tools'

data/lib/nanoc/{extra/filesystem_tools.rb → data_sources/filesystem/tools.rb}

@@ -1,8 +1,8 @@
-module Nanoc::Extra
+class Nanoc::DataSources::Filesystem < Nanoc::DataSource
   # Contains useful functions for managing the filesystem.
   #
   # @api private
-  module FilesystemTools
+  module Tools
     # Error that is raised when too many symlink indirections are encountered.
     class MaxSymlinkDepthExceededError < ::Nanoc::Int::Errors::GenericTrivial
       # @return [String] The last filename that was attempted to be
@@ -92,19 +92,24 @@ module Nanoc::Extra
     #
     # @raise [GenericTrivial] when pattern can not be handled
     def all_files_and_dirs_in(dir_name, extra_files)
-      patterns = ["#{dir_name}/**/*"]
-      case extra_files
-      when nil
-      when String
-        patterns << "#{dir_name}/#{extra_files}"
-      when Array
-        patterns.concat(extra_files.map { |extra_file| "#{dir_name}/#{extra_file}" })
-      else
-        raise(
-          Nanoc::Int::Errors::GenericTrivial,
-          "Do not know how to handle extra_files: #{extra_files.inspect}",
-        )
-      end
+      base_patterns = ["#{dir_name}/**/*"]
+
+      extra_patterns =
+        case extra_files
+        when nil
+          []
+        when String
+          ["#{dir_name}/#{extra_files}"]
+        when Array
+          extra_files.map { |extra_file| "#{dir_name}/#{extra_file}" }
+        else
+          raise(
+            Nanoc::Int::Errors::GenericTrivial,
+            "Do not know how to handle extra_files: #{extra_files.inspect}",
+          )
+        end
+
+      patterns = base_patterns + extra_patterns
       Dir.glob(patterns)
     end
     module_function :all_files_and_dirs_in

data/lib/nanoc/deploying.rb

@@ -0,0 +1,8 @@
+module Nanoc
+  # @api private
+  module Deploying
+  end
+end
+
+require 'nanoc/deploying/deployer'
+require 'nanoc/deploying/deployers'

data/lib/nanoc/{extra → deploying}/deployer.rb

@@ -1,4 +1,4 @@
-module Nanoc::Extra
+module Nanoc::Deploying
   # Represents a deployer, an object that allows uploading the compiled site
   # to a specific (remote) location.
   #
@@ -37,7 +37,7 @@ module Nanoc::Extra
     #
     # @abstract
     def run
-      raise NotImplementedError.new('Nanoc::Extra::Deployer subclasses must implement #run')
+      raise NotImplementedError.new('Nanoc::Deploying::Deployer subclasses must implement #run')
     end
   end
 end

data/lib/nanoc/deploying/deployers.rb

@@ -0,0 +1,10 @@
+module Nanoc::Deploying
+  # @api private
+  module Deployers
+    autoload 'Fog',   'nanoc/deploying/deployers/fog'
+    autoload 'Rsync', 'nanoc/deploying/deployers/rsync'
+
+    Nanoc::Deploying::Deployer.register '::Nanoc::Deploying::Deployers::Fog',   :fog
+    Nanoc::Deploying::Deployer.register '::Nanoc::Deploying::Deployers::Rsync', :rsync
+  end
+end

data/lib/nanoc/{extra → deploying}/deployers/fog.rb

@@ -1,4 +1,4 @@
-module Nanoc::Extra::Deployers
+module Nanoc::Deploying::Deployers
   # A deployer that deploys a site using [fog](https://github.com/geemus/fog).
   #
   # @example A deployment configuration with public and staging configurations
@@ -20,7 +20,7 @@ module Nanoc::Extra::Deployers
   #       bucket:     nanoc-site-staging
   #
   # @api private
-  class Fog < ::Nanoc::Extra::Deployer
+  class Fog < ::Nanoc::Deploying::Deployer
     class FogWrapper
       def initialize(directory, is_dry_run)
         @directory = directory
@@ -75,7 +75,7 @@ module Nanoc::Extra::Deployers
       end
     end
 
-    # @see Nanoc::Extra::Deployer#run
+    # @see Nanoc::Deploying::Deployer#run
     def run
       require 'fog'
 

data/lib/nanoc/{extra → deploying}/deployers/rsync.rb

@@ -1,4 +1,4 @@
-module Nanoc::Extra::Deployers
+module Nanoc::Deploying::Deployers
   # A deployer that deploys a site using rsync.
   #
   # The configuration has should include a `:dst` value, a string containing
@@ -18,7 +18,7 @@ module Nanoc::Extra::Deployers
   #       options: [ "-glpPrtvz" ]
   #
   # @api private
-  class Rsync < ::Nanoc::Extra::Deployer
+  class Rsync < ::Nanoc::Deploying::Deployer
     # Default rsync options
     DEFAULT_OPTIONS = [
       '--group',
@@ -35,7 +35,7 @@ module Nanoc::Extra::Deployers
       '--exclude=".git"',
     ].freeze
 
-    # @see Nanoc::Extra::Deployer#run
+    # @see Nanoc::Deploying::Deployer#run
     def run
       # Get params
       src = source_path + '/'

data/lib/nanoc/extra.rb

@@ -1,13 +1,17 @@
+require 'nanoc/checking'
+require 'nanoc/deploying'
+
 # @api private
 module Nanoc::Extra
-  autoload 'Checking',            'nanoc/extra/checking'
-  autoload 'FilesystemTools',     'nanoc/extra/filesystem_tools'
   autoload 'LinkCollector',       'nanoc/extra/link_collector.rb'
-  autoload 'Pruner',              'nanoc/extra/pruner'
   autoload 'Piper',               'nanoc/extra/piper'
   autoload 'JRubyNokogiriWarner', 'nanoc/extra/jruby_nokogiri_warner'
+
+  # @deprecated
+  Checking = Nanoc::Checking
+
+  # @deprecated
+  Deployer = Nanoc::Deploying::Deployer
 end
 
 require 'nanoc/extra/core_ext'
-require 'nanoc/extra/deployer'
-require 'nanoc/extra/deployers'

data/lib/nanoc/filters/colorize_syntax.rb

@@ -312,10 +312,21 @@ module Nanoc::Filters
     def rouge(code, language, params = {})
       require 'rouge'
 
-      formatter_options = {
-        css_class: params.fetch(:css_class, 'highlight'),
-      }
-      formatter = Rouge::Formatters::HTML.new(formatter_options)
+      if Rouge.version < '2' || params.fetch(:legacy, false)
+        # Rouge 1.x or Rouge 2.x legacy options
+        formatter_options = {
+          css_class: params.fetch(:css_class, 'highlight'),
+          inline_theme: params.fetch(:inline_theme, nil),
+          line_numbers: params.fetch(:line_numbers, false),
+          start_line: params.fetch(:start_line, 1),
+          wrap: params.fetch(:wrap, false),
+        }
+        formatter_cls = Rouge::Formatters.const_get(Rouge.version < '2' ? 'HTML' : 'HTMLLegacy')
+        formatter = formatter_cls.new(formatter_options)
+      else
+        formatter = params.fetch(:formatter, Rouge::Formatters::HTML.new)
+      end
+
       lexer = Rouge::Lexer.find_fancy(language, code) || Rouge::Lexers::PlainText
       formatter.format(lexer.lex(code))
     end

data/lib/nanoc/filters/rdoc.rb

@@ -3,11 +3,6 @@ module Nanoc::Filters
   class RDoc < Nanoc::Filter
     requires 'rdoc'
 
-    def self.setup
-      gem 'rdoc', '~> 4.0'
-      super
-    end
-
     # Runs the content through [RDoc::Markup](http://docs.seattlerb.org/rdoc/RDoc/Markup.html).
     # This method takes no options.
     #

data/lib/nanoc/helpers/capturing.rb

@@ -67,7 +67,8 @@ module Nanoc::Helpers
           dependency_tracker.bounce(item.unwrap)
 
           unless rep.compiled?
-            raise Nanoc::Int::Errors::UnmetDependency.new(rep)
+            Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(rep))
+            return content_for(*args, &block)
           end
         end
 

data/lib/nanoc/rule_dsl/recording_executor.rb

@@ -1,6 +1,8 @@
 module Nanoc
   module RuleDSL
     class RecordingExecutor
+      include Nanoc::Int::ContractsSupport
+
       class PathWithoutInitialSlashError < ::Nanoc::Error
         def initialize(rep, basic_path)
           super("The path returned for the #{rep.inspect} item representation, “#{basic_path}”, does not start with a slash. Please ensure that all routing rules return a path that starts with a slash.")
@@ -33,9 +35,13 @@ module Nanoc
         @rule_memory.add_layout(layout_identifier, extra_filter_args)
       end
 
+      Pathlike = C::Maybe[C::Or[String, Nanoc::Identifier]]
+      contract C::Any, Symbol, C::KeywordArgs[path: C::Optional[Pathlike], final: C::Optional[C::Bool]] => nil
       def snapshot(rep, snapshot_name, final: true, path: nil)
-        actual_path = final ? (path || basic_path_from_rules_for(rep, snapshot_name)) : nil
+        pathlike = final ? (path || basic_path_from_rules_for(rep, snapshot_name)) : nil
+        actual_path = pathlike && pathlike.to_s
         @rule_memory.add_snapshot(snapshot_name, final, actual_path)
+        nil
       end
 
       def basic_path_from_rules_for(rep, snapshot_name)

data/lib/nanoc/spec.rb

@@ -35,7 +35,15 @@ module Nanoc
         Nanoc::ItemWithRepsView.new(item, view_context)
       end
 
-      # TODO: document
+      # Creates a new layout and adds it to the site’s collection of layouts.
+      #
+      # @param [String] content The raw layout content
+      #
+      # @param [Hash] attributes A hash containing this layout's attributes
+      #
+      # @param [Nanoc::Identifier, String] identifier This layout's identifier
+      #
+      # @return [Nanoc::ItemWithRepsView] A view for the newly created layout
       def create_layout(content, attributes, identifier)
         layout = Nanoc::Int::Layout.new(content, attributes, identifier)
         @layouts << layout
@@ -139,39 +147,7 @@ module Nanoc
       end
 
       def new_compiler_for(site)
-        rule_memory_store = Nanoc::Int::RuleMemoryStore.new
-
-        dependency_store =
-          Nanoc::Int::DependencyStore.new(site.items.to_a + site.layouts.to_a)
-
-        checksum_store =
-          Nanoc::Int::ChecksumStore.new(site: site)
-
-        item_rep_repo = Nanoc::Int::ItemRepRepo.new
-
-        action_provider = new_action_provider
-
-        outdatedness_checker =
-          Nanoc::Int::OutdatednessChecker.new(
-            site: site,
-            checksum_store: checksum_store,
-            dependency_store: dependency_store,
-            rule_memory_store: rule_memory_store,
-            action_provider: action_provider,
-            reps: item_rep_repo,
-          )
-
-        params = {
-          compiled_content_cache: Nanoc::Int::CompiledContentCache.new,
-          checksum_store: checksum_store,
-          rule_memory_store: rule_memory_store,
-          dependency_store: dependency_store,
-          outdatedness_checker: outdatedness_checker,
-          reps: item_rep_repo,
-          action_provider: action_provider,
-        }
-
-        Nanoc::Int::Compiler.new(site, params)
+        Nanoc::Int::CompilerLoader.new.load(site, action_provider: new_action_provider)
       end
 
       def new_site

data/lib/nanoc/version.rb

@@ -1,4 +1,4 @@
 module Nanoc
   # The current Nanoc version.
-  VERSION = '4.3.7'.freeze
+  VERSION = '4.3.8'.freeze
 end

data/nanoc.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths      = ['lib']
 
   s.rdoc_options     = ['--main', 'README.md']
-  s.extra_rdoc_files = ['ChangeLog', 'LICENSE', 'README.md', 'NEWS.md']
+  s.extra_rdoc_files = ['LICENSE', 'README.md', 'NEWS.md']
 
   s.required_ruby_version = '>= 2.1.0'
 
@@ -30,4 +30,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('parallel', '~> 1.9')
 
   s.add_development_dependency('bundler', '>= 1.7.10', '< 2.0')
+  s.add_development_dependency('appraisal', '~> 2.1')
 end

data/test/base/test_context.rb

@@ -22,4 +22,10 @@ class Nanoc::Int::ContextTest < Nanoc::TestCase
     # Run
     assert_examples_correct 'Nanoc::Int::Context#initialize'
   end
+
+  def test_include
+    context = Nanoc::Int::Context.new({})
+    eval('include Nanoc::Helpers::HTMLEscape', context.get_binding)
+    assert_equal('&lt;&gt;', eval('h("<>")', context.get_binding))
+  end
 end

data/test/base/test_dependency_tracker.rb

@@ -86,24 +86,6 @@ class Nanoc::Int::DependencyTrackerTest < Nanoc::TestCase
     assert_contains_exactly [items[0]], store.objects_outdated_due_to(items[1])
   end
 
-  def test_enter_and_exit
-    items = [
-      Nanoc::Int::Item.new('Foo', {}, '/foo.md'),
-      Nanoc::Int::Item.new('Bar', {}, '/bar.md'),
-    ]
-
-    store = Nanoc::Int::DependencyStore.new(items)
-    tracker = Nanoc::Int::DependencyTracker.new(store)
-
-    tracker.enter(items[0])
-    tracker.enter(items[1])
-    tracker.exit(items[1])
-    tracker.exit(items[0])
-
-    assert_contains_exactly [items[1]], store.objects_causing_outdatedness_of(items[0])
-    assert_empty store.objects_causing_outdatedness_of(items[1])
-  end
-
   def test_store_graph_and_load_graph_simple
     # Mock items
     items = [mock('0'), mock('1'), mock('2'), mock('3')]

data/test/base/test_item_rep.rb

@@ -72,7 +72,7 @@ class Nanoc::Int::ItemRepTest < Nanoc::TestCase
     rep.expects(:compiled?).returns(false)
 
     # Check
-    assert_raises(Nanoc::Int::Errors::UnmetDependency) do
+    assert_raises(FiberError) do
       rep.compiled_content
     end
   end
@@ -90,7 +90,7 @@ class Nanoc::Int::ItemRepTest < Nanoc::TestCase
     }
 
     # Check
-    assert_raises(Nanoc::Int::Errors::UnmetDependency) do
+    assert_raises(FiberError) do
       rep.compiled_content(snapshot: :pre)
     end
   end