nanoc 4.11.0 → 4.11.1

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

@@ -20,7 +20,7 @@ module Nanoc
       res = @item_rep.raw_path(snapshot: snapshot)
 
       unless @item_rep.compiled?
-        Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(@item_rep))
+        Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(@item_rep, snapshot))
       end
 
       # Wait for file to exist
@@ -43,7 +43,7 @@ module Nanoc
     # @return [String] The content at the given snapshot.
     def compiled_content(snapshot: nil)
       @context.dependency_tracker.bounce(_unwrap.item, compiled_content: true)
-      @context.snapshot_repo.compiled_content(rep: _unwrap, snapshot: snapshot)
+      @context.compiled_content_store.compiled_content(rep: _unwrap, snapshot: snapshot)
     end
   end
 end

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

@@ -56,7 +56,7 @@ module Nanoc
 
       prop_attribute =
         case arg
-        when String, Nanoc::Identifier
+        when String, Nanoc::Core::Identifier
           [arg.to_s]
         when Regexp
           [arg]
@@ -93,7 +93,7 @@ module Nanoc
     def [](arg)
       prop_attribute =
         case arg
-        when String, Nanoc::Identifier
+        when String, Nanoc::Core::Identifier
           [arg.to_s]
         when Regexp
           [arg]

data/lib/nanoc/base/views/mixins/document_view_mixin.rb

@@ -31,7 +31,7 @@ module Nanoc
       self.class.hash ^ identifier.hash
     end
 
-    # @return [Nanoc::Identifier]
+    # @return [Nanoc::Core::Identifier]
     def identifier
       _unwrap.identifier
     end

data/lib/nanoc/base/views/mixins/mutable_document_view_mixin.rb

@@ -16,7 +16,7 @@ module Nanoc
     end
 
     def raw_content=(arg)
-      _unwrap.content = Nanoc::Int::Content.create(arg)
+      _unwrap.content = Nanoc::Core::Content.create(arg)
     end
 
     # Sets the value for the given attribute.
@@ -26,8 +26,8 @@ module Nanoc
     # @see Hash#[]=
     def []=(key, value)
       disallowed_value_classes = Set.new([
-        Nanoc::Int::Item,
-        Nanoc::Int::Layout,
+        Nanoc::Core::Item,
+        Nanoc::Core::Layout,
         Nanoc::CompilationItemView,
         Nanoc::LayoutView,
       ])
@@ -40,9 +40,9 @@ module Nanoc
 
     # Sets the identifier to the given argument.
     #
-    # @param [String, Nanoc::Identifier] arg
+    # @param [String, Nanoc::Core::Identifier] arg
     def identifier=(arg)
-      _unwrap.identifier = Nanoc::Identifier.from(arg)
+      _unwrap.identifier = Nanoc::Core::Identifier.from(arg)
     end
 
     # Updates the attributes based on the given hash.

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

@@ -15,7 +15,7 @@ module Nanoc
     #
     # @param [Hash] attributes A hash containing this item's attributes.
     #
-    # @param [Nanoc::Identifier, String] identifier This item's identifier.
+    # @param [Nanoc::Core::Identifier, String] identifier This item's identifier.
     #
     # @param [Boolean] binary Whether or not this item is binary
     #
@@ -24,8 +24,8 @@ module Nanoc
     #
     # @return [self]
     def create(content, attributes, identifier, binary: false, filename: nil)
-      content = Nanoc::Int::Content.create(content, binary: binary, filename: filename)
-      @objects = @objects.add(Nanoc::Int::Item.new(content, attributes, identifier))
+      content = Nanoc::Core::Content.create(content, binary: binary, filename: filename)
+      @objects = @objects.add(Nanoc::Core::Item.new(content, attributes, identifier))
       self
     end
   end

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

@@ -13,11 +13,11 @@ module Nanoc
     #
     # @param [Hash] attributes A hash containing this layout's attributes.
     #
-    # @param [Nanoc::Identifier, String] identifier This layout's identifier.
+    # @param [Nanoc::Core::Identifier, String] identifier This layout's identifier.
     #
     # @return [self]
     def create(content, attributes, identifier)
-      @objects = @objects.add(Nanoc::Int::Layout.new(content, attributes, identifier))
+      @objects = @objects.add(Nanoc::Core::Layout.new(content, attributes, identifier))
       self
     end
   end

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

@@ -3,27 +3,27 @@
 module Nanoc
   # @api private
   class ViewContextForCompilation
-    include Nanoc::Int::ContractsSupport
+    include Nanoc::Core::ContractsSupport
 
     attr_reader :reps
     attr_reader :items
     attr_reader :dependency_tracker
     attr_reader :compilation_context
-    attr_reader :snapshot_repo
+    attr_reader :compiled_content_store
 
     contract C::KeywordArgs[
       reps: Nanoc::Int::ItemRepRepo,
-      items: Nanoc::Int::IdentifiableCollection,
+      items: Nanoc::Core::IdentifiableCollection,
       dependency_tracker: C::Any,
       compilation_context: C::Any,
-      snapshot_repo: C::Any,
+      compiled_content_store: C::Any,
     ] => C::Any
-    def initialize(reps:, items:, dependency_tracker:, compilation_context:, snapshot_repo:)
+    def initialize(reps:, items:, dependency_tracker:, compilation_context:, compiled_content_store:)
       @reps = reps
       @items = items
       @dependency_tracker = dependency_tracker
       @compilation_context = compilation_context
-      @snapshot_repo = snapshot_repo
+      @compiled_content_store = compiled_content_store
     end
   end
 end

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

@@ -3,12 +3,12 @@
 module Nanoc
   # @api private
   class ViewContextForPreCompilation
-    include Nanoc::Int::ContractsSupport
+    include Nanoc::Core::ContractsSupport
 
     attr_reader :items
     attr_reader :dependency_tracker
 
-    contract C::KeywordArgs[items: Nanoc::Int::IdentifiableCollection] => C::Any
+    contract C::KeywordArgs[items: Nanoc::Core::IdentifiableCollection] => C::Any
     def initialize(items:)
       @items = items
 

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

@@ -3,14 +3,14 @@
 module Nanoc
   # @api private
   class ViewContextForShell
-    include Nanoc::Int::ContractsSupport
+    include Nanoc::Core::ContractsSupport
 
     attr_reader :items
     attr_reader :reps
     attr_reader :dependency_tracker
 
     contract C::KeywordArgs[
-      items: Nanoc::Int::IdentifiableCollection,
+      items: Nanoc::Core::IdentifiableCollection,
       reps: Nanoc::Int::ItemRepRepo,
     ] => C::Any
     def initialize(items:, reps:)

data/lib/nanoc/checking/check.rb

@@ -9,7 +9,7 @@ module Nanoc::Checking
   end
 
   # @api private
-  class Check < Nanoc::Int::Context
+  class Check < Nanoc::Core::Context
     extend DDPlugin::Plugin
 
     attr_reader :issues

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

@@ -2,7 +2,9 @@
 
 module Nanoc::CLI::Commands::CompileListeners
   class Abstract
-    def initialize(*); end
+    def initialize(*)
+      super()
+    end
 
     def self.enable_for?(command_runner, site) # rubocop:disable Lint/UnusedMethodArgument
       true
@@ -16,26 +18,41 @@ module Nanoc::CLI::Commands::CompileListeners
     # @abstract
     def stop; end
 
-    def run_while
+    def wrapped_start
+      @_notification_names = []
       start
+    end
+
+    def wrapped_stop
+      stop
+
+      Nanoc::Core::NotificationCenter.sync
+
+      @_notification_names.each do |name|
+        Nanoc::Core::NotificationCenter.remove(name, self)
+      end
+    end
+
+    def run_while
+      wrapped_start
       yield
     ensure
-      stop
+      wrapped_stop
     end
 
     def start_safely
-      start
+      wrapped_start
       @_started = true
     end
 
     def stop_safely
-      stop if @_started
+      wrapped_stop if @_started
       @_started = false
     end
 
     def on(sym)
-      # TODO: clean up on stop
-      Nanoc::Int::NotificationCenter.on(sym, self) { |*args| yield(*args) }
+      @_notification_names << sym
+      Nanoc::Core::NotificationCenter.on(sym, self) { |*args| yield(*args) }
     end
   end
 end

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

@@ -7,30 +7,94 @@ module Nanoc::CLI::Commands::CompileListeners
       command_runner.debug?
     end
 
+    COLOR_MAP = {
+      'compilation' => "\e[31m",
+      'content' => "\e[32m",
+      'filtering' => "\e[33m",
+      'dependency_tracking' => "\e[34m",
+      'phase' => "\e[35m",
+      'stage' => "\e[36m",
+    }.freeze
+
     # @see Listener#start
     def start
-      Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
-        puts "*** Started compilation of #{rep.inspect}"
+      on(:compilation_started) do |rep|
+        log('compilation', "Started compilation of #{rep}")
+      end
+
+      on(:compilation_ended) do |rep|
+        log('compilation', "Ended compilation of #{rep}")
+        log('compilation', '')
       end
-      Nanoc::Int::NotificationCenter.on(:compilation_ended) do |rep|
-        puts "*** Ended compilation of #{rep.inspect}"
-        puts
+
+      on(:compilation_suspended) do |rep, target_rep, snapshot_name|
+        log('compilation', "Suspended compilation of #{rep}: depends on #{target_rep}, snapshot #{snapshot_name}")
       end
-      Nanoc::Int::NotificationCenter.on(:compilation_suspended) do |rep, e|
-        puts "*** Suspended compilation of #{rep.inspect}: #{e.message}"
+
+      on(:cached_content_used) do |rep|
+        log('content', "Used cached compiled content for #{rep} instead of recompiling")
       end
-      Nanoc::Int::NotificationCenter.on(:cached_content_used) do |rep|
-        puts "*** Used cached compiled content for #{rep.inspect} instead of recompiling"
+
+      on(:snapshot_created) do |rep, snapshot_name|
+        log('content', "Snapshot #{snapshot_name} created for #{rep}")
       end
-      Nanoc::Int::NotificationCenter.on(:filtering_started) do |rep, filter_name|
-        puts "*** Started filtering #{rep.inspect} with #{filter_name}"
+
+      on(:filtering_started) do |rep, filter_name|
+        log('filtering', "Started filtering #{rep} with #{filter_name}")
       end
-      Nanoc::Int::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
-        puts "*** Ended filtering #{rep.inspect} with #{filter_name}"
+
+      on(:filtering_ended) do |rep, filter_name|
+        log('filtering', "Ended filtering #{rep} with #{filter_name}")
       end
-      Nanoc::Int::NotificationCenter.on(:dependency_created) do |src, dst|
-        puts "*** Dependency created from #{src.inspect} onto #{dst.inspect}"
+
+      on(:dependency_created) do |src, dst|
+        log('dependency_tracking', "Dependency created from #{src.inspect} onto #{dst.inspect}")
+      end
+
+      on(:phase_started) do |phase_name, rep|
+        log('phase', "Phase started: #{phase_name} (rep: #{rep})")
+      end
+
+      on(:phase_yielded) do |phase_name, rep|
+        log('phase', "Phase yielded: #{phase_name} (rep: #{rep})")
+      end
+
+      on(:phase_resumed) do |phase_name, rep|
+        log('phase', "Phase resumed: #{phase_name} (rep: #{rep})")
       end
+
+      on(:phase_ended) do |phase_name, rep|
+        log('phase', "Phase ended: #{phase_name} (rep: #{rep})")
+      end
+
+      on(:phase_aborted) do |phase_name, rep|
+        log('phase', "Phase aborted: #{phase_name} (rep: #{rep})")
+      end
+
+      on(:stage_started) do |stage_name|
+        log('stage', "Stage started: #{stage_name}")
+      end
+
+      on(:stage_ended) do |stage_name|
+        log('stage', "Stage ended: #{stage_name}")
+      end
+
+      on(:stage_aborted) do |stage_name|
+        log('stage', "Stage aborted: #{stage_name}")
+      end
+    end
+
+    def log(progname, msg)
+      logger.info(progname) { msg }
+    end
+
+    def logger
+      @_logger ||=
+        Logger.new($stdout).tap do |l|
+          l.formatter = proc do |_severity, _datetime, progname, msg|
+            "*** #{COLOR_MAP[progname]}#{msg}\e[0m\n"
+          end
+        end
     end
   end
 end

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

@@ -11,10 +11,12 @@ module Nanoc::CLI::Commands::CompileListeners
     def start
       setup_diffs
       old_contents = {}
-      Nanoc::Int::NotificationCenter.on(:rep_write_started, self) do |rep, path|
+
+      on(:rep_write_started) do |rep, path|
         old_contents[rep] = File.file?(path) ? File.read(path) : nil
       end
-      Nanoc::Int::NotificationCenter.on(:rep_write_ended, self) do |rep, binary, path, _is_created, _is_modified|
+
+      on(:rep_write_ended) do |rep, binary, path, _is_created, _is_modified|
         unless binary
           new_contents = File.file?(path) ? File.read(path) : nil
           if old_contents[rep] && new_contents
@@ -27,11 +29,6 @@ module Nanoc::CLI::Commands::CompileListeners
 
     # @see Listener#stop
     def stop
-      super
-
-      Nanoc::Int::NotificationCenter.remove(:rep_write_started, self)
-      Nanoc::Int::NotificationCenter.remove(:rep_write_ended, self)
-
       teardown_diffs
     end
 

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

@@ -3,39 +3,38 @@
 module Nanoc::CLI::Commands::CompileListeners
   class FileActionPrinter < Abstract
     def initialize(reps:)
-      @start_times = {}
-      @acc_durations = {}
-
       @reps = reps
+
+      @stopwatches = {}
     end
 
     # @see Listener#start
     def start
-      Nanoc::Int::NotificationCenter.on(:compilation_started, self) do |rep|
-        @start_times[rep] = Time.now
-        @acc_durations[rep] ||= 0.0
+      on(:compilation_started) do |rep|
+        @stopwatches[rep] ||= DDMetrics::Stopwatch.new
+        @stopwatches[rep].start
       end
 
-      Nanoc::Int::NotificationCenter.on(:compilation_suspended, self) do |rep|
-        @acc_durations[rep] += Time.now - @start_times[rep]
+      on(:compilation_suspended) do |rep|
+        @stopwatches[rep].stop
       end
 
       cached_reps = Set.new
-      Nanoc::Int::NotificationCenter.on(:cached_content_used, self) do |rep|
+      on(:cached_content_used) do |rep|
         cached_reps << rep
       end
 
-      Nanoc::Int::NotificationCenter.on(:rep_write_enqueued, self) do |rep|
-        @acc_durations[rep] += Time.now - @start_times[rep]
+      on(:rep_write_enqueued) do |rep|
+        @stopwatches[rep].stop
       end
 
-      Nanoc::Int::NotificationCenter.on(:rep_write_started, self) do |rep, _raw_path|
-        @start_times[rep] = Time.now
+      on(:rep_write_started) do |rep, _raw_path|
+        @stopwatches[rep].start
       end
 
-      Nanoc::Int::NotificationCenter.on(:rep_write_ended, self) do |rep, _binary, path, is_created, is_modified|
-        @acc_durations[rep] += Time.now - @start_times[rep]
-        duration = @acc_durations[rep]
+      on(:rep_write_ended) do |rep, _binary, path, is_created, is_modified|
+        @stopwatches[rep].stop
+        duration = @stopwatches[rep].duration
 
         action =
           if is_created then :create
@@ -60,14 +59,6 @@ module Nanoc::CLI::Commands::CompileListeners
 
     # @see Listener#stop
     def stop
-      super
-
-      Nanoc::Int::NotificationCenter.remove(:compilation_started, self)
-      Nanoc::Int::NotificationCenter.remove(:compilation_suspended, self)
-      Nanoc::Int::NotificationCenter.remove(:rep_write_enqueued, self)
-      Nanoc::Int::NotificationCenter.remove(:rep_write_started, self)
-      Nanoc::Int::NotificationCenter.remove(:rep_write_ended, self)
-
       @reps.reject(&:compiled?).each do |rep|
         raw_paths = rep.raw_paths.values.flatten.uniq
         raw_paths.each do |raw_path|