nanoc 4.3.7 → 4.3.8

data/lib/nanoc/base/services.rb

@@ -6,4 +6,5 @@ require_relative 'services/item_rep_router'
 require_relative 'services/item_rep_selector'
 require_relative 'services/item_rep_writer'
 require_relative 'services/notification_center'
+require_relative 'services/pruner'
 require_relative 'services/temp_filename_factory'

data/lib/nanoc/base/services/compiler_loader.rb

@@ -1,7 +1,7 @@
 module Nanoc::Int
   # @api private
   class CompilerLoader
-    def load(site)
+    def load(site, action_provider: nil)
       rule_memory_store = Nanoc::Int::RuleMemoryStore.new(env_name: site.config.env_name)
 
       dependency_store =
@@ -12,7 +12,7 @@ module Nanoc::Int
 
       item_rep_repo = Nanoc::Int::ItemRepRepo.new
 
-      action_provider = Nanoc::Int::ActionProvider.named(:rule_dsl).for(site)
+      action_provider ||= Nanoc::Int::ActionProvider.named(:rule_dsl).for(site)
 
       outdatedness_checker =
         Nanoc::Int::OutdatednessChecker.new(

data/lib/nanoc/{extra → base/services}/pruner.rb

@@ -1,21 +1,23 @@
-module Nanoc::Extra
+require 'find'
+
+module Nanoc
   # Responsible for finding and deleting files in the site’s output directory
   # that are not managed by Nanoc.
   #
   # @api private
   class Pruner
-    # @return [Nanoc::Int::Site] The site this pruner belongs to
-    attr_reader :site
-
-    # @param [Nanoc::Int::Site] site The site for which a pruner is created
+    # @param [Nanoc::Int::Configuration] config
+    #
+    # @param [Nanoc::Int::ItemRepRepo] reps
     #
     # @param [Boolean] dry_run true if the files to be deleted
     #   should only be printed instead of actually deleted, false if the files
     #   should actually be deleted.
     #
     # @param [Enumerable<String>] exclude
-    def initialize(site, dry_run: false, exclude: [])
-      @site    = site
+    def initialize(config, reps, dry_run: false, exclude: [])
+      @config  = config
+      @reps    = reps
       @dry_run = dry_run
       @exclude = Set.new(exclude)
     end
@@ -24,19 +26,49 @@ module Nanoc::Extra
     #
     # @return [void]
     def run
-      require 'find'
+      return unless File.directory?(@config[:output_dir])
+
+      compiled_files = @reps.flat_map { |r| r.raw_paths.values }.compact
+      present_files, present_dirs = files_and_dirs_in(@config[:output_dir] + '/')
 
-      return unless File.directory?(site.config[:output_dir])
+      remove_stray_files(present_files, compiled_files)
+      remove_empty_directories(present_dirs)
+    end
+
+    def exclude?(component)
+      @exclude.include?(component)
+    end
 
-      # Get compiled files
-      # FIXME: requires #build_reps to have been called
-      all_raw_paths = site.compiler.reps.flat_map { |r| r.raw_paths.values }
-      compiled_files = all_raw_paths.flatten.compact.select { |f| File.file?(f) }
+    # @param [String] filename The filename to check
+    #
+    # @return [Boolean] true if the given file is excluded, false otherwise
+    def filename_excluded?(filename)
+      pathname = Pathname.new(filename)
+      @exclude.any? { |e| pathname.__nanoc_include_component?(e) }
+    end
+
+    # @api private
+    def remove_stray_files(present_files, compiled_files)
+      (present_files - compiled_files).each do |f|
+        delete_file(f) unless exclude?(f)
+      end
+    end
+
+    # @api private
+    def remove_empty_directories(present_dirs)
+      present_dirs.reverse_each do |dir|
+        next if Dir.foreach(dir) { |n| break true if n !~ /\A\.\.?\z/ }
+        next if exclude?(dir)
+        delete_dir(dir)
+      end
+    end
 
-      # Get present files and dirs
+    # @api private
+    def files_and_dirs_in(dir)
       present_files = []
       present_dirs = []
-      Find.find(site.config[:output_dir] + '/') do |f|
+
+      Find.find(dir) do |f|
         basename = File.basename(f)
 
         case File.ftype(f)
@@ -53,49 +85,25 @@ module Nanoc::Extra
         end
       end
 
-      # Remove stray files
-      stray_files = (present_files - compiled_files)
-      stray_files.each do |f|
-        delete_file(f) unless exclude?(f)
-      end
-
-      # Remove empty directories
-      present_dirs.reverse_each do |dir|
-        next if Dir.foreach(dir) { |n| break true if n !~ /\A\.\.?\z/ }
-        next if exclude?(dir)
-        delete_dir(dir)
-      end
-    end
-
-    def exclude?(component)
-      @exclude.include?(component)
-    end
-
-    # @param [String] filename The filename to check
-    #
-    # @return [Boolean] true if the given file is excluded, false otherwise
-    def filename_excluded?(filename)
-      pathname = Pathname.new(filename)
-      @exclude.any? { |e| pathname.__nanoc_include_component?(e) }
+      [present_files, present_dirs]
     end
 
     protected
 
     def delete_file(file)
-      if @dry_run
-        puts file
-      else
-        Nanoc::CLI::Logger.instance.file(:high, :delete, file)
-        FileUtils.rm(file)
-      end
+      log_delete_and_run(file) { FileUtils.rm(file) }
     end
 
     def delete_dir(dir)
+      log_delete_and_run(dir) { Dir.rmdir(dir) }
+    end
+
+    def log_delete_and_run(thing)
       if @dry_run
-        puts dir
+        puts thing
       else
-        Nanoc::CLI::Logger.instance.file(:high, :delete, dir)
-        Dir.rmdir(dir)
+        Nanoc::CLI::Logger.instance.file(:high, :delete, thing)
+        yield
       end
     end
   end

data/lib/nanoc/checking.rb

@@ -0,0 +1,11 @@
+module Nanoc
+  # @api private
+  module Checking
+    autoload 'Check',  'nanoc/checking/check'
+    autoload 'DSL',    'nanoc/checking/dsl'
+    autoload 'Runner', 'nanoc/checking/runner.rb'
+    autoload 'Issue',  'nanoc/checking/issue'
+  end
+end
+
+require 'nanoc/checking/checks'

data/lib/nanoc/{extra/checking → checking}/check.rb

@@ -1,4 +1,4 @@
-module Nanoc::Extra::Checking
+module Nanoc::Checking
   # @api private
   class OutputDirNotFoundError < Nanoc::Int::Errors::Generic
     def initialize(directory_path)
@@ -15,7 +15,7 @@ module Nanoc::Extra::Checking
     def self.create(site)
       output_dir = site.config[:output_dir]
       unless File.exist?(output_dir)
-        raise Nanoc::Extra::Checking::OutputDirNotFoundError.new(output_dir)
+        raise Nanoc::Checking::OutputDirNotFoundError.new(output_dir)
       end
       output_filenames = Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
 
@@ -39,7 +39,7 @@ module Nanoc::Extra::Checking
     end
 
     def run
-      raise NotImplementedError.new('Nanoc::Extra::Checking::Check subclasses must implement #run')
+      raise NotImplementedError.new('Nanoc::Checking::Check subclasses must implement #run')
     end
 
     def add_issue(desc, subject: nil)

data/lib/nanoc/checking/checks.rb

@@ -0,0 +1,20 @@
+require_relative 'checks/w3c_validator'
+
+# @api private
+module Nanoc::Checking::Checks
+  autoload 'CSS',           'nanoc/checking/checks/css'
+  autoload 'ExternalLinks', 'nanoc/checking/checks/external_links'
+  autoload 'HTML',          'nanoc/checking/checks/html'
+  autoload 'InternalLinks', 'nanoc/checking/checks/internal_links'
+  autoload 'Stale',         'nanoc/checking/checks/stale'
+  autoload 'MixedContent',  'nanoc/checking/checks/mixed_content'
+
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::CSS',           :css
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::ExternalLinks', :external_links
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::ExternalLinks', :elinks
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::HTML',          :html
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::InternalLinks', :internal_links
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::InternalLinks', :ilinks
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::Stale',         :stale
+  Nanoc::Checking::Check.register '::Nanoc::Checking::Checks::MixedContent',  :mixed_content
+end

data/lib/nanoc/{extra/checking → checking}/checks/css.rb

@@ -1,6 +1,6 @@
-module ::Nanoc::Extra::Checking::Checks
+module ::Nanoc::Checking::Checks
   # @api private
-  class CSS < ::Nanoc::Extra::Checking::Checks::W3CValidator
+  class CSS < ::Nanoc::Checking::Checks::W3CValidator
     identifier :css
 
     def extension

data/lib/nanoc/{extra/checking → checking}/checks/external_links.rb

@@ -4,11 +4,11 @@ require 'nokogiri'
 require 'timeout'
 require 'uri'
 
-module ::Nanoc::Extra::Checking::Checks
+module ::Nanoc::Checking::Checks
   # A validator that verifies that all external links point to a location that exists.
   #
   # @api private
-  class ExternalLinks < ::Nanoc::Extra::Checking::Check
+  class ExternalLinks < ::Nanoc::Checking::Check
     identifiers :external_links, :elinks
 
     def run

data/lib/nanoc/{extra/checking → checking}/checks/html.rb

@@ -1,6 +1,6 @@
-module ::Nanoc::Extra::Checking::Checks
+module ::Nanoc::Checking::Checks
   # @api private
-  class HTML < ::Nanoc::Extra::Checking::Checks::W3CValidator
+  class HTML < ::Nanoc::Checking::Checks::W3CValidator
     identifier :html
 
     def extension

data/lib/nanoc/{extra/checking → checking}/checks/internal_links.rb

@@ -1,10 +1,10 @@
 require 'uri'
 
-module Nanoc::Extra::Checking::Checks
+module Nanoc::Checking::Checks
   # A check that verifies that all internal links point to a location that exists.
   #
   # @api private
-  class InternalLinks < ::Nanoc::Extra::Checking::Check
+  class InternalLinks < ::Nanoc::Checking::Check
     # Starts the validator. The results will be printed to stdout.
     #
     # Internal links that match a regexp pattern in `@config[:checks][:internal_links][:exclude]` will

data/lib/nanoc/{extra/checking → checking}/checks/mixed_content.rb

@@ -1,9 +1,9 @@
-module Nanoc::Extra::Checking::Checks
+module Nanoc::Checking::Checks
   # A check that verifies HTML files do not reference external resources with
   # URLs that would trigger "mixed content" warnings.
   #
   # @api private
-  class MixedContent < ::Nanoc::Extra::Checking::Check
+  class MixedContent < ::Nanoc::Checking::Check
     PROTOCOL_PATTERN = /^(\w+):\/\//
 
     def run

data/lib/nanoc/{extra/checking → checking}/checks/stale.rb

@@ -1,6 +1,6 @@
-module Nanoc::Extra::Checking::Checks
+module Nanoc::Checking::Checks
   # @api private
-  class Stale < ::Nanoc::Extra::Checking::Check
+  class Stale < ::Nanoc::Checking::Check
     def run
       require 'set'
 
@@ -30,7 +30,8 @@ module Nanoc::Extra::Checking::Checks
 
     def pruner
       exclude_config = @config.fetch(:prune, {}).fetch(:exclude, [])
-      @pruner ||= Nanoc::Extra::Pruner.new(@site, exclude: exclude_config)
+      # FIXME: reps=nil is icky
+      @pruner ||= Nanoc::Pruner.new(@config, nil, exclude: exclude_config)
     end
   end
 end

data/lib/nanoc/{extra/checking → checking}/checks/w3c_validator.rb

@@ -1,6 +1,6 @@
-module ::Nanoc::Extra::Checking::Checks
+module ::Nanoc::Checking::Checks
   # @api private
-  class W3CValidator < ::Nanoc::Extra::Checking::Check
+  class W3CValidator < ::Nanoc::Checking::Check
     def run
       require 'w3c_validators'
 

data/lib/nanoc/{extra/checking → checking}/dsl.rb

@@ -1,4 +1,4 @@
-module Nanoc::Extra::Checking
+module Nanoc::Checking
   # @api private
   class DSL
     attr_reader :deploy_checks
@@ -15,7 +15,7 @@ module Nanoc::Extra::Checking
     end
 
     def check(identifier, &block)
-      klass = Class.new(::Nanoc::Extra::Checking::Check)
+      klass = Class.new(::Nanoc::Checking::Check)
       klass.send(:define_method, :run, &block)
       klass.send(:identifier, identifier)
     end

data/lib/nanoc/{extra/checking → checking}/issue.rb

@@ -1,4 +1,4 @@
-module Nanoc::Extra::Checking
+module Nanoc::Checking
   # @api private
   class Issue
     attr_reader :description

data/lib/nanoc/{extra/checking → checking}/runner.rb

@@ -1,4 +1,4 @@
-module Nanoc::Extra::Checking
+module Nanoc::Checking
   # Runner is reponsible for running issue checks.
   #
   # @api private
@@ -67,7 +67,7 @@ module Nanoc::Extra::Checking
       unless @dsl_loaded
         @dsl =
           if dsl_present?
-            Nanoc::Extra::Checking::DSL.from_file(checks_filename)
+            Nanoc::Checking::DSL.from_file(checks_filename)
           else
             nil
           end
@@ -93,12 +93,12 @@ module Nanoc::Extra::Checking
     end
 
     def all_check_classes
-      Nanoc::Extra::Checking::Check.all.map(&:last).uniq
+      Nanoc::Checking::Check.all.map(&:last).uniq
     end
 
     def check_classes_named(n)
       n.map do |a|
-        klass = Nanoc::Extra::Checking::Check.named(a)
+        klass = Nanoc::Checking::Check.named(a)
         raise Nanoc::Int::Errors::GenericTrivial, "Unknown check: #{a}" if klass.nil?
         klass
       end

data/lib/nanoc/cli/cleaning_stream.rb

@@ -145,7 +145,7 @@ module Nanoc::CLI
     protected
 
     def _nanoc_clean(s)
-      @stream_cleaners.reduce(s.to_s) { |a, e| e.clean(a) }
+      @stream_cleaners.reduce(s.to_s) { |acc, elem| elem.clean(acc) }
     end
 
     def _nanoc_swallow_broken_pipe_errors_while

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

@@ -14,7 +14,7 @@ module Nanoc::CLI::Commands
       validate_options_and_arguments
       load_site(preprocess: true)
 
-      runner = Nanoc::Extra::Checking::Runner.new(site)
+      runner = Nanoc::Checking::Runner.new(site)
 
       if options[:list]
         runner.list_checks

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

@@ -164,19 +164,55 @@ module Nanoc::CLI::Commands
 
       # @param [Enumerable<Nanoc::Int::ItemRep>] reps
       def initialize(reps:)
-        @times = {}
+        # rep ->
+        #   filter_name ->
+        #     accum -> 0.0
+        #     last_start -> nil
+        @times_per_rep = {}
 
         @reps = reps
       end
 
       # @see Listener#start
       def start
-        Nanoc::Int::NotificationCenter.on(:filtering_started) do |_rep, filter_name|
-          @times[filter_name] ||= []
-          @times[filter_name] << { start: Time.now }
+        Nanoc::Int::NotificationCenter.on(:filtering_started) do |rep, filter_name|
+          @times_per_rep[rep] ||= {}
+          @times_per_rep[rep][filter_name] ||= {}
+
+          @times_per_rep[rep][filter_name][:last_start] = Time.now
+          @times_per_rep[rep][filter_name][:accum] ||= []
+          @times_per_rep[rep][filter_name][:suspended] = false
+        end
+
+        Nanoc::Int::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
+          times = @times_per_rep[rep][filter_name]
+          last_start = @times_per_rep[rep][filter_name][:last_start]
+
+          times[:accum] << (Time.now - last_start)
+          @times_per_rep[rep][filter_name].delete(:last_start)
+        end
+
+        Nanoc::Int::NotificationCenter.on(:compilation_suspended) do |rep, _exception|
+          @times_per_rep.fetch(rep, {}).each do |_filter_name, times|
+            if times[:last_start]
+              times[:accum] << (Time.now - times[:last_start])
+              times.delete(:last_start)
+              times[:suspended] = true
+
+              break
+            end
+          end
         end
-        Nanoc::Int::NotificationCenter.on(:filtering_ended) do |_rep, filter_name|
-          @times[filter_name].last[:stop] = Time.now
+
+        Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
+          @times_per_rep.fetch(rep, {}).each do |filter_name, times|
+            if times[:suspended]
+              @times_per_rep[rep][filter_name][:last_start] = Time.now
+              times[:suspended] = false
+
+              break
+            end
+          end
         end
       end
 
@@ -217,7 +253,7 @@ module Nanoc::CLI::Commands
         # Calculate stats
         count = samples.size
         min   = samples.min
-        tot   = samples.reduce(0) { |a, e| a + e }
+        tot   = samples.reduce(0) { |acc, elem| acc + elem }
         avg   = tot / count
         max   = samples.max
 
@@ -236,55 +272,17 @@ module Nanoc::CLI::Commands
       def durations_per_filter
         @_durations_per_filter ||= begin
           result = {}
-          @times.keys.each do |filter_name|
-            durations = durations_for_filter(filter_name)
-            if durations
-              result[filter_name] = durations
-            end
-          end
-          result
-        end
-      end
 
-      def durations_for_filter(filter_name)
-        result = []
-        @times[filter_name].each do |sample|
-          if sample[:start] && sample[:stop]
-            result << sample[:stop] - sample[:start]
+          @times_per_rep.each do |_rep, times_per_filter|
+            times_per_filter.each do |filter_name, data|
+              result[filter_name] ||= []
+              result[filter_name].concat(data[:accum])
+            end
           end
-        end
-        result
-      end
-    end
-
-    # Controls garbage collection so that it only occurs once every 20 items
-    class GCController < Listener
-      # @see Listener#enable_for?
-      def self.enable_for?(_command_runner)
-        !ENV.key?('TRAVIS')
-      end
 
-      def initialize(*)
-        @gc_count = 0
-      end
-
-      # @see Listener#start
-      def start
-        Nanoc::Int::NotificationCenter.on(:compilation_started) do |_rep|
-          if (@gc_count % 20).zero?
-            GC.enable
-            GC.start
-            GC.disable
-          end
-          @gc_count += 1
+          result
         end
       end
-
-      # @see Listener#stop
-      def stop
-        super
-        GC.enable
-      end
     end
 
     # Prints debug information (compilation started/ended, filtering started/ended, …)
@@ -303,7 +301,7 @@ module Nanoc::CLI::Commands
           puts "*** Ended compilation of #{rep.inspect}"
           puts
         end
-        Nanoc::Int::NotificationCenter.on(:compilation_failed) do |rep, e|
+        Nanoc::Int::NotificationCenter.on(:compilation_suspended) do |rep, e|
           puts "*** Suspended compilation of #{rep.inspect}: #{e.message}"
         end
         Nanoc::Int::NotificationCenter.on(:cached_content_used) do |rep|
@@ -325,6 +323,7 @@ module Nanoc::CLI::Commands
     class FileActionPrinter < Listener
       def initialize(reps:)
         @start_times = {}
+        @acc_durations = {}
 
         @reps = reps
       end
@@ -332,10 +331,18 @@ module Nanoc::CLI::Commands
       # @see Listener#start
       def start
         Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
-          @start_times[rep.raw_path] = Time.now
+          @start_times[rep] = Time.now
+          @acc_durations[rep] ||= 0.0
+        end
+
+        Nanoc::Int::NotificationCenter.on(:compilation_suspended) do |rep|
+          @acc_durations[rep] += Time.now - @start_times[rep]
         end
-        Nanoc::Int::NotificationCenter.on(:rep_written) do |_rep, path, is_created, is_modified|
-          duration = path && @start_times[path] ? Time.now - @start_times[path] : nil
+
+        Nanoc::Int::NotificationCenter.on(:rep_written) do |rep, path, is_created, is_modified|
+          @acc_durations[rep] += Time.now - @start_times[rep]
+          duration = @acc_durations[rep]
+
           action =
             if is_created then :create
             elsif is_modified then :update
@@ -418,7 +425,6 @@ module Nanoc::CLI::Commands
         Nanoc::CLI::Commands::Compile::DiffGenerator,
         Nanoc::CLI::Commands::Compile::DebugPrinter,
         Nanoc::CLI::Commands::Compile::TimingRecorder,
-        Nanoc::CLI::Commands::Compile::GCController,
         Nanoc::CLI::Commands::Compile::FileActionPrinter,
         Nanoc::CLI::Commands::Compile::StackProfProfiler,
       ]