nanoc 4.11.0 → 4.11.1

data/lib/nanoc/cli/commands/compile_listeners/timing_recorder.rb

@@ -12,7 +12,7 @@ module Nanoc::CLI::Commands::CompileListeners
       Nanoc::CLI.verbosity >= 1
     end
 
-    # @param [Enumerable<Nanoc::Int::ItemRep>] reps
+    # @param [Enumerable<Nanoc::Core::ItemRep>] reps
     def initialize(reps:)
       @reps = reps
 
@@ -52,7 +52,7 @@ module Nanoc::CLI::Commands::CompileListeners
         @load_stores_summary.observe(duration, name: klass.to_s)
       end
 
-      on(:compilation_suspended) do |rep, _exception|
+      on(:compilation_suspended) do |rep, _target_rep, _snapshot_name|
         filter_stopwatches.fetch(rep).each(&:stop)
       end
 
@@ -60,46 +60,50 @@ module Nanoc::CLI::Commands::CompileListeners
         filter_stopwatches.fetch(rep, []).each(&:start)
       end
 
-      phase_stopwatches = {}
+      setup_phase_notifications
+    end
+
+    # @see Listener#stop
+    def stop
+      print_profiling_feedback
+    end
+
+    protected
+
+    def setup_phase_notifications
+      stopwatches = {}
 
       on(:phase_started) do |phase_name, rep|
-        stopwatches = phase_stopwatches.fetch(rep) { phase_stopwatches[rep] = {} }
-        stopwatches[phase_name] = DDMetrics::Stopwatch.new.tap(&:start)
+        stopwatch = stopwatches[[phase_name, rep]] = DDMetrics::Stopwatch.new
+        stopwatch.start
       end
 
       on(:phase_ended) do |phase_name, rep|
-        stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
+        stopwatch = stopwatches[[phase_name, rep]]
         stopwatch.stop
 
         @phases_summary.observe(stopwatch.duration, name: phase_name)
       end
 
       on(:phase_yielded) do |phase_name, rep|
-        stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
+        stopwatch = stopwatches[[phase_name, rep]]
         stopwatch.stop
       end
 
       on(:phase_resumed) do |phase_name, rep|
-        stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
-        stopwatch.start if stopwatch.stopped?
+        # It probably looks weird that a phase can be resumed even though it was not suspended earlier. This can happen when compilation is suspended, where you’d get the sequence started -> suspended -> started -> resumed.
+        stopwatch = stopwatches[[phase_name, rep]]
+        stopwatch.start unless stopwatch.running?
       end
 
       on(:phase_aborted) do |phase_name, rep|
-        stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
+        stopwatch = stopwatches[[phase_name, rep]]
         stopwatch.stop if stopwatch.running?
 
         @phases_summary.observe(stopwatch.duration, name: phase_name)
       end
     end
 
-    # @see Listener#stop
-    def stop
-      print_profiling_feedback
-      super
-    end
-
-    protected
-
     def table_for_summary(name, summary)
       headers = [name.to_s, 'count', 'min', '.50', '.90', '.95', 'max', 'tot']
 

data/lib/nanoc/cli/commands/create-site.rb

@@ -22,7 +22,7 @@ module Nanoc::CLI::Commands
       # A list of file extensions that Nanoc will consider to be textual rather than
       # binary. If an item with an extension not in this list is found,  the file
       # will be considered as binary.
-      text_extensions: #{array_to_yaml(Nanoc::Int::Configuration::DEFAULT_CONFIG[:text_extensions])}
+      text_extensions: #{array_to_yaml(Nanoc::Core::Configuration::DEFAULT_CONFIG[:text_extensions])}
 
       prune:
         auto_prune: true
@@ -227,11 +227,6 @@ module Nanoc::CLI::Commands
         )
       end
 
-      # Setup notifications
-      Nanoc::Int::NotificationCenter.on(:file_created) do |file_path|
-        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
-      end
-
       # Build entire site
       FileUtils.mkdir_p(path)
       FileUtils.cd(File.join(path)) do
@@ -254,7 +249,7 @@ module Nanoc::CLI::Commands
 
     def write(filename, content)
       File.write(filename, content)
-      Nanoc::Int::NotificationCenter.post(:file_created, filename)
+      Nanoc::CLI::Logger.instance.file(:high, :create, filename)
     end
   end
 end

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

@@ -20,7 +20,7 @@ module Nanoc::CLI::Commands
       @site = load_site
       Nanoc::Int::Compiler.new_for(@site).run_until_preprocessed if options[:preprocess]
 
-      Nanoc::Int::Context.new(env).pry
+      Nanoc::Core::Context.new(env).pry
     end
 
     def env

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

@@ -70,7 +70,7 @@ module Nanoc::CLI::Commands
       sorter =
         lambda do |dep|
           case dep
-          when Nanoc::Int::Document
+          when Nanoc::Core::Document
             dep.from.identifier.to_s
           else
             ''
@@ -89,15 +89,15 @@ module Nanoc::CLI::Commands
 
           type =
             case pred
-            when Nanoc::Int::Layout
+            when Nanoc::Core::Layout
               'layout'
-            when Nanoc::Int::Item
+            when Nanoc::Core::Item
               'item'
-            when Nanoc::Int::Configuration
+            when Nanoc::Core::Configuration
               'config'
-            when Nanoc::Int::ItemCollection
+            when Nanoc::Core::ItemCollection
               'items'
-            when Nanoc::Int::LayoutCollection
+            when Nanoc::Core::LayoutCollection
               'layouts'
             else
               raise Nanoc::Int::Errors::InternalInconsistency, "unexpected pred type #{pred}"
@@ -105,11 +105,11 @@ module Nanoc::CLI::Commands
 
           pred_identifier =
             case pred
-            when Nanoc::Int::Document
+            when Nanoc::Core::Document
               pred.identifier.to_s
-            when Nanoc::Int::Configuration
+            when Nanoc::Core::Configuration
               nil
-            when Nanoc::Int::IdentifiableCollection
+            when Nanoc::Core::IdentifiableCollection
               case dep.props.raw_content
               when true
                 'matching any'

data/lib/nanoc/cli/logger.rb

@@ -14,7 +14,7 @@ module Nanoc::CLI
       identical: '',    # (nothing)
       cached: '',       # (nothing)
       skip: '',         # (nothing)
-      delete: "\e[31m"  # red
+      delete: "\e[31m", # red
     }.freeze
 
     include Singleton

data/lib/nanoc/data_sources/filesystem.rb

@@ -66,12 +66,12 @@ module Nanoc::DataSources
 
     # See {Nanoc::DataSource#items}.
     def items
-      load_objects(content_dir_name, Nanoc::Int::Item)
+      load_objects(content_dir_name, Nanoc::Core::Item)
     end
 
     # See {Nanoc::DataSource#layouts}.
     def layouts
-      load_objects(layouts_dir_name, Nanoc::Int::Layout)
+      load_objects(layouts_dir_name, Nanoc::Core::Layout)
     end
 
     def item_changes
@@ -141,11 +141,11 @@ module Nanoc::DataSources
     def read_proto_document(content_filename, meta_filename, klass)
       is_binary = content_filename && !@site_config[:text_extensions].include?(File.extname(content_filename)[1..-1])
 
-      if is_binary && klass == Nanoc::Int::Item
+      if is_binary && klass == Nanoc::Core::Item
         meta = (meta_filename && YAML.load_file(meta_filename)) || {}
 
         ProtoDocument.new(is_binary: true, filename: content_filename, attributes: meta)
-      elsif is_binary && klass == Nanoc::Int::Layout
+      elsif is_binary && klass == Nanoc::Core::Layout
         raise Errors::BinaryLayout.new(content_filename)
       else
         parse_result = parse(content_filename, meta_filename)
@@ -261,9 +261,9 @@ module Nanoc::DataSources
       full_content_filename = content_filename && File.expand_path(content_filename)
 
       if proto_doc.binary?
-        Nanoc::Int::BinaryContent.new(full_content_filename)
+        Nanoc::Core::BinaryContent.new(full_content_filename)
       else
-        Nanoc::Int::TextualContent.new(proto_doc.content, filename: full_content_filename)
+        Nanoc::Core::TextualContent.new(proto_doc.content, filename: full_content_filename)
       end
     end
 
@@ -351,7 +351,7 @@ module Nanoc::DataSources
     # can be the content filename or the meta filename.
     def identifier_for_filename(filename)
       if config[:identifier_type] == 'full'
-        return Nanoc::Identifier.new(filename)
+        return Nanoc::Core::Identifier.new(filename)
       end
 
       regex =
@@ -360,7 +360,7 @@ module Nanoc::DataSources
         else
           allow_periods_in_identifiers? ? /\.[^\/\.]+$/ : /\.[^\/]+$/
         end
-      Nanoc::Identifier.new(filename.sub(regex, ''), type: :legacy)
+      Nanoc::Core::Identifier.new(filename.sub(regex, ''), type: :legacy)
     end
 
     # Returns the base name of filename, i.e. filename with the first or all

data/lib/nanoc/filters/erb.rb

@@ -22,7 +22,7 @@ module Nanoc::Filters
       assigns.merge!(params[:locals] || {})
 
       # Create context
-      context = ::Nanoc::Int::Context.new(assigns)
+      context = ::Nanoc::Core::Context.new(assigns)
 
       # Get binding
       proc = assigns[:content] ? -> { assigns[:content] } : nil

data/lib/nanoc/filters/erubi.rb

@@ -16,7 +16,7 @@ module Nanoc::Filters
     # @return [String] The filtered content
     def run(content, params = {})
       # Create context
-      context = ::Nanoc::Int::Context.new(assigns)
+      context = ::Nanoc::Core::Context.new(assigns)
 
       # Get binding
       proc = assigns[:content] ? -> { assigns[:content] } : nil

data/lib/nanoc/filters/erubis.rb

@@ -15,7 +15,7 @@ module Nanoc::Filters
     # @return [String] The filtered content
     def run(content, _params = {})
       # Create context
-      context = ::Nanoc::Int::Context.new(assigns)
+      context = ::Nanoc::Core::Context.new(assigns)
 
       # Get binding
       proc = assigns[:content] ? -> { assigns[:content] } : nil

data/lib/nanoc/filters/haml.rb

@@ -18,7 +18,7 @@ module Nanoc::Filters
       options = params.merge(filename: filename)
 
       # Create context
-      context = ::Nanoc::Int::Context.new(assigns)
+      context = ::Nanoc::Core::Context.new(assigns)
 
       # Get result
       proc = assigns[:content] ? -> { assigns[:content] } : nil

data/lib/nanoc/filters/sass.rb

@@ -28,7 +28,7 @@ module Nanoc::Filters
       css_path = options.delete(:css_path) || filter.object_id.to_s
       sourcemap_path = options.delete(:sourcemap_path)
       if sourcemap_path == :inline
-        sourcemap_path = Nanoc::Int::TempFilenameFactory.instance.create('sass_sourcemap')
+        sourcemap_path = Nanoc::Core::TempFilenameFactory.instance.create('sass_sourcemap')
         inline = true
       end
 

data/lib/nanoc/filters/slim.rb

@@ -20,7 +20,7 @@ module Nanoc::Filters
       }.merge params
 
       # Create context
-      context = ::Nanoc::Int::Context.new(assigns)
+      context = ::Nanoc::Core::Context.new(assigns)
 
       ::Slim::Template.new(filename, params) { content }.render(context) { assigns[:content] }
     end

data/lib/nanoc/helpers/breadcrumbs.rb

@@ -49,7 +49,7 @@ module Nanoc::Helpers
       def self.patterns_for_prefix(prefix)
         prefixes =
           unfold(prefix) do |old_prefix|
-            new_prefix = Nanoc::Identifier.new(old_prefix).without_ext
+            new_prefix = Nanoc::Core::Identifier.new(old_prefix).without_ext
             new_prefix == old_prefix ? nil : new_prefix
           end
 
@@ -110,7 +110,7 @@ module Nanoc::Helpers
       tiebreaker = Int::ERROR_TIEBREAKER if tiebreaker == :error
 
       if @item.identifier.legacy?
-        prefixes.map { |pr| @items[Nanoc::Identifier.new('/' + pr, type: :legacy)] }
+        prefixes.map { |pr| @items[Nanoc::Core::Identifier.new('/' + pr, type: :legacy)] }
       else
         ancestral_prefixes = prefixes.reject { |pr| pr =~ /^\/index\./ }[0..-2]
         ancestral_items =

data/lib/nanoc/helpers/capturing.rb

@@ -20,7 +20,7 @@ module Nanoc::Helpers
         content_string = capture(&block)
 
         # Get existing contents and prep for store
-        snapshot_repo = @item._context.snapshot_repo
+        compiled_content_store = @item._context.compiled_content_store
         rep = @item.reps[:default]._unwrap
         capture_name = "__capture_#{@name}".to_sym
         old_content_string =
@@ -28,10 +28,10 @@ module Nanoc::Helpers
           when :overwrite
             ''
           when :append
-            c = snapshot_repo.get(rep, capture_name)
+            c = compiled_content_store.get(rep, capture_name)
             c ? c.string : ''
           when :error
-            contents = snapshot_repo.get(rep, capture_name)
+            contents = compiled_content_store.get(rep, capture_name)
             if contents && contents.string != content_string
               # FIXME: get proper exception
               raise "a capture named #{@name.inspect} for #{@item.identifier} already exists"
@@ -44,8 +44,8 @@ module Nanoc::Helpers
           end
 
         # Store
-        new_content = Nanoc::Int::TextualContent.new(old_content_string + content_string)
-        snapshot_repo.set(rep, capture_name, new_content)
+        new_content = Nanoc::Core::TextualContent.new(old_content_string + content_string)
+        compiled_content_store.set(rep, capture_name, new_content)
       end
     end
 
@@ -67,13 +67,14 @@ module Nanoc::Helpers
           dependency_tracker.bounce(@requested_item._unwrap, compiled_content: true)
 
           unless rep.compiled?
-            Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(rep))
+            # FIXME: is :last appropriate?
+            Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(rep, :last))
             return run
           end
         end
 
-        snapshot_repo = @config._context.snapshot_repo
-        content = snapshot_repo.get(rep, "__capture_#{@name}".to_sym)
+        compiled_content_store = @config._context.compiled_content_store
+        content = compiled_content_store.get(rep, "__capture_#{@name}".to_sym)
         content ? content.string : nil
       end
     end

data/lib/nanoc/helpers/filtering.rb

@@ -30,9 +30,9 @@ module Nanoc::Helpers
       filter = klass.new(assigns)
 
       # Filter captured data
-      Nanoc::Int::NotificationCenter.post(:filtering_started, @item_rep._unwrap, filter_name)
+      Nanoc::Core::NotificationCenter.post(:filtering_started, @item_rep._unwrap, filter_name)
       filtered_data = filter.setup_and_run(data, arguments)
-      Nanoc::Int::NotificationCenter.post(:filtering_ended, @item_rep._unwrap, filter_name)
+      Nanoc::Core::NotificationCenter.post(:filtering_ended, @item_rep._unwrap, filter_name)
 
       # Append filtered data to buffer
       buffer = eval('_erbout', block.binding)

data/lib/nanoc/helpers/rendering.rb

@@ -10,7 +10,7 @@ module Nanoc::Helpers
     #
     # @raise [Nanoc::Int::Errors::UnknownLayout]
     # @raise [Nanoc::Int::Errors::CannotDetermineFilter]
-    # @raise [Nanoc::Int::Errors::UnknownFilter]
+    # @raise [Nanoc::Filter::UnknownFilter]
     #
     # @return [String, nil]
     def render(identifier, other_assigns = {}, &block)

data/lib/nanoc/rule_dsl.rb

@@ -20,3 +20,13 @@ require_relative 'rule_dsl/routing_rule_context'
 require_relative 'rule_dsl/rule'
 require_relative 'rule_dsl/compilation_rule'
 require_relative 'rule_dsl/routing_rule'
+
+Nanoc::Core::Checksummer.define_behavior(
+  Nanoc::RuleDSL::CompilationRuleContext,
+  Nanoc::Core::Checksummer::RuleContextUpdateBehavior,
+)
+
+Nanoc::Core::Checksummer.define_behavior(
+  Nanoc::RuleDSL::RulesCollection,
+  Nanoc::Core::Checksummer::DataUpdateBehavior,
+)

data/lib/nanoc/rule_dsl/action_provider.rb

@@ -65,7 +65,7 @@ module Nanoc::RuleDSL
           items: site.items,
           dependency_tracker: dependency_tracker,
           compilation_context: compiler.compilation_context(reps: reps),
-          snapshot_repo: nil,
+          compiled_content_store: nil,
         )
       ctx = new_postprocessor_context(site, view_context)
 
@@ -79,7 +79,7 @@ module Nanoc::RuleDSL
       view_context =
         Nanoc::ViewContextForPreCompilation.new(items: site.items)
 
-      Nanoc::Int::Context.new(
+      Nanoc::Core::Context.new(
         config: Nanoc::MutableConfigView.new(site.config, view_context),
         items: Nanoc::MutableItemCollectionView.new(site.items, view_context),
         layouts: Nanoc::MutableLayoutCollectionView.new(site.layouts, view_context),
@@ -88,7 +88,7 @@ module Nanoc::RuleDSL
 
     # @api private
     def new_postprocessor_context(site, view_context)
-      Nanoc::Int::Context.new(
+      Nanoc::Core::Context.new(
         config: Nanoc::ConfigView.new(site.config, view_context),
         items: Nanoc::PostCompileItemCollectionView.new(site.items, view_context),
       )

data/lib/nanoc/rule_dsl/action_recorder.rb

@@ -3,9 +3,9 @@
 module Nanoc
   module RuleDSL
     class ActionRecorder
-      include Nanoc::Int::ContractsSupport
+      include Nanoc::Core::ContractsSupport
 
-      contract Nanoc::Int::ItemRep => C::Any
+      contract Nanoc::Core::ItemRep => C::Any
       def initialize(rep)
         @action_sequence_builder = Nanoc::Int::ActionSequenceBuilder.new(rep)
 
@@ -37,7 +37,7 @@ module Nanoc
         @any_layouts = true
       end
 
-      MaybePathlike = C::Or[nil, Nanoc::UNDEFINED, String, Nanoc::Identifier]
+      MaybePathlike = C::Or[nil, Nanoc::UNDEFINED, String, Nanoc::Core::Identifier]
       contract Symbol, C::KeywordArgs[path: C::Optional[MaybePathlike]] => nil
       def snapshot(snapshot_name, path: Nanoc::UNDEFINED)
         unless Nanoc::UNDEFINED.equal?(path)