nanoc-core 4.11.14 → 4.11.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0567f73c8232ed3fb519dac300d399b81c0a02caae7a9d7e5df4702805a3e1a0
-  data.tar.gz: 69d8c9cf02cd3130b6e9488883d0da8d6a25708fc2d8ba77e6d4c3885f1c570d
+  metadata.gz: a5609a4d82cab318b327443ab017ec28ace7a23f0766176df6e289c7c757138e
+  data.tar.gz: 4646c4338db2b0fe0a46b0b604205796c154d51c7f5f77c5b59d2031fd806877
 SHA512:
-  metadata.gz: 3fb04e132747a9a18e8e00399bbe9739d41b7c1a14fd2096103ad212d65016965b07a8933151ea2312a7d35236efd752b03c15017af003777327796d8dd196a3
-  data.tar.gz: 2ce3598e084831f3f345ba5575a63abbae69b422ed2872461f966c53fa6e3bf43a040b9ed5fb44475afa55d9c183dd48f27a352dc1ff8071e6eb35cb147f963d
+  metadata.gz: d387e1b5fbd4ed31ac03f6eb0510238f4e8e92a615b1c38351fa2e7c1f785e7f2d9ac013c51c48a1f0f6e32a02c8b49d20f9a48e324ed07bc45c054246cdda62
+  data.tar.gz: 6789e6da893cb64eb032c110f244de514c56143df96c8865b2a2903ffcbbbb2a242c60ee46eca40fb3bb1e77e11c1febdc7ebbe675d428ce9e41e419f5683f0d

data/lib/nanoc/core.rb

@@ -9,6 +9,7 @@ require 'tmpdir'
 require 'yaml'
 
 # External gems
+require 'concurrent-ruby'
 require 'json_schema'
 require 'ddmemoize'
 require 'ddmetrics'

data/lib/nanoc/core/changes_stream.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ChangesStream
+      class ChangesListener
+        def initialize(y)
+          @y = y
+        end
+
+        def unknown
+          @y << :unknown
+        end
+
+        def lib
+          @y << :lib
+        end
+
+        def to_stop(&block)
+          if block_given?
+            @to_stop = block
+          else
+            @to_stop
+          end
+        end
+      end
+
+      def initialize(enum: nil)
+        @enum = enum
+        @enum ||=
+          Enumerator.new do |y|
+            @listener = ChangesListener.new(y)
+            yield(@listener)
+          end.lazy
+      end
+
+      def stop
+        @listener&.to_stop&.call
+      end
+
+      def map
+        self.class.new(enum: @enum.map { |e| yield(e) })
+      end
+
+      def to_enum
+        @enum
+      end
+
+      def each
+        @enum.each { |e| yield(e) }
+        nil
+      end
+    end
+  end
+end

data/lib/nanoc/core/checksum_store.rb

@@ -64,7 +64,7 @@ module Nanoc
 
         @checksums = {}
         new_data.each_pair do |key, checksum|
-          if references.include?(key) || references.include?(key.first)
+          if references.include?(key) || (key.respond_to?(:first) && references.include?(key.first))
             @checksums[key] = checksum
           end
         end

data/lib/nanoc/core/checksummer.rb

@@ -50,8 +50,8 @@ module Nanoc
         end
 
         def calc_for_each_attribute_of(obj, digest_class = CompactDigest)
-          obj.attributes.each_with_object({}) do |(key, value), memo|
-            memo[key] = Nanoc::Core::Checksummer.calc(value, digest_class)
+          obj.attributes.transform_values do |value|
+            Nanoc::Core::Checksummer.calc(value, digest_class)
           end
         end
 

data/lib/nanoc/core/compilation_item_rep_view.rb

@@ -3,6 +3,12 @@
 module Nanoc
   module Core
     class CompilationItemRepView < ::Nanoc::Core::BasicItemRepView
+      # How long to wait before the requested file appears.
+      #
+      # This is a bit of a hack -- ideally, Nanoc would know that the file is
+      # being generated, and wait the appropriate amount of time.
+      FILE_APPEAR_TIMEOUT = 10.0
+
       # @abstract
       def item_view_class
         Nanoc::Core::CompilationItemView
@@ -27,7 +33,7 @@ module Nanoc
         # Wait for file to exist
         if res
           start = Time.now
-          sleep 0.05 until File.file?(res) || Time.now - start > 1.0
+          sleep 0.05 until File.file?(res) || Time.now - start > FILE_APPEAR_TIMEOUT
           raise Nanoc::Core::Errors::InternalInconsistency, "File did not apear in time: #{res}" unless File.file?(res)
         end
 

data/lib/nanoc/core/compilation_phases/abstract.rb

@@ -32,7 +32,7 @@ module Nanoc
         end
 
         contract Nanoc::Core::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
-        def run(_rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
+        def run(_rep, is_outdated:)
           raise NotImplementedError
         end
 

data/lib/nanoc/core/compilation_phases/resume.rb

@@ -21,7 +21,7 @@ module Nanoc
               raise(res)
             when Proc
               fiber.resume(res.call)
-            when DONE # rubocop:disable Lint/EmptyWhen
+            when DONE
               # ignore
             else
               raise Nanoc::Core::Errors::InternalInconsistency.new(

data/lib/nanoc/core/compilation_phases/write.rb

@@ -6,45 +6,6 @@ module Nanoc
       class Write < Abstract
         include Nanoc::Core::ContractsSupport
 
-        class Worker
-          def initialize(queue:, compiled_content_store:)
-            @queue = queue
-            @compiled_content_store = compiled_content_store
-          end
-
-          def start
-            @thread = Thread.new do
-              Thread.current.abort_on_exception = true
-              Thread.current.priority = -1 # schedule I/O work ASAP
-
-              writer = Nanoc::Core::ItemRepWriter.new
-
-              while rep = @queue.pop # rubocop:disable Lint/AssignmentInCondition
-                writer.write_all(rep, @compiled_content_store)
-              end
-            end
-          end
-
-          def join
-            @thread.join
-          end
-        end
-
-        class WorkerPool
-          def initialize(queue:, size:, compiled_content_store:)
-            @workers = Array.new(size) { Worker.new(queue: queue, compiled_content_store: compiled_content_store) }
-          end
-
-          def start
-            @workers.each(&:start)
-          end
-
-          def join
-            @workers.each(&:join)
-          end
-        end
-
-        QUEUE_SIZE = 40
         WORKER_POOL_SIZE = 5
 
         def initialize(compiled_content_store:, wrapped:)
@@ -52,19 +13,16 @@ module Nanoc
 
           @compiled_content_store = compiled_content_store
 
-          @queue = SizedQueue.new(QUEUE_SIZE)
-          @worker_pool = WorkerPool.new(queue: @queue, size: WORKER_POOL_SIZE, compiled_content_store: @compiled_content_store)
-        end
+          @pool = Concurrent::FixedThreadPool.new(WORKER_POOL_SIZE)
 
-        def start
-          super
-          @worker_pool.start
+          @writer = Nanoc::Core::ItemRepWriter.new
         end
 
         def stop
+          @pool.shutdown
+          @pool.wait_for_termination
+
           super
-          @queue.close
-          @worker_pool.join
         end
 
         contract Nanoc::Core::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
@@ -76,7 +34,9 @@ module Nanoc
           # notification happens before the :rep_write_enqueued one.
           Nanoc::Core::NotificationCenter.post(:rep_write_enqueued, rep)
 
-          @queue << rep
+          @pool.post do
+            @writer.write_all(rep, @compiled_content_store)
+          end
         end
       end
     end

data/lib/nanoc/core/compiled_content_cache.rb

@@ -46,8 +46,8 @@ module Nanoc
         @binary_cache[rep] = content.select { |_key, c| c.binary? }
       end
 
-      def prune(*args)
-        @wrapped_caches.each { |w| w.prune(*args) }
+      def prune(items:)
+        @wrapped_caches.each { |w| w.prune(items: items) }
       end
 
       # True if there is cached compiled content available for this item, and

data/lib/nanoc/core/compiler_loader.rb

@@ -32,7 +32,7 @@ module Nanoc
           outdatedness_store: outdatedness_store,
         }
 
-        Nanoc::Core::Compiler.new(site, params)
+        Nanoc::Core::Compiler.new(site, **params)
       end
 
       def compiled_content_cache_class

data/lib/nanoc/core/contracts_support.rb

@@ -103,6 +103,8 @@ module Nanoc
           ::Contracts.const_set('Named', EnabledContracts::Named)
           ::Contracts.const_set('IterOf', EnabledContracts::IterOf)
           ::Contracts.const_set('AbsolutePathString', EnabledContracts::AbsolutePathString)
+
+          warn_about_performance
         end
 
         @_contracts_support__should_enable
@@ -126,6 +128,24 @@ module Nanoc
           base.const_set('C', DisabledContracts)
         end
       end
+
+      def self.warn_about_performance
+        return if ENV.key?('CI')
+        return if ENV.key?('NANOC_DEV_MODE')
+
+        puts '-' * 78
+        puts 'A NOTE ABOUT PERFORMANCE:'
+        puts 'The `contracts` gem is loaded, which enables extra run-time checks, but can drastically reduce Nanoc’s performance. The `contracts` gem is intended for development purposes, and is not recommended for day-to-day Nanoc usage.'
+        puts
+
+        if defined?(Bundler)
+          puts 'To speed up compilation, remove `contracts` from the Gemfile and run `bundle install`.'
+        else
+          puts 'To speed up compilation, either uninstall the `contracts` gem, or use Bundler (https://bundler.io/) with a Gemfile that doesn’t include `contracts`.'
+        end
+
+        puts '-' * 78
+      end
     end
   end
 end

data/lib/nanoc/core/dependency_store.rb

@@ -113,7 +113,7 @@ module Nanoc
         src_ref = obj2ref(src)
         dst_ref = obj2ref(dst)
 
-        existing_props = Nanoc::Core::DependencyProps.new(@graph.props_for(dst_ref, src_ref) || {})
+        existing_props = Nanoc::Core::DependencyProps.new(**(@graph.props_for(dst_ref, src_ref) || {}))
         new_props = Nanoc::Core::DependencyProps.new(raw_content: raw_content, attributes: attributes, compiled_content: compiled_content, path: path)
         props = existing_props.merge(new_props)
 

data/lib/nanoc/core/errors.rb

@@ -88,6 +88,17 @@ module Nanoc
         end
       end
 
+      # Error that is raised during site compilation when a layout is compiled
+      # for which the filter cannot be determined. This is similar to the
+      # {UnknownFilter} error, but specific for filters for layouts.
+      class CannotDetermineFilter < ::Nanoc::Core::Error
+        # @param [String] layout_identifier The identifier of the layout for
+        #   which the filter could not be determined
+        def initialize(layout_identifier)
+          super("The filter to be used for the “#{layout_identifier}” layout could not be determined. Make sure the layout does have a filter.")
+        end
+      end
+
       # Error that is raised when the compiled content of a binary item is attempted to be accessed.
       class CannotGetCompiledContentOfBinaryItem < ::Nanoc::Core::Error
         # @param [Nanoc::Core::ItemRep] rep The binary item representation whose compiled content was attempted to be accessed

data/lib/nanoc/core/executor.rb

@@ -39,7 +39,7 @@ module Nanoc
         filter_name_and_args = @compilation_context.filter_name_and_args_for_layout(layout)
         filter_name = filter_name_and_args.name
         if filter_name.nil?
-          raise ::Nanoc::Core::Error, "Cannot find rule for layout matching #{layout_identifier}"
+          raise Nanoc::Core::Errors::CannotDetermineFilter.new(layout_identifier)
         end
 
         filter_args = filter_name_and_args.args

data/lib/nanoc/core/pruner.rb

@@ -111,8 +111,12 @@ module Nanoc
       end
 
       def log_delete_and_run(thing)
-        Nanoc::Core::NotificationCenter.post(:file_pruned, thing)
-        yield unless @dry_run
+        if @dry_run
+          Nanoc::Core::NotificationCenter.post(:file_listed_for_pruning, thing)
+        else
+          Nanoc::Core::NotificationCenter.post(:file_pruned, thing)
+          yield
+        end
       end
     end
   end

data/lib/nanoc/core/temp_filename_factory.rb

@@ -14,6 +14,7 @@ module Nanoc
       def initialize
         @counts = {}
         @root_dir = Dir.mktmpdir('nanoc')
+        @mutex = Mutex.new
       end
 
       # @param [String] prefix A string prefix to include in the temporary
@@ -21,8 +22,11 @@ module Nanoc
       #
       # @return [String] A new unused filename
       def create(prefix)
-        count = @counts.fetch(prefix, 0)
-        @counts[prefix] = count + 1
+        count = nil
+        @mutex.synchronize do
+          count = @counts.fetch(prefix, 0)
+          @counts[prefix] = count + 1
+        end
 
         dirname  = File.join(@root_dir, prefix)
         filename = File.join(@root_dir, prefix, count.to_s)

data/lib/nanoc/core/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Core
-    VERSION = '4.11.14'
+    VERSION = '4.11.19'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-core
 version: !ruby/object:Gem::Version
-  version: 4.11.14
+  version: 4.11.19
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: ddmemoize
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +171,7 @@ files:
 - lib/nanoc/core/basic_item_view.rb
 - lib/nanoc/core/binary_compiled_content_cache.rb
 - lib/nanoc/core/binary_content.rb
+- lib/nanoc/core/changes_stream.rb
 - lib/nanoc/core/checksum_collection.rb
 - lib/nanoc/core/checksum_store.rb
 - lib/nanoc/core/checksummer.rb
@@ -299,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Core of Nanoc