nanoc 4.4.5 → 4.4.6

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

@@ -2,17 +2,6 @@ usage 'compile [options]'
 summary 'compile items of this site'
 description <<-EOS
 Compile all items of the current site.
-
-The compile command will show all items of the site as they are processed. The time spent compiling the item will be printed, as well as a status message, which can be one of the following:
-
-CREATED - The compiled item did not yet exist and has been created
-
-UPDATED - The compiled item did already exist and has been modified
-
-IDENTICAL - The item was deemed outdated and has been recompiled, but the compiled version turned out to be identical to the already existing version
-
-SKIP - The item was deemed not outdated and was therefore not recompiled
-
 EOS
 flag nil, :profile, 'profile compilation' if Nanoc::Feature.enabled?(Nanoc::Feature::PROFILER)
 
@@ -328,16 +317,16 @@ module Nanoc::CLI::Commands
 
       # @see Listener#start
       def start
-        Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
+        Nanoc::Int::NotificationCenter.on(:compilation_started, self) do |rep|
           @start_times[rep] = Time.now
           @acc_durations[rep] ||= 0.0
         end
 
-        Nanoc::Int::NotificationCenter.on(:compilation_suspended) do |rep|
+        Nanoc::Int::NotificationCenter.on(:compilation_suspended, self) do |rep|
           @acc_durations[rep] += Time.now - @start_times[rep]
         end
 
-        Nanoc::Int::NotificationCenter.on(:rep_written) do |rep, path, is_created, is_modified|
+        Nanoc::Int::NotificationCenter.on(:rep_written, self) do |rep, path, is_created, is_modified|
           @acc_durations[rep] += Time.now - @start_times[rep]
           duration = @acc_durations[rep]
 
@@ -358,6 +347,11 @@ module Nanoc::CLI::Commands
       # @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_written, self)
+
         @reps.select { |r| !r.compiled? }.each do |rep|
           rep.raw_paths.each do |_snapshot_name, raw_path|
             log(:low, :skip, raw_path, nil)

data/lib/nanoc/extra/parallel_collection.rb

@@ -0,0 +1,57 @@
+require 'thread'
+
+module Nanoc::Extra
+  # @api private
+  class ParallelCollection
+    STOP = Object.new
+
+    include Nanoc::Int::ContractsSupport
+
+    contract C::RespondTo[:each], C::KeywordArgs[parallelism: Fixnum] => C::Any
+    def initialize(enum, parallelism: 2)
+      @enum = enum
+      @parallelism = parallelism
+    end
+
+    contract C::Func[C::Any => C::Any] => self
+    def each
+      queue = SizedQueue.new(2 * @parallelism)
+      error = nil
+
+      threads = (1..@parallelism).map do
+        Thread.new do
+          loop do
+            begin
+              elem = queue.pop
+              break if error
+              break if STOP.equal?(elem)
+              yield elem
+            rescue => err
+              error = err
+              break
+            end
+          end
+        end
+      end
+
+      @enum.each { |e| queue << e }
+      @parallelism.times { queue << STOP }
+
+      threads.each(&:join)
+
+      raise error if error
+      self
+    end
+
+    contract C::Func[C::Any => C::Any] => C::RespondTo[:each]
+    def map
+      [].tap do |all|
+        mutex = Mutex.new
+        each do |e|
+          res = yield(e)
+          mutex.synchronize { all << res }
+        end
+      end
+    end
+  end
+end

data/lib/nanoc/extra.rb

@@ -18,3 +18,4 @@ module Nanoc::Extra
 end
 
 require 'nanoc/extra/core_ext'
+require 'nanoc/extra/parallel_collection'

data/lib/nanoc/filters/mustache.rb

@@ -11,7 +11,7 @@ module Nanoc::Filters
     #
     # @return [String] The filtered content
     def run(content, _params = {})
-      context = item.attributes.merge({ yield: assigns[:content] })
+      context = item.attributes.merge(yield: assigns[:content])
       ::Mustache.render(content, context)
     end
   end

data/lib/nanoc/rule_dsl/recording_executor.rb

@@ -3,20 +3,8 @@ module Nanoc
     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.")
-        end
-      end
-
-      attr_reader :rule_memory
-
-      def initialize(item_rep, rules_collection, site)
-        @item_rep = item_rep
-        @rules_collection = rules_collection
-        @site = site
-
-        @rule_memory = Nanoc::Int::RuleMemory.new(item_rep)
+      def initialize(rule_memory)
+        @rule_memory = rule_memory
       end
 
       def filter(filter_name, filter_args = {})
@@ -29,34 +17,18 @@ module Nanoc
         end
 
         unless @rule_memory.any_layouts?
-          @rule_memory.add_snapshot(:pre, true, nil)
+          @rule_memory.add_snapshot(:pre, nil)
         end
 
         @rule_memory.add_layout(layout_identifier, extra_filter_args)
       end
 
       Pathlike = C::Maybe[C::Or[String, Nanoc::Identifier]]
-      contract Symbol, C::KeywordArgs[path: C::Optional[Pathlike], final: C::Optional[C::Bool]] => nil
-      def snapshot(snapshot_name, final: true, path: nil)
-        pathlike = final ? (path || basic_path_from_rules_for(@item_rep, snapshot_name)) : nil
-        actual_path = pathlike && pathlike.to_s
-        @rule_memory.add_snapshot(snapshot_name, final, actual_path)
+      contract Symbol, C::KeywordArgs[path: C::Optional[Pathlike]] => nil
+      def snapshot(snapshot_name, path: nil)
+        @rule_memory.add_snapshot(snapshot_name, path && path.to_s)
         nil
       end
-
-      def basic_path_from_rules_for(rep, snapshot_name)
-        routing_rules = @rules_collection.routing_rules_for(rep)
-        routing_rule = routing_rules[snapshot_name]
-        return nil if routing_rule.nil?
-
-        dependency_tracker = Nanoc::Int::DependencyTracker::Null.new
-        view_context = Nanoc::ViewContext.new(reps: nil, items: nil, dependency_tracker: dependency_tracker, compilation_context: nil)
-        basic_path = routing_rule.apply_to(rep, executor: nil, site: @site, view_context: view_context)
-        if basic_path && !basic_path.start_with?('/')
-          raise PathWithoutInitialSlashError.new(rep, basic_path)
-        end
-        basic_path
-      end
     end
   end
 end

data/lib/nanoc/rule_dsl/rule_memory_calculator.rb

@@ -24,6 +24,12 @@ module Nanoc::RuleDSL
       end
     end
 
+    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.")
+      end
+    end
+
     # @api private
     attr_accessor :rules_collection
 
@@ -48,15 +54,9 @@ module Nanoc::RuleDSL
       end
     end
 
-    # @param [Nanoc::Int::ItemRep] rep The item representation for which to fetch
-    #   the list of snapshots
-    #
-    # @return [Array] A list of snapshots, represented as arrays where the
-    #   first element is the snapshot name (a Symbol) and the last element is
-    #   a Boolean indicating whether the snapshot is final or not
     def snapshots_defs_for(rep)
       self[rep].snapshot_actions.map do |a|
-        Nanoc::Int::SnapshotDef.new(a.snapshot_name, a.final?)
+        Nanoc::Int::SnapshotDef.new(a.snapshot_name)
       end
     end
 
@@ -68,7 +68,8 @@ module Nanoc::RuleDSL
       dependency_tracker = Nanoc::Int::DependencyTracker::Null.new
       view_context = @site.compiler.compilation_context.create_view_context(dependency_tracker)
 
-      executor = Nanoc::RuleDSL::RecordingExecutor.new(rep, @rules_collection, @site)
+      rule_memory = Nanoc::Int::RuleMemory.new(rep)
+      executor = Nanoc::RuleDSL::RecordingExecutor.new(rule_memory)
       rule = @rules_collection.compilation_rule_for(rep)
 
       unless rule
@@ -76,16 +77,15 @@ module Nanoc::RuleDSL
       end
 
       executor.snapshot(:raw)
-      executor.snapshot(:pre, final: false)
       rule.apply_to(rep, executor: executor, site: @site, view_context: view_context)
-      if executor.rule_memory.any_layouts?
+      if rule_memory.any_layouts?
         executor.snapshot(:post)
       end
-      unless executor.rule_memory.snapshot_actions.any? { |sa| sa.snapshot_name == :last }
+      unless rule_memory.snapshot_actions.any? { |sa| sa.snapshot_name == :last }
         executor.snapshot(:last)
       end
 
-      executor.rule_memory
+      assign_paths_to_mem(rule_memory, rep: rep)
     end
 
     # @param [Nanoc::Int::Layout] layout
@@ -102,5 +102,35 @@ module Nanoc::RuleDSL
         rm.add_filter(res[0], res[1])
       end
     end
+
+    def assign_paths_to_mem(mem, rep:)
+      mem.map do |action|
+        if action.is_a?(Nanoc::Int::ProcessingActions::Snapshot) && action.path.nil?
+          path_from_rules = basic_path_from_rules_for(rep, action.snapshot_name)
+          if path_from_rules
+            action.copy(path: path_from_rules.to_s)
+          else
+            action
+          end
+        else
+          action
+        end
+      end
+    end
+
+    # FIXME: ugly
+    def basic_path_from_rules_for(rep, snapshot_name)
+      routing_rules = @rules_collection.routing_rules_for(rep)
+      routing_rule = routing_rules[snapshot_name]
+      return nil if routing_rule.nil?
+
+      dependency_tracker = Nanoc::Int::DependencyTracker::Null.new
+      view_context = Nanoc::ViewContext.new(reps: nil, items: nil, dependency_tracker: dependency_tracker, compilation_context: nil)
+      basic_path = routing_rule.apply_to(rep, executor: nil, site: @site, view_context: view_context)
+      if basic_path && !basic_path.start_with?('/')
+        raise PathWithoutInitialSlashError.new(rep, basic_path)
+      end
+      basic_path
+    end
   end
 end

data/lib/nanoc/spec.rb

@@ -141,7 +141,7 @@ module Nanoc
           end
 
           def snapshots_defs_for(_rep)
-            [Nanoc::Int::SnapshotDef.new(:last, false)]
+            [Nanoc::Int::SnapshotDef.new(:last)]
           end
         end.new(self)
       end

data/lib/nanoc/version.rb

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

data/nanoc.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.files =
     Dir['[A-Z]*'] +
     Dir['doc/yardoc_{templates,handlers}/**/*'] +
-    Dir['{bin,lib,tasks,test}/**/*'] +
+    Dir['{bin,lib,tasks,test,spec}/**/*'] +
     ['nanoc.gemspec']
   s.executables        = ['nanoc']
   s.require_paths      = ['lib']
@@ -27,7 +27,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('cri', '~> 2.3')
   s.add_runtime_dependency('hamster', '~> 3.0')
   s.add_runtime_dependency('ref', '~> 2.0')
-  s.add_runtime_dependency('parallel', '~> 1.9')
 
   s.add_development_dependency('bundler', '>= 1.7.10', '< 2.0')
   s.add_development_dependency('appraisal', '~> 2.1')

data/spec/contributors_spec.rb

@@ -0,0 +1,18 @@
+describe 'list of contributors in README', chdir: false do
+  let(:contributors_in_readme) do
+    File.readlines('README.md').last.chomp("\n").split(', ')
+  end
+
+  let(:contributors_in_release_notes) do
+    File.read('NEWS.md').scan(/\[[^\]]+\]$/).map { |s| s[1..-2].split(', ') }.flatten
+  end
+
+  it 'should include everyone mentioned in NEWS.md' do
+    diff = (contributors_in_release_notes - contributors_in_readme).uniq.sort
+    expect(diff).to be_empty, "some contributors are missing from the README: #{diff.join(', ')}"
+  end
+
+  it 'should be sorted' do
+    expect(contributors_in_readme).to be_humanly_sorted
+  end
+end