nanoc 4.11.0 → 4.11.1

data/lib/nanoc/base/services.rb

@@ -2,7 +2,6 @@
 
 require_relative 'services/action_provider'
 require_relative 'services/action_sequence_builder'
-require_relative 'services/checksummer'
 require_relative 'services/compilation_context'
 require_relative 'services/compiler'
 require_relative 'services/compiler_loader'
@@ -14,9 +13,7 @@ require_relative 'services/item_rep_builder'
 require_relative 'services/item_rep_router'
 require_relative 'services/item_rep_selector'
 require_relative 'services/item_rep_writer'
-require_relative 'services/notification_center'
 require_relative 'services/pruner'
-require_relative 'services/temp_filename_factory'
 require_relative 'services/outdatedness_rule'
 require_relative 'services/outdatedness_rules'
 
@@ -24,3 +21,10 @@ require_relative 'services/compiler/phases'
 require_relative 'services/compiler/stages'
 
 require_relative 'services/outdatedness_checker'
+
+# TODO: Move this into the entity, once the load order is improved (i.e. the
+# checksummer is loaded after CodeSnippet).
+Nanoc::Core::Checksummer.define_behavior(
+  Nanoc::Core::CodeSnippet,
+  Nanoc::Core::Checksummer::DataUpdateBehavior,
+)

data/lib/nanoc/base/services/action_provider.rb

@@ -1,32 +1,34 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  # @private
-  class ActionProvider
-    extend DDPlugin::Plugin
+module Nanoc
+  module Int
+    # @private
+    class ActionProvider
+      extend DDPlugin::Plugin
 
-    def self.for(_site)
-      raise NotImplementedError
-    end
+      def self.for(_site)
+        raise NotImplementedError
+      end
 
-    def rep_names_for(_item)
-      raise NotImplementedError
-    end
+      def rep_names_for(_item)
+        raise NotImplementedError
+      end
 
-    def action_sequence_for(_obj)
-      raise NotImplementedError
-    end
+      def action_sequence_for(_obj)
+        raise NotImplementedError
+      end
 
-    def need_preprocessing?
-      raise NotImplementedError
-    end
+      def need_preprocessing?
+        raise NotImplementedError
+      end
 
-    def preprocess(_site)
-      raise NotImplementedError
-    end
+      def preprocess(_site)
+        raise NotImplementedError
+      end
 
-    def postprocess(_site, _reps)
-      raise NotImplementedError
+      def postprocess(_site, _reps)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/nanoc/base/services/action_sequence_builder.rb

@@ -1,46 +1,54 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  class ActionSequenceBuilder
-    include Nanoc::Int::ContractsSupport
+module Nanoc
+  module Int
+    class ActionSequenceBuilder
+      include Nanoc::Core::ContractsSupport
+
+      def self.build(rep)
+        builder = new(rep)
+        yield(builder)
+        builder.action_sequence
+      end
 
-    def initialize(item_rep)
-      @item_rep = item_rep
-      @actions = []
-    end
+      def initialize(item_rep)
+        @item_rep = item_rep
+        @actions = []
+      end
 
-    contract Symbol, Hash => self
-    def add_filter(filter_name, params)
-      @actions << Nanoc::Int::ProcessingActions::Filter.new(filter_name, params)
-      self
-    end
+      contract Symbol, Hash => self
+      def add_filter(filter_name, params)
+        @actions << Nanoc::Core::ProcessingActions::Filter.new(filter_name, params)
+        self
+      end
 
-    contract String, C::Maybe[Hash] => self
-    def add_layout(layout_identifier, params)
-      @actions << Nanoc::Int::ProcessingActions::Layout.new(layout_identifier, params)
-      self
-    end
+      contract String, C::Maybe[Hash] => self
+      def add_layout(layout_identifier, params)
+        @actions << Nanoc::Core::ProcessingActions::Layout.new(layout_identifier, params)
+        self
+      end
 
-    contract Symbol, C::Maybe[String] => self
-    def add_snapshot(snapshot_name, path)
-      will_add_snapshot(snapshot_name)
-      @actions << Nanoc::Int::ProcessingActions::Snapshot.new([snapshot_name], path ? [path] : [])
-      self
-    end
+      contract Symbol, C::Maybe[String] => self
+      def add_snapshot(snapshot_name, path)
+        will_add_snapshot(snapshot_name)
+        @actions << Nanoc::Core::ProcessingActions::Snapshot.new([snapshot_name], path ? [path] : [])
+        self
+      end
 
-    contract C::None => Nanoc::Int::ActionSequence
-    def action_sequence
-      Nanoc::Int::ActionSequence.new(@item_rep, actions: @actions)
-    end
+      contract C::None => Nanoc::Int::ActionSequence
+      def action_sequence
+        Nanoc::Int::ActionSequence.new(@item_rep, actions: @actions)
+      end
 
-    private
+      private
 
-    def will_add_snapshot(name)
-      @_snapshot_names ||= Set.new
-      if @_snapshot_names.include?(name)
-        raise Nanoc::Int::Errors::CannotCreateMultipleSnapshotsWithSameName.new(@item_rep, name)
-      else
-        @_snapshot_names << name
+      def will_add_snapshot(name)
+        @_snapshot_names ||= Set.new
+        if @_snapshot_names.include?(name)
+          raise Nanoc::Int::Errors::CannotCreateMultipleSnapshotsWithSameName.new(@item_rep, name)
+        else
+          @_snapshot_names << name
+        end
       end
     end
   end

data/lib/nanoc/base/services/compilation_context.rb

@@ -1,57 +1,59 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  class CompilationContext
-    attr_reader :site
-    attr_reader :compiled_content_cache
-    attr_reader :snapshot_repo
-
-    def initialize(action_provider:, reps:, site:, compiled_content_cache:, snapshot_repo:)
-      @action_provider = action_provider
-      @reps = reps
-      @site = site
-      @compiled_content_cache = compiled_content_cache
-      @snapshot_repo = snapshot_repo
-    end
-
-    def filter_name_and_args_for_layout(layout)
-      seq = @action_provider.action_sequence_for(layout)
-      if seq.nil? || seq.size != 1 || !seq[0].is_a?(Nanoc::Int::ProcessingActions::Filter)
-        raise Nanoc::Int::Errors::UndefinedFilterForLayout.new(layout)
+module Nanoc
+  module Int
+    class CompilationContext
+      attr_reader :site
+      attr_reader :compiled_content_cache
+      attr_reader :compiled_content_store
+
+      def initialize(action_provider:, reps:, site:, compiled_content_cache:, compiled_content_store:)
+        @action_provider = action_provider
+        @reps = reps
+        @site = site
+        @compiled_content_cache = compiled_content_cache
+        @compiled_content_store = compiled_content_store
       end
 
-      [seq[0].filter_name, seq[0].params]
-    end
-
-    def create_view_context(dependency_tracker)
-      Nanoc::ViewContextForCompilation.new(
-        reps: @reps,
-        items: @site.items,
-        dependency_tracker: dependency_tracker,
-        compilation_context: self,
-        snapshot_repo: @snapshot_repo,
-      )
-    end
-
-    def assigns_for(rep, dependency_tracker)
-      last_content = @snapshot_repo.get(rep, :last)
-      content_or_filename_assigns =
-        if last_content.binary?
-          { filename: last_content.filename }
-        else
-          { content: last_content.string }
+      def filter_name_and_args_for_layout(layout)
+        seq = @action_provider.action_sequence_for(layout)
+        if seq.nil? || seq.size != 1 || !seq[0].is_a?(Nanoc::Core::ProcessingActions::Filter)
+          raise Nanoc::Int::Errors::UndefinedFilterForLayout.new(layout)
         end
 
-      view_context = create_view_context(dependency_tracker)
+        [seq[0].filter_name, seq[0].params]
+      end
 
-      content_or_filename_assigns.merge(
-        item: Nanoc::CompilationItemView.new(rep.item, view_context),
-        rep: Nanoc::CompilationItemRepView.new(rep, view_context),
-        item_rep: Nanoc::CompilationItemRepView.new(rep, view_context),
-        items: Nanoc::ItemCollectionWithRepsView.new(@site.items, view_context),
-        layouts: Nanoc::LayoutCollectionView.new(@site.layouts, view_context),
-        config: Nanoc::ConfigView.new(@site.config, view_context),
-      )
+      def create_view_context(dependency_tracker)
+        Nanoc::ViewContextForCompilation.new(
+          reps: @reps,
+          items: @site.items,
+          dependency_tracker: dependency_tracker,
+          compilation_context: self,
+          compiled_content_store: @compiled_content_store,
+        )
+      end
+
+      def assigns_for(rep, dependency_tracker)
+        last_content = @compiled_content_store.get_current(rep)
+        content_or_filename_assigns =
+          if last_content.binary?
+            { filename: last_content.filename }
+          else
+            { content: last_content.string }
+          end
+
+        view_context = create_view_context(dependency_tracker)
+
+        content_or_filename_assigns.merge(
+          item: Nanoc::CompilationItemView.new(rep.item, view_context),
+          rep: Nanoc::CompilationItemRepView.new(rep, view_context),
+          item_rep: Nanoc::CompilationItemRepView.new(rep, view_context),
+          items: Nanoc::ItemCollectionWithRepsView.new(@site.items, view_context),
+          layouts: Nanoc::LayoutCollectionView.new(@site.layouts, view_context),
+          config: Nanoc::ConfigView.new(@site.config, view_context),
+        )
+      end
     end
   end
 end

data/lib/nanoc/base/services/compiler.rb

@@ -1,207 +1,214 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  class Compiler
-    include Nanoc::Int::ContractsSupport
+module Nanoc
+  module Int
+    class Compiler
+      include Nanoc::Core::ContractsSupport
 
-    def initialize(site, compiled_content_cache:, checksum_store:, action_sequence_store:, action_provider:, dependency_store:, outdatedness_store:)
-      @site = site
+      def initialize(site, compiled_content_cache:, checksum_store:, action_sequence_store:, action_provider:, dependency_store:, outdatedness_store:)
+        @site = site
 
-      # Needed because configuration is mutable :(
-      @output_dirs = @site.config.output_dirs
+        # Needed because configuration is mutable :(
+        @output_dirs = @site.config.output_dirs
 
-      @compiled_content_cache = compiled_content_cache
-      @checksum_store         = checksum_store
-      @action_sequence_store  = action_sequence_store
-      @dependency_store       = dependency_store
-      @action_provider        = action_provider
-      @outdatedness_store     = outdatedness_store
+        @compiled_content_cache = compiled_content_cache
+        @checksum_store         = checksum_store
+        @action_sequence_store  = action_sequence_store
+        @dependency_store       = dependency_store
+        @action_provider        = action_provider
+        @outdatedness_store     = outdatedness_store
 
-      @snapshot_repo = Nanoc::Int::SnapshotRepo.new
-    end
+        @compiled_content_store = Nanoc::Int::CompiledContentStore.new
+      end
 
-    contract Nanoc::Int::Site => Nanoc::Int::Compiler
-    def self.new_for(site)
-      Nanoc::Int::CompilerLoader.new.load(site)
-    end
+      contract Nanoc::Int::Site => C::Any
+      def self.compile(site)
+        new_for(site).run_until_end
+      end
 
-    def run_until_preprocessed
-      @_res_preprocessed ||= begin
-        preprocess_stage.call
-        {}
+      contract Nanoc::Int::Site => Nanoc::Int::Compiler
+      def self.new_for(site)
+        Nanoc::Int::CompilerLoader.new.load(site)
       end
-    end
 
-    def run_until_reps_built
-      @_res_reps_built ||= begin
-        prev = run_until_preprocessed
+      def run_until_preprocessed
+        @_res_preprocessed ||= begin
+          preprocess_stage.call
+          {}
+        end
+      end
+
+      def run_until_reps_built
+        @_res_reps_built ||= begin
+          prev = run_until_preprocessed
+
+          res = build_reps_stage.call
+
+          prev.merge(
+            reps: res.fetch(:reps),
+            action_sequences: res.fetch(:action_sequences),
+          )
+        end
+      end
 
-        res = build_reps_stage.call
+      def run_until_precompiled
+        @_res_precompiled ||= begin
+          prev = run_until_reps_built
+          action_sequences = prev.fetch(:action_sequences)
+          reps = prev.fetch(:reps)
+
+          load_stores_stage.call
+          checksums = calculate_checksums_stage.call
+          outdatedness_checker = create_outdatedness_checker(
+            checksums: checksums,
+            action_sequences: action_sequences,
+            reps: reps,
+          )
+          outdated_items = determine_outdatedness_stage(outdatedness_checker, reps).call
+
+          prev.merge(
+            checksums: checksums,
+            dependency_store: @dependency_store,
+            outdatedness_checker: outdatedness_checker,
+            outdated_items: outdated_items,
+          )
+        end
+      end
 
-        prev.merge(
-          reps: res.fetch(:reps),
-          action_sequences: res.fetch(:action_sequences),
+      def run_until_end
+        res = run_until_precompiled
+        action_sequences = res.fetch(:action_sequences)
+        reps = res.fetch(:reps)
+        checksums = res.fetch(:checksums)
+        outdated_items = res.fetch(:outdated_items)
+
+        forget_outdated_dependencies_stage.call(outdated_items)
+        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
+        postprocess_stage.call(self)
+      ensure
+        cleanup_stage.call
+      end
+
+      def compilation_context(reps:)
+        Nanoc::Int::CompilationContext.new(
+          action_provider: @action_provider,
+          reps: reps,
+          site: @site,
+          compiled_content_cache: @compiled_content_cache,
+          compiled_content_store: @compiled_content_store,
         )
       end
-    end
 
-    def run_until_precompiled
-      @_res_precompiled ||= begin
-        prev = run_until_reps_built
-        action_sequences = prev.fetch(:action_sequences)
-        reps = prev.fetch(:reps)
+      private
 
-        load_stores_stage.call
-        checksums = calculate_checksums_stage.call
-        outdatedness_checker = create_outdatedness_checker(
-          checksums: checksums,
+      def create_outdatedness_checker(checksums:, action_sequences:, reps:)
+        Nanoc::Int::OutdatednessChecker.new(
+          site: @site,
+          checksum_store: @checksum_store,
+          dependency_store: @dependency_store,
+          action_sequence_store: @action_sequence_store,
           action_sequences: action_sequences,
+          checksums: checksums,
           reps: reps,
         )
-        outdated_items = determine_outdatedness_stage(outdatedness_checker, reps).call
+      end
 
-        prev.merge(
-          checksums: checksums,
+      def preprocess_stage
+        @_preprocess_stage ||= Stages::Preprocess.new(
+          action_provider: @action_provider,
+          site: @site,
           dependency_store: @dependency_store,
-          outdatedness_checker: outdatedness_checker,
-          outdated_items: outdated_items,
+          checksum_store: @checksum_store,
         )
       end
-    end
-
-    def run_until_end
-      res = run_until_precompiled
-      action_sequences = res.fetch(:action_sequences)
-      reps = res.fetch(:reps)
-      checksums = res.fetch(:checksums)
-      outdated_items = res.fetch(:outdated_items)
-
-      forget_outdated_dependencies_stage.call(outdated_items)
-      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
-      postprocess_stage.call(self)
-    ensure
-      cleanup_stage.call
-    end
-
-    def compilation_context(reps:)
-      Nanoc::Int::CompilationContext.new(
-        action_provider: @action_provider,
-        reps: reps,
-        site: @site,
-        compiled_content_cache: @compiled_content_cache,
-        snapshot_repo: @snapshot_repo,
-      )
-    end
-
-    private
-
-    def create_outdatedness_checker(checksums:, action_sequences:, reps:)
-      Nanoc::Int::OutdatednessChecker.new(
-        site: @site,
-        checksum_store: @checksum_store,
-        dependency_store: @dependency_store,
-        action_sequence_store: @action_sequence_store,
-        action_sequences: action_sequences,
-        checksums: checksums,
-        reps: reps,
-      )
-    end
-
-    def preprocess_stage
-      @_preprocess_stage ||= Stages::Preprocess.new(
-        action_provider: @action_provider,
-        site: @site,
-        dependency_store: @dependency_store,
-        checksum_store: @checksum_store,
-      )
-    end
 
-    def build_reps_stage
-      @_build_reps_stage ||= Stages::BuildReps.new(
-        site: @site,
-        action_provider: @action_provider,
-      )
-    end
+      def build_reps_stage
+        @_build_reps_stage ||= Stages::BuildReps.new(
+          site: @site,
+          action_provider: @action_provider,
+        )
+      end
 
-    def prune_stage(reps)
-      @_prune_stage ||= Stages::Prune.new(
-        config: @site.config,
-        reps: reps,
-      )
-    end
+      def prune_stage(reps)
+        @_prune_stage ||= Stages::Prune.new(
+          config: @site.config,
+          reps: reps,
+        )
+      end
 
-    def load_stores_stage
-      @_load_stores_stage ||= Stages::LoadStores.new(
-        checksum_store: @checksum_store,
-        compiled_content_cache: @compiled_content_cache,
-        dependency_store: @dependency_store,
-        action_sequence_store: @action_sequence_store,
-        outdatedness_store: @outdatedness_store,
-      )
-    end
+      def load_stores_stage
+        @_load_stores_stage ||= Stages::LoadStores.new(
+          checksum_store: @checksum_store,
+          compiled_content_cache: @compiled_content_cache,
+          dependency_store: @dependency_store,
+          action_sequence_store: @action_sequence_store,
+          outdatedness_store: @outdatedness_store,
+        )
+      end
 
-    def calculate_checksums_stage
-      @_calculate_checksums_stage ||= Stages::CalculateChecksums.new(
-        items: @site.items,
-        layouts: @site.layouts,
-        code_snippets: @site.code_snippets,
-        config: @site.config,
-      )
-    end
+      def calculate_checksums_stage
+        @_calculate_checksums_stage ||= Stages::CalculateChecksums.new(
+          items: @site.items,
+          layouts: @site.layouts,
+          code_snippets: @site.code_snippets,
+          config: @site.config,
+        )
+      end
 
-    def determine_outdatedness_stage(outdatedness_checker, reps)
-      @_determine_outdatedness_stage ||= Stages::DetermineOutdatedness.new(
-        reps: reps,
-        outdatedness_checker: outdatedness_checker,
-        outdatedness_store: @outdatedness_store,
-      )
-    end
+      def determine_outdatedness_stage(outdatedness_checker, reps)
+        @_determine_outdatedness_stage ||= Stages::DetermineOutdatedness.new(
+          reps: reps,
+          outdatedness_checker: outdatedness_checker,
+          outdatedness_store: @outdatedness_store,
+        )
+      end
 
-    def store_pre_compilation_state_stage(action_sequences, reps)
-      @_store_pre_compilation_state_stage ||= Stages::StorePreCompilationState.new(
-        reps: reps,
-        layouts: @site.layouts,
-        checksum_store: @checksum_store,
-        action_sequence_store: @action_sequence_store,
-        action_sequences: action_sequences,
-      )
-    end
+      def store_pre_compilation_state_stage(action_sequences, reps)
+        @_store_pre_compilation_state_stage ||= Stages::StorePreCompilationState.new(
+          reps: reps,
+          layouts: @site.layouts,
+          checksum_store: @checksum_store,
+          action_sequence_store: @action_sequence_store,
+          action_sequences: action_sequences,
+        )
+      end
 
-    def compile_reps_stage(action_sequences, reps)
-      @_compile_reps_stage ||= Stages::CompileReps.new(
-        reps: reps,
-        outdatedness_store: @outdatedness_store,
-        dependency_store: @dependency_store,
-        action_sequences: action_sequences,
-        compilation_context: compilation_context(reps: reps),
-        compiled_content_cache: @compiled_content_cache,
-      )
-    end
+      def compile_reps_stage(action_sequences, reps)
+        @_compile_reps_stage ||= Stages::CompileReps.new(
+          reps: reps,
+          outdatedness_store: @outdatedness_store,
+          dependency_store: @dependency_store,
+          action_sequences: action_sequences,
+          compilation_context: compilation_context(reps: reps),
+          compiled_content_cache: @compiled_content_cache,
+        )
+      end
 
-    def store_post_compilation_state_stage
-      @_store_post_compilation_state_stage ||= Stages::StorePostCompilationState.new(
-        dependency_store: @dependency_store,
-      )
-    end
+      def store_post_compilation_state_stage
+        @_store_post_compilation_state_stage ||= Stages::StorePostCompilationState.new(
+          dependency_store: @dependency_store,
+        )
+      end
 
-    def postprocess_stage
-      @_postprocess_stage ||= Stages::Postprocess.new(
-        action_provider: @action_provider,
-        site: @site,
-      )
-    end
+      def postprocess_stage
+        @_postprocess_stage ||= Stages::Postprocess.new(
+          action_provider: @action_provider,
+          site: @site,
+        )
+      end
 
-    def cleanup_stage
-      @_cleanup_stage ||= Stages::Cleanup.new(@output_dirs)
-    end
+      def cleanup_stage
+        @_cleanup_stage ||= Stages::Cleanup.new(@output_dirs)
+      end
 
-    def forget_outdated_dependencies_stage
-      @_forget_outdated_dependencies_stage ||= Stages::ForgetOutdatedDependencies.new(
-        dependency_store: @dependency_store,
-      )
+      def forget_outdated_dependencies_stage
+        @_forget_outdated_dependencies_stage ||= Stages::ForgetOutdatedDependencies.new(
+          dependency_store: @dependency_store,
+        )
+      end
     end
   end
 end