nanoc 4.4.4 → 4.4.5

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

@@ -7,8 +7,10 @@ module Nanoc::Int
       dependency_store =
         Nanoc::Int::DependencyStore.new(site.items.to_a + site.layouts.to_a, env_name: site.config.env_name)
 
+      objects = site.items.to_a + site.layouts.to_a + site.code_snippets + [site.config]
+
       checksum_store =
-        Nanoc::Int::ChecksumStore.new(site: site)
+        Nanoc::Int::ChecksumStore.new(site: site, objects: objects)
 
       item_rep_repo = Nanoc::Int::ItemRepRepo.new
 

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

@@ -7,23 +7,24 @@ module Nanoc
         end
       end
 
-      def initialize(compiler, dependency_tracker)
-        @compiler = compiler
+      def initialize(rep, compilation_context, dependency_tracker)
+        @rep = rep
+        @compilation_context = compilation_context
         @dependency_tracker = dependency_tracker
       end
 
-      def filter(rep, filter_name, filter_args = {})
-        filter = filter_for_filtering(rep, filter_name)
+      def filter(filter_name, filter_args = {})
+        filter = filter_for_filtering(@rep, filter_name)
 
         begin
-          Nanoc::Int::NotificationCenter.post(:filtering_started, rep, filter_name)
+          Nanoc::Int::NotificationCenter.post(:filtering_started, @rep, filter_name)
 
           # Run filter
-          last = rep.snapshot_contents[:last]
-          source = rep.binary? ? last.filename : last.string
+          last = @rep.snapshot_contents[:last]
+          source = @rep.binary? ? last.filename : last.string
           filter_args.freeze
           result = filter.setup_and_run(source, filter_args)
-          rep.snapshot_contents[:last] =
+          @rep.snapshot_contents[:last] =
             if filter.class.to_binary?
               Nanoc::Int::BinaryContent.new(filter.output_filename).tap(&:freeze)
             else
@@ -36,15 +37,15 @@ module Nanoc
           end
 
           # Create snapshot
-          snapshot(rep, rep.snapshot_contents[:post] ? :post : :pre, final: false) unless rep.binary?
+          snapshot(@rep.snapshot_contents[:post] ? :post : :pre, final: false) unless @rep.binary?
         ensure
-          Nanoc::Int::NotificationCenter.post(:filtering_ended, rep, filter_name)
+          Nanoc::Int::NotificationCenter.post(:filtering_ended, @rep, filter_name)
         end
       end
 
-      def layout(rep, layout_identifier, extra_filter_args = nil)
+      def layout(layout_identifier, extra_filter_args = nil)
         layout = find_layout(layout_identifier)
-        filter_name, filter_args = *@compiler.filter_name_and_args_for_layout(layout)
+        filter_name, filter_args = *@compilation_context.filter_name_and_args_for_layout(layout)
         if filter_name.nil?
           raise Nanoc::Int::Errors::Generic, "Cannot find rule for layout matching #{layout_identifier}"
         end
@@ -52,64 +53,49 @@ module Nanoc
         filter_args.freeze
 
         # Check whether item can be laid out
-        raise Nanoc::Int::Errors::CannotLayoutBinaryItem.new(rep) if rep.binary?
+        raise Nanoc::Int::Errors::CannotLayoutBinaryItem.new(@rep) if @rep.binary?
 
         # Create "pre" snapshot
-        if rep.snapshot_contents[:post].nil?
-          snapshot(rep, :pre, final: true)
+        if @rep.snapshot_contents[:post].nil?
+          snapshot(:pre, final: true)
         end
 
         # Create filter
         klass = Nanoc::Filter.named(filter_name)
         raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
-        view_context = @compiler.create_view_context(@dependency_tracker)
+        view_context = @compilation_context.create_view_context(@dependency_tracker)
         layout_view = Nanoc::LayoutView.new(layout, view_context)
-        filter = klass.new(assigns_for(rep).merge({ layout: layout_view }))
+        filter = klass.new(assigns_for(@rep).merge({ layout: layout_view }))
 
         # Visit
         @dependency_tracker.bounce(layout, raw_content: true)
 
         begin
-          Nanoc::Int::NotificationCenter.post(:filtering_started, rep, filter_name)
+          Nanoc::Int::NotificationCenter.post(:filtering_started, @rep, filter_name)
 
           # Layout
           content = layout.content
           arg = content.binary? ? content.filename : content.string
           res = filter.setup_and_run(arg, filter_args)
-          rep.snapshot_contents[:last] = Nanoc::Int::TextualContent.new(res).tap(&:freeze)
+          @rep.snapshot_contents[:last] = Nanoc::Int::TextualContent.new(res).tap(&:freeze)
 
           # Create "post" snapshot
-          snapshot(rep, :post, final: false)
+          snapshot(:post, final: false)
         ensure
-          Nanoc::Int::NotificationCenter.post(:filtering_ended, rep, filter_name)
+          Nanoc::Int::NotificationCenter.post(:filtering_ended, @rep, filter_name)
         end
       end
 
-      def snapshot(rep, snapshot_name, final: true, path: nil) # rubocop:disable Lint/UnusedMethodArgument
-        # NOTE: :path is irrelevant
-
-        unless rep.binary?
-          rep.snapshot_contents[snapshot_name] = rep.snapshot_contents[:last]
-        end
-
-        if snapshot_name == :pre && final
-          rep.snapshot_defs << Nanoc::Int::SnapshotDef.new(:pre, true)
-        end
-
-        if final
-          raw_path = rep.raw_path(snapshot: snapshot_name)
-          if raw_path
-            ItemRepWriter.new.write(rep, raw_path)
-          end
-        end
+      def snapshot(snapshot_name, final: true, path: nil) # rubocop:disable Lint/UnusedMethodArgument
+        @rep.snapshot_contents[snapshot_name] = @rep.snapshot_contents[:last]
       end
 
       def assigns_for(rep)
-        @compiler.assigns_for(rep, @dependency_tracker)
+        @compilation_context.assigns_for(rep, @dependency_tracker)
       end
 
       def layouts
-        @compiler.site.layouts
+        @compilation_context.site.layouts
       end
 
       def find_layout(arg)
@@ -140,7 +126,7 @@ module Nanoc
       end
 
       def use_globs?
-        @compiler.site.config[:string_pattern_type] == 'glob'
+        @compilation_context.site.config[:string_pattern_type] == 'glob'
       end
     end
   end

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

@@ -17,6 +17,10 @@ module Nanoc::Int
       end
 
       Nanoc::Int::ItemRepRouter.new(@reps, @action_provider, @site).run
+
+      @reps.each do |rep|
+        rep.snapshot_defs = @action_provider.snapshots_defs_for(rep)
+      end
     end
   end
 end

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

@@ -3,7 +3,10 @@ module Nanoc::Int
   class ItemRepWriter
     TMP_TEXT_ITEMS_DIR = 'text_items'.freeze
 
-    def write(item_rep, raw_path)
+    def write(item_rep, snapshot_name)
+      raw_path = item_rep.raw_path(snapshot: snapshot_name)
+      return unless raw_path
+
       # Create parent directory
       FileUtils.mkdir_p(File.dirname(raw_path))
 
@@ -15,7 +18,7 @@ module Nanoc::Int
         :will_write_rep, item_rep, raw_path
       )
 
-      content = item_rep.snapshot_contents[:last]
+      content = item_rep.snapshot_contents[snapshot_name]
       if content.binary?
         temp_path = content.filename
       else

data/lib/nanoc/base/{compilation → services}/outdatedness_checker.rb

@@ -44,7 +44,7 @@ module Nanoc::Int
         when Nanoc::Int::Layout
           apply_rules(RULES_FOR_LAYOUT, obj)
         else
-          raise "do not know how to check outdatedness of #{obj.inspect}"
+          raise Nanoc::Int::Errors::InternalInconsistency, "do not know how to check outdatedness of #{obj.inspect}"
         end
       end
       memoize :outdatedness_status_for

data/lib/nanoc/base/views/post_compile_item_rep_view.rb

@@ -5,7 +5,7 @@ module Nanoc
         raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(unwrap)
       end
 
-      snapshot_contents = @context.compiler.compiled_content_cache[unwrap]
+      snapshot_contents = @context.compilation_context.compiled_content_cache[unwrap]
       snapshot_name = snapshot || (snapshot_contents[:pre] ? :pre : :last)
 
       if snapshot_contents[snapshot_name]

data/lib/nanoc/base/views/view_context.rb

@@ -4,13 +4,13 @@ module Nanoc
     attr_reader :reps
     attr_reader :items
     attr_reader :dependency_tracker
-    attr_reader :compiler
+    attr_reader :compilation_context
 
-    def initialize(reps:, items:, dependency_tracker:, compiler:)
+    def initialize(reps:, items:, dependency_tracker:, compilation_context:)
       @reps = reps
       @items = items
       @dependency_tracker = dependency_tracker
-      @compiler = compiler
+      @compilation_context = compilation_context
     end
   end
 end

data/lib/nanoc/checking/check.rb

@@ -20,7 +20,7 @@ module Nanoc::Checking
       output_filenames = Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
 
       # FIXME: ugly
-      view_context = site.compiler.create_view_context(Nanoc::Int::DependencyTracker::Null.new)
+      view_context = site.compiler.compilation_context.create_view_context(Nanoc::Int::DependencyTracker::Null.new)
 
       context = {
         items: Nanoc::ItemCollectionWithRepsView.new(site.items, view_context),

data/lib/nanoc/checking/checks/external_links.rb

@@ -103,7 +103,7 @@ module ::Nanoc::Checking::Checks
       if last_err
         return Result.new(href, last_err.message)
       else
-        raise 'should not have gotten here'
+        raise Nanoc::Int::Errors::InternalInconsistency, 'last_err cannot be nil'
       end
     end
 

data/lib/nanoc/cli.rb

@@ -19,8 +19,6 @@ module Nanoc::CLI
   autoload 'ErrorHandler',        'nanoc/cli/error_handler'
 
   # @return [Boolean] true if debug output is enabled, false if not
-  #
-  # @since 3.2.0
   def self.debug?
     @debug || false
   end
@@ -29,8 +27,6 @@ module Nanoc::CLI
   #   false if it should not
   #
   # @return [void]
-  #
-  # @since 3.2.0
   def self.debug=(boolean)
     @debug = boolean
   end

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

@@ -420,11 +420,11 @@ module Nanoc::CLI::Commands
 
     def default_listener_classes
       [
+        Nanoc::CLI::Commands::Compile::StackProfProfiler,
         Nanoc::CLI::Commands::Compile::DiffGenerator,
         Nanoc::CLI::Commands::Compile::DebugPrinter,
         Nanoc::CLI::Commands::Compile::TimingRecorder,
         Nanoc::CLI::Commands::Compile::FileActionPrinter,
-        Nanoc::CLI::Commands::Compile::StackProfProfiler,
       ]
     end
 
@@ -449,7 +449,7 @@ module Nanoc::CLI::Commands
     end
 
     def teardown_listeners
-      @listeners.each(&:stop_safely)
+      @listeners.reverse_each(&:stop_safely)
     end
 
     def reps

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

@@ -34,7 +34,7 @@ module Nanoc::CLI::Commands
         reps: reps_for(site),
         items: site.items,
         dependency_tracker: Nanoc::Int::DependencyTracker::Null.new,
-        compiler: nil,
+        compilation_context: nil,
       )
     end
 

data/lib/nanoc/data_sources/filesystem.rb

@@ -117,7 +117,7 @@ module Nanoc::DataSources
 
         ProtoDocument.new(is_binary: true, filename: content_filename, attributes: meta)
       elsif is_binary && klass == Nanoc::Int::Layout
-        raise "The layout file '#{content_filename}' is a binary file, but layouts can only be textual"
+        raise Errors::BinaryLayout.new(content_filename)
       else
         parse_result = parse(content_filename, meta_filename)
 
@@ -239,11 +239,11 @@ module Nanoc::DataSources
 
         # Check number of files per type
         unless [0, 1].include?(meta_filenames.size)
-          raise "Found #{meta_filenames.size} meta files for #{basename}; expected 0 or 1"
+          raise Errors::MultipleMetaFiles.new(meta_filenames, basename)
         end
         unless config[:identifier_type] == 'full'
           unless [0, 1].include?(content_filenames.size)
-            raise "Found #{content_filenames.size} content files for #{basename}; expected 0 or 1"
+            raise Errors::MultipleContentFiles.new(meta_filenames, basename)
           end
         end
 
@@ -352,7 +352,7 @@ module Nanoc::DataSources
 
       pieces = data.split(/^(-{5}|-{3})[ \t]*\r?\n?/, 3)
       if pieces.size < 4
-        raise "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."
+        raise Errors::InvalidFormat.new(content_filename)
       end
 
       meta = parse_metadata(pieces[2], content_filename)
@@ -366,7 +366,7 @@ module Nanoc::DataSources
       begin
         meta = YAML.load(data) || {}
       rescue => e
-        raise "Could not parse YAML for #{filename}: #{e.message}"
+        raise Errors::UnparseableMetadata.new(filename, e)
       end
 
       verify_meta(meta, filename)
@@ -386,16 +386,10 @@ module Nanoc::DataSources
       end
     end
 
-    class InvalidMetadataError < Nanoc::Error
-      def initialize(filename, klass)
-        super("The file #{filename} has invalid metadata (expected key-value pairs, found #{klass} instead)")
-      end
-    end
-
     def verify_meta(meta, filename)
       return if meta.is_a?(Hash)
 
-      raise InvalidMetadataError.new(filename, meta.class)
+      raise Errors::InvalidMetadata.new(filename, meta.class)
     end
 
     # Reads the content of the file with the given name and returns a string
@@ -407,7 +401,7 @@ module Nanoc::DataSources
       begin
         data = File.read(filename)
       rescue => e
-        raise "Could not read #{filename}: #{e.inspect}"
+        raise Errors::FileUnreadable.new(filename, e)
       end
 
       # Fix
@@ -422,11 +416,11 @@ module Nanoc::DataSources
         begin
           data.encode!('UTF-8')
         rescue
-          raise_encoding_error(filename, original_encoding)
+          raise Errors::InvalidEncoding.new(filename, original_encoding)
         end
 
         unless data.valid_encoding?
-          raise_encoding_error(filename, original_encoding)
+          raise Errors::InvalidEncoding.new(filename, original_encoding)
         end
       end
 
@@ -435,12 +429,8 @@ module Nanoc::DataSources
 
       data
     end
-
-    # Raises an invalid encoding error for the given filename and encoding.
-    def raise_encoding_error(filename, encoding)
-      raise "Could not read #{filename} because the file is not valid #{encoding}."
-    end
   end
 end
 
 require_relative 'filesystem/tools'
+require_relative 'filesystem/errors'

data/lib/nanoc/data_sources/filesystem/errors.rb

@@ -0,0 +1,55 @@
+class Nanoc::DataSources::Filesystem < Nanoc::DataSource
+  # @api private
+  module Errors
+    class Generic < ::Nanoc::Error
+    end
+
+    class BinaryLayout < Generic
+      def initialize(content_filename)
+        super("The layout file '#{content_filename}' is a binary file, but layouts can only be textual")
+      end
+    end
+
+    class MultipleMetaFiles < Generic
+      def initialize(meta_filenames, basename)
+        super("Found #{meta_filenames.size} meta files for #{basename}; expected 0 or 1")
+      end
+    end
+
+    class MultipleContentFiles < Generic
+      def initialize(content_filenames, basename)
+        super("Found #{content_filenames.size} content files for #{basename}; expected 0 or 1")
+      end
+    end
+
+    class InvalidFormat < Generic
+      def initialize(content_filename)
+        super("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
+    end
+
+    class UnparseableMetadata < Generic
+      def initialize(filename, error)
+        super("Could not parse metadata for #{filename}: #{error.message}")
+      end
+    end
+
+    class InvalidMetadata < Generic
+      def initialize(filename, klass)
+        super("The file #{filename} has invalid metadata (expected key-value pairs, found #{klass} instead)")
+      end
+    end
+
+    class InvalidEncoding < Generic
+      def initialize(filename, encoding)
+        super("Could not read #{filename} because the file is not valid #{encoding}.")
+      end
+    end
+
+    class FileUnreadable < Generic
+      def initialize(filename, error)
+        super("Could not read #{filename}: #{error.inspect}")
+      end
+    end
+  end
+end

data/lib/nanoc/filters/asciidoc.rb

@@ -1,6 +1,4 @@
 module Nanoc::Filters
-  # @since 3.2.0
-  #
   # @api private
   class AsciiDoc < Nanoc::Filter
     # Runs the content through [AsciiDoc](http://www.methods.co.nz/asciidoc/).