nanoc-core 4.14.6 → 4.14.8

data/lib/nanoc/core/compilation_stages/compile_reps.rb

@@ -7,7 +7,12 @@ module Nanoc
         include Nanoc::Core::ContractsSupport
         include Nanoc::Core::Assertions::Mixin
 
-        def initialize(reps:, outdatedness_store:, dependency_store:, action_sequences:, compilation_context:, compiled_content_cache:, focus:)
+        def initialize(
+          reps:, outdatedness_store:, dependency_store:, action_sequences:,
+          compilation_context:, compiled_content_cache:, focus:
+        )
+          super()
+
           @reps = reps
           @outdatedness_store = outdatedness_store
           @dependency_store = dependency_store
@@ -15,13 +20,18 @@ module Nanoc
           @compilation_context = compilation_context
           @compiled_content_cache = compiled_content_cache
           @focus = focus
+
+          @compiled_content_repo = @compilation_context.compiled_content_repo
+
+          @writer = Nanoc::Core::ItemRepWriter.new
         end
 
         def run
           outdated_reps = @reps.select { |r| @outdatedness_store.include?(r) }
 
           # If a focus is specified, only compile reps that match this focus.
-          # (If no focus is specified, `@focus` will be `nil`, not an empty array.)
+          # (If no focus is specified, `@focus` will be `nil`, not an empty
+          # array.)
           if @focus
             focus_patterns = @focus.map { |f| Nanoc::Core::Pattern.from(f) }
 
@@ -39,11 +49,9 @@ module Nanoc
             dependency_store: @dependency_store,
           )
 
-          run_phase_stack do |phase_stack|
-            selector.each do |rep|
-              handle_errors_while(rep) do
-                compile_rep(rep, phase_stack:, is_outdated: @outdatedness_store.include?(rep))
-              end
+          selector.each do |rep|
+            handle_errors_while(rep) do
+              compile_rep(rep, outdated_reps:)
             end
           end
 
@@ -67,44 +75,78 @@ module Nanoc
           raise Nanoc::Core::Errors::CompilationError.new(e, item_rep)
         end
 
-        def compile_rep(rep, phase_stack:, is_outdated:)
-          phase_stack.call(rep, is_outdated:)
-        end
+        def compile_rep(rep, outdated_reps:)
+          Nanoc::Core::NotificationCenter.post(:compilation_started, rep)
 
-        def run_phase_stack
-          phase_stack = build_phase_stack
-          phase_stack.start
-          yield(phase_stack)
-        ensure
-          phase_stack.stop
+          outdated = outdated_reps.include?(rep)
+          if !outdated && @compiled_content_cache.full_cache_available?(rep)
+            Nanoc::Core::NotificationCenter.post(:cached_content_used, rep)
+            @compiled_content_repo.set_all(rep, @compiled_content_cache[rep])
+            rep.compiled = true
+          end
+
+          unless rep.compiled?
+            recalculate_rep(rep)
+            @compiled_content_cache[rep] = @compiled_content_repo.get_all(rep)
+            rep.compiled = true
+          end
+
+          if outdated
+            # Caution: Notification must be posted before enqueueing the rep,
+            # or we risk a race condition where the :rep_write_ended
+            # notification happens before the :rep_write_enqueued one.
+            Nanoc::Core::NotificationCenter.post(:rep_write_enqueued, rep)
+            @writer.write_all(rep, @compiled_content_repo)
+          end
+
+          @outdatedness_store.remove(rep)
+
+          Nanoc::Core::NotificationCenter.post(:compilation_ended, rep)
+        rescue Nanoc::Core::Errors::UnmetDependency
+          Nanoc::Core::NotificationCenter.post(:compilation_suspended, rep)
+          raise
         end
 
-        def build_phase_stack
-          recalculate_phase = Nanoc::Core::CompilationPhases::Recalculate.new(
-            action_sequences: @action_sequences,
-            dependency_store: @dependency_store,
-            compilation_context: @compilation_context,
+        def recalculate_rep(rep)
+          dependency_tracker = Nanoc::Core::DependencyTracker.new(
+            @dependency_store, root: rep.item
           )
 
-          cache_phase = Nanoc::Core::CompilationPhases::Cache.new(
-            compiled_content_cache: @compiled_content_cache,
-            compiled_content_repo: @compilation_context.compiled_content_repo,
-            wrapped: recalculate_phase,
+          executor = Nanoc::Core::Executor.new(
+            rep, @compilation_context, dependency_tracker
           )
 
-          write_phase = Nanoc::Core::CompilationPhases::Write.new(
-            compiled_content_repo: @compilation_context.compiled_content_repo,
-            wrapped: cache_phase,
-          )
+          # Set initial content, if not already present
+          compiled_content_repo = @compilation_context.compiled_content_repo
+          unless compiled_content_repo.get_current(rep)
+            compiled_content_repo.set_current(rep, rep.item.content)
+          end
 
-          mark_done_phase = Nanoc::Core::CompilationPhases::MarkDone.new(
-            wrapped: write_phase,
-            outdatedness_store: @outdatedness_store,
-          )
+          actions = pending_action_sequence_for(rep:)
+          until actions.empty?
+            action = actions.first
+
+            case action
+            when Nanoc::Core::ProcessingActions::Filter
+              executor.filter(action.filter_name, action.params)
+            when Nanoc::Core::ProcessingActions::Layout
+              executor.layout(action.layout_identifier, action.params)
+            when Nanoc::Core::ProcessingActions::Snapshot
+              action.snapshot_names.each do |snapshot_name|
+                executor.snapshot(snapshot_name)
+              end
+            else
+              raise Nanoc::Core::Errors::InternalInconsistency,
+                    "unknown action #{action.inspect}"
+            end
 
-          Nanoc::Core::CompilationPhases::Notify.new(
-            wrapped: mark_done_phase,
-          )
+            actions.shift
+          end
+        end
+
+        def pending_action_sequence_for(rep:)
+          @_pending_action_sequences ||= {}
+          @_pending_action_sequences[rep] ||= @action_sequences[rep].to_a
         end
       end
     end

data/lib/nanoc/core/compilation_stages/determine_outdatedness.rb

@@ -7,6 +7,8 @@ module Nanoc
         include Nanoc::Core::ContractsSupport
 
         def initialize(reps:, outdatedness_checker:, outdatedness_store:)
+          super()
+
           @reps = reps
           @outdatedness_checker = outdatedness_checker
           @outdatedness_store = outdatedness_store

data/lib/nanoc/core/compilation_stages/forget_outdated_dependencies.rb

@@ -7,12 +7,16 @@ module Nanoc
         include Nanoc::Core::ContractsSupport
 
         def initialize(dependency_store:)
+          super()
+
           @dependency_store = dependency_store
         end
 
         contract C::IterOf[Nanoc::Core::Item] => C::Any
         def run(outdated_items)
-          outdated_items.each { |i| @dependency_store.forget_dependencies_for(i) }
+          outdated_items.each do |i|
+            @dependency_store.forget_dependencies_for(i)
+          end
         end
       end
     end

data/lib/nanoc/core/compilation_stages/load_stores.rb

@@ -6,7 +6,12 @@ module Nanoc
       class LoadStores < Nanoc::Core::CompilationStage
         include Nanoc::Core::ContractsSupport
 
-        def initialize(checksum_store:, compiled_content_cache:, dependency_store:, action_sequence_store:, outdatedness_store:)
+        def initialize(
+          checksum_store:, compiled_content_cache:, dependency_store:,
+          action_sequence_store:, outdatedness_store:
+        )
+          super()
+
           @checksum_store = checksum_store
           @compiled_content_cache = compiled_content_cache
           @dependency_store = dependency_store

data/lib/nanoc/core/compilation_stages/postprocess.rb

@@ -7,6 +7,8 @@ module Nanoc
         include Nanoc::Core::ContractsSupport
 
         def initialize(action_provider:, site:)
+          super()
+
           @action_provider = action_provider
           @site = site
         end

data/lib/nanoc/core/compilation_stages/preprocess.rb

@@ -4,7 +4,10 @@ module Nanoc
   module Core
     module CompilationStages
       class Preprocess < Nanoc::Core::CompilationStage
-        def initialize(action_provider:, site:, dependency_store:, checksum_store:)
+        def initialize(action_provider:, site:, dependency_store:,
+                       checksum_store:)
+          super()
+
           @action_provider = action_provider
           @site = site
           @dependency_store = dependency_store
@@ -15,12 +18,18 @@ module Nanoc
           return if @site.preprocessed?
 
           if @action_provider.need_preprocessing?
-            @site.data_source = Nanoc::Core::InMemoryDataSource.new(@site.items, @site.layouts, @site.data_source)
+            @site.data_source = Nanoc::Core::InMemoryDataSource.new(
+              @site.items, @site.layouts, @site.data_source
+            )
             @action_provider.preprocess(@site)
 
             @dependency_store.items = @site.items
             @dependency_store.layouts = @site.layouts
-            @checksum_store.objects = @site.items.to_a + @site.layouts.to_a + @site.code_snippets + [@site.config]
+            @checksum_store.objects =
+              @site.items.to_a +
+              @site.layouts.to_a +
+              @site.code_snippets +
+              [@site.config]
           end
 
           @site.mark_as_preprocessed

data/lib/nanoc/core/compilation_stages/prune.rb

@@ -5,13 +5,18 @@ module Nanoc
     module CompilationStages
       class Prune < Nanoc::Core::CompilationStage
         def initialize(config:, reps:)
+          super()
+
           @config = config
           @reps = reps
         end
 
         def run
           if @config[:prune][:auto_prune]
-            Nanoc::Core::Pruner.new(@config, @reps, exclude: prune_config_exclude).run
+            Nanoc::Core::Pruner.new(
+              @config, @reps,
+              exclude: prune_config_exclude
+            ).run
           end
         end
 

data/lib/nanoc/core/compilation_stages/store_post_compilation_state.rb

@@ -7,6 +7,8 @@ module Nanoc
         include Nanoc::Core::ContractsSupport
 
         def initialize(dependency_store:)
+          super()
+
           @dependency_store = dependency_store
         end
 

data/lib/nanoc/core/compilation_stages/store_pre_compilation_state.rb

@@ -6,7 +6,12 @@ module Nanoc
       class StorePreCompilationState < Nanoc::Core::CompilationStage
         include Nanoc::Core::ContractsSupport
 
-        def initialize(reps:, layouts:, checksum_store:, action_sequence_store:, action_sequences:)
+        def initialize(
+          reps:, layouts:, checksum_store:,
+          action_sequence_store:, action_sequences:
+        )
+          super()
+
           @reps = reps
           @layouts = layouts
           @checksum_store = checksum_store

data/lib/nanoc/core/compiled_content_cache.rb

@@ -6,7 +6,7 @@ module Nanoc
     # to prevent it from being needlessly recompiled.
     #
     # @api private
-    class CompiledContentCache < ::Nanoc::Core::Store
+    class CompiledContentCache
       include Nanoc::Core::ContractsSupport
 
       contract C::KeywordArgs[config: Nanoc::Core::Configuration] => C::Any
@@ -36,7 +36,12 @@ module Nanoc
         textual_content_map.merge(binary_content_map)
       end
 
-      contract Nanoc::Core::ItemRep, C::HashOf[Symbol => Nanoc::Core::Content] => C::Any
+      def include?(rep)
+        @textual_cache.include?(rep) || @binary_cache.include?(rep)
+      end
+
+      contract Nanoc::Core::ItemRep,
+               C::HashOf[Symbol => Nanoc::Core::Content] => C::Any
       # Sets the compiled content for the given representation.
       #
       # This cached compiled content is a hash where the keys are the snapshot

data/lib/nanoc/core/compiled_content_repo.rb

@@ -36,19 +36,24 @@ module Nanoc
         @contents[rep]
       end
 
-      contract Nanoc::Core::ItemRep, C::HashOf[Symbol => Nanoc::Core::Content] => C::Any
+      contract Nanoc::Core::ItemRep,
+               C::HashOf[Symbol => Nanoc::Core::Content] =>
+               C::Any
       def set_all(rep, contents_per_snapshot)
         @contents[rep] = contents_per_snapshot
       end
 
-      contract C::KeywordArgs[rep: Nanoc::Core::ItemRep, snapshot: C::Optional[C::Maybe[Symbol]]] => Nanoc::Core::Content
+      contract C::KeywordArgs[
+        rep: Nanoc::Core::ItemRep,
+        snapshot: C::Optional[C::Maybe[Symbol]]] => Nanoc::Core::Content
       def raw_compiled_content(rep:, snapshot: nil)
         # Get name of last pre-layout snapshot
         has_pre = rep.snapshot_defs.any? { |sd| sd.name == :pre }
         snapshot_name = snapshot || (has_pre ? :pre : :last)
 
         # Check existance of snapshot
-        snapshot_def = rep.snapshot_defs.reverse.find { |sd| sd.name == snapshot_name }
+        snapshot_def =
+          rep.snapshot_defs.reverse.find { |sd| sd.name == snapshot_name }
         unless snapshot_def
           raise Nanoc::Core::Errors::NoSuchSnapshot.new(rep, snapshot_name)
         end
@@ -61,12 +66,15 @@ module Nanoc
         raise Nanoc::Core::Errors::UnmetDependency.new(rep, snapshot_name)
       end
 
-      contract C::KeywordArgs[rep: Nanoc::Core::ItemRep, snapshot: C::Optional[C::Maybe[Symbol]]] => String
+      contract C::KeywordArgs[
+        rep: Nanoc::Core::ItemRep,
+        snapshot: C::Optional[C::Maybe[Symbol]]] => String
       def compiled_content(rep:, snapshot: nil)
         snapshot_content = raw_compiled_content(rep:, snapshot:)
 
         if snapshot_content.binary?
-          raise Nanoc::Core::Errors::CannotGetCompiledContentOfBinaryItem.new(rep)
+          raise Nanoc::Core::Errors::CannotGetCompiledContentOfBinaryItem
+            .new(rep)
         end
 
         snapshot_content.string

data/lib/nanoc/core/compiler.rb

@@ -15,7 +15,10 @@ module Nanoc
         Nanoc::Core::CompilerLoader.new.load(site, focus:)
       end
 
-      def initialize(site, compiled_content_cache:, checksum_store:, action_sequence_store:, action_provider:, dependency_store:, outdatedness_store:, focus:)
+      def initialize(
+        site, compiled_content_cache:, checksum_store:, action_sequence_store:,
+        action_provider:, dependency_store:, outdatedness_store:, focus:
+      )
         @site = site
 
         # Needed because configuration is mutable :(
@@ -65,7 +68,10 @@ module Nanoc
             action_sequences:,
             reps:,
           )
-          outdated_items = determine_outdatedness_stage(outdatedness_checker, reps).call
+          outdated_items = determine_outdatedness_stage(
+            outdatedness_checker,
+            reps,
+          ).call
 
           prev.merge(
             checksums:,
@@ -84,7 +90,10 @@ module Nanoc
         outdated_items = res.fetch(:outdated_items)
 
         forget_outdated_dependencies_stage.call(outdated_items)
-        store_pre_compilation_state_stage(action_sequences, reps).call(checksums)
+        store_pre_compilation_state_stage(
+          action_sequences,
+          reps,
+        ).call(checksums)
         prune_stage(reps).call
         compile_reps_stage(action_sequences, reps).call
         store_post_compilation_state_stage.call

data/lib/nanoc/core/compiler_loader.rb

@@ -5,17 +5,26 @@ module Nanoc
     # @api private
     class CompilerLoader
       def load(site, focus: nil, action_provider: nil)
-        action_sequence_store = Nanoc::Core::ActionSequenceStore.new(config: site.config)
+        action_sequence_store =
+          Nanoc::Core::ActionSequenceStore.new(config: site.config)
 
         dependency_store =
-          Nanoc::Core::DependencyStore.new(site.items, site.layouts, site.config)
+          Nanoc::Core::DependencyStore.new(
+            site.items, site.layouts, site.config
+          )
 
-        objects = site.items.to_a + site.layouts.to_a + site.code_snippets + [site.config]
+        objects = site.items.to_a +
+                  site.layouts.to_a +
+                  site.code_snippets +
+                  [site.config]
 
         checksum_store =
           Nanoc::Core::ChecksumStore.new(config: site.config, objects:)
 
-        action_provider ||= Nanoc::Core::ActionProvider.named(site.config.action_provider).for(site)
+        action_provider ||=
+          Nanoc::Core::ActionProvider
+          .named(site.config.action_provider)
+          .for(site)
 
         outdatedness_store =
           Nanoc::Core::OutdatednessStore.new(config: site.config)

data/lib/nanoc/core/config_loader.rb

@@ -18,7 +18,8 @@ module Nanoc
 
       class CyclicalConfigFileError < ::Nanoc::Core::Error
         def initialize(filename)
-          super("The parent configuration file at #{filename} includes one of its descendants")
+          super("The parent configuration file at #{filename} includes one " \
+                'of its descendants')
         end
       end
 
@@ -68,7 +69,10 @@ module Nanoc
         return config if parent_path.nil?
 
         # Get absolute path
-        parent_path = File.absolute_path(parent_path, File.dirname(processed_paths.last))
+        parent_path = File.absolute_path(
+          parent_path,
+          File.dirname(processed_paths.last),
+        )
         unless File.file?(parent_path)
           raise NoParentConfigFileFoundError.new(parent_path)
         end
@@ -79,8 +83,14 @@ module Nanoc
         end
 
         # Load
-        parent_config = Nanoc::Core::Configuration.new(hash: load_file(parent_path), dir: config.dir)
-        full_parent_config = apply_parent_config(parent_config, processed_paths + [parent_path])
+        parent_config = Nanoc::Core::Configuration.new(
+          hash: load_file(parent_path),
+          dir: config.dir,
+        )
+        full_parent_config = apply_parent_config(
+          parent_config,
+          processed_paths + [parent_path],
+        )
         full_parent_config.merge(config.without(:parent_config_file))
       end
     end

data/lib/nanoc/core/configuration.rb

@@ -17,13 +17,18 @@ module Nanoc
       }.freeze
 
       # The default configuration for a site. A site's configuration overrides
-      # these options: when a {Nanoc::Core::Site} is created with a configuration
-      # that lacks some options, the default value will be taken from
-      # `DEFAULT_CONFIG`.
+      # these options: when a {Nanoc::Core::Site} is created with a
+      # configuration that lacks some options, the default value will be taken
+      # from `DEFAULT_CONFIG`.
       DEFAULT_CONFIG = {
-        text_extensions: %w[adoc asciidoc atom css erb haml htm html js less markdown md org php rb sass scss tex txt xhtml xml coffee hb handlebars mustache ms slim rdoc].sort,
-        lib_dirs: %w[lib],
-        commands_dirs: %w[commands],
+        text_extensions: [
+          'adoc', 'asciidoc', 'atom', 'css', 'erb', 'haml', 'htm', 'html', 'js',
+          'less', 'markdown', 'md', 'org', 'php', 'rb', 'sass', 'scss', 'tex',
+          'txt', 'xhtml', 'xml', 'coffee', 'hb', 'handlebars', 'mustache', 'ms',
+          'slim', 'rdoc'
+        ].sort,
+        lib_dirs: ['lib'],
+        commands_dirs: ['commands'],
         output_dir: 'output',
         data_sources: [{}],
         index_filenames: ['index.html'],
@@ -44,7 +49,9 @@ module Nanoc
       NANOC_ENV = 'NANOC_ENV'
       NANOC_ENV_DEFAULT = 'default'
 
-      contract C::KeywordArgs[hash: C::Optional[Hash], env_name: C::Maybe[String], dir: C::AbsolutePathString] => C::Any
+      contract C::KeywordArgs[
+        hash: C::Optional[Hash], env_name: C::Maybe[String],
+        dir: C::AbsolutePathString] => C::Any
       def initialize(dir:, hash: {}, env_name: nil)
         @env_name = env_name
         @wrapped = hash.__nanoc_symbolize_keys_recursively
@@ -70,7 +77,8 @@ module Nanoc
         env_name = @env_name || ENV.fetch(NANOC_ENV, NANOC_ENV_DEFAULT)
 
         # Load given environment configuration
-        env_config = @wrapped[ENVIRONMENTS_CONFIG_KEY].fetch(env_name.to_sym, {})
+        env_config =
+          @wrapped[ENVIRONMENTS_CONFIG_KEY].fetch(env_name.to_sym, {})
 
         self.class.new(hash: @wrapped, dir: @dir, env_name:).merge(env_config)
       end
@@ -101,7 +109,9 @@ module Nanoc
         @wrapped.dig(*keys)
       end
 
-      contract C::Any, C::Maybe[C::Any], C::Maybe[C::Func[C::None => C::Any]] => C::Any
+      contract C::Any,
+               C::Maybe[C::Any],
+               C::Maybe[C::Func[C::None => C::Any]] => C::Any
       def fetch(key, fallback = Nanoc::Core::UNDEFINED, &)
         @wrapped.fetch(key) do
           if !Nanoc::Core::UNDEFINED.equal?(fallback)
@@ -121,12 +131,20 @@ module Nanoc
 
       contract C::Or[Hash, self] => self
       def merge(hash)
-        self.class.new(hash: merge_recursively(@wrapped, hash.to_h), dir: @dir, env_name: @env_name)
+        self.class.new(
+          hash: merge_recursively(@wrapped, hash.to_h),
+          dir: @dir,
+          env_name: @env_name,
+        )
       end
 
       contract C::Any => self
       def without(key)
-        self.class.new(hash: @wrapped.reject { |k, _v| k == key }, dir: @dir, env_name: @env_name)
+        self.class.new(
+          hash: @wrapped.reject { |k, _v| k == key },
+          dir: @dir,
+          env_name: @env_name,
+        )
       end
 
       contract C::Any => self
@@ -161,7 +179,8 @@ module Nanoc
       contract C::None => C::IterOf[C::AbsolutePathString]
       def output_dirs
         envs = @wrapped.fetch(ENVIRONMENTS_CONFIG_KEY, {})
-        res = [output_dir] + envs.values.map { |v| make_absolute(v[:output_dir]) }
+        res = [output_dir] +
+              envs.values.map { |v| make_absolute(v[:output_dir]) }
         res.uniq.compact
       end
 
@@ -169,7 +188,7 @@ module Nanoc
       #
       # @return [Object] An unique reference to this object
       def reference
-        'configuration'
+        :configuration
       end
 
       def inspect
@@ -188,7 +207,9 @@ module Nanoc
 
       contract C::Any => C::Bool
       def eql?(other)
-        other.is_a?(self.class) && @dir == other.dir && @env_name == other.env_name
+        other.is_a?(self.class) &&
+          @dir == other.dir &&
+          @env_name == other.env_name
       end
 
       private
@@ -209,7 +230,7 @@ module Nanoc
 
       def validate
         dir = File.dirname(__FILE__)
-        schema_data = JSON.parse(File.read(dir + '/configuration-schema.json'))
+        schema_data = JSON.parse(File.read("#{dir}/configuration-schema.json"))
         schema = JsonSchema.parse!(schema_data)
         schema.expand_references!
         schema.validate!(@wrapped.__nanoc_stringify_keys_recursively)

data/lib/nanoc/core/content.rb

@@ -5,7 +5,11 @@ module Nanoc
     class Content
       include Nanoc::Core::ContractsSupport
 
-      contract C::Or[self, String, Proc], C::KeywordArgs[binary: C::Optional[C::Bool], filename: C::Optional[C::Maybe[String]]] => self
+      contract C::Or[self, String, Proc],
+               C::KeywordArgs[
+                 binary: C::Optional[C::Bool],
+                 filename: C::Optional[C::Maybe[String]],
+               ] => self
       def self.create(content, binary: false, filename: nil)
         if content.nil?
           raise ArgumentError, 'Cannot create nil content'

data/lib/nanoc/core/context.rb

@@ -26,21 +26,20 @@ module Nanoc
       #     # => "I am Max Payne and I am hiding in a cheap motel."
       def initialize(hash)
         hash.each_pair do |key, value|
-          instance_variable_set('@' + key.to_s, value)
+          instance_variable_set("@#{key}", value)
         end
       end
 
       # Returns a binding for this instance.
       #
       # @return [Binding] A binding for this instance
-      # rubocop:disable Naming/AccessorMethodName
+      # rubocop:disable-next Naming/AccessorMethodName
       def get_binding
         binding
       end
-      # rubocop:enable Naming/AccessorMethodName
 
       def method_missing(method, *args, &)
-        ivar_name = '@' + method.to_s
+        ivar_name = "@#{method}"
         if instance_variable_defined?(ivar_name)
           instance_variable_get(ivar_name)
         else
@@ -49,7 +48,7 @@ module Nanoc
       end
 
       def respond_to_missing?(method, include_all)
-        ivar_name = '@' + method.to_s
+        ivar_name = "@#{method}"
 
         valid_ivar_name =
           if defined?(Contracts)