nanoc 4.8.9 → 4.8.10

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

@@ -2,19 +2,16 @@
 
 module Nanoc::Int::Compiler::Stages
   class BuildReps
-    def initialize(site:, action_provider:, reps:)
+    def initialize(site:, action_provider:)
       @site = site
       @action_provider = action_provider
-      @reps = reps
     end
 
     def run
-      # FIXME: This also, as a side effect, generates the action sequences. :(
-      # Better: let this stage return a mapping of reps onto (raw) paths *and* a mapping of objects
-      # onto action sequences.
+      reps = Nanoc::Int::ItemRepRepo.new
 
       builder = Nanoc::Int::ItemRepBuilder.new(
-        @site, @action_provider, @reps
+        @site, @action_provider, reps
       )
 
       action_sequences = builder.run
@@ -23,7 +20,10 @@ module Nanoc::Int::Compiler::Stages
         action_sequences[layout] = @action_provider.action_sequence_for(layout)
       end
 
-      action_sequences
+      {
+        reps: reps,
+        action_sequences: action_sequences,
+      }
     end
   end
 end

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

@@ -2,7 +2,8 @@
 
 module Nanoc::Int::Compiler::Stages
   class CompileReps
-    def initialize(outdatedness_store:, dependency_store:, action_sequences:, compilation_context:, compiled_content_cache:)
+    def initialize(reps:, outdatedness_store:, dependency_store:, action_sequences:, compilation_context:, compiled_content_cache:)
+      @reps = reps
       @outdatedness_store = outdatedness_store
       @dependency_store = dependency_store
       @action_sequences = action_sequences
@@ -11,7 +12,8 @@ module Nanoc::Int::Compiler::Stages
     end
 
     def run
-      selector = Nanoc::Int::ItemRepSelector.new(@outdatedness_store.to_a)
+      outdated_reps = @reps.select { |r| @outdatedness_store.include?(r) }
+      selector = Nanoc::Int::ItemRepSelector.new(outdated_reps)
       selector.each do |rep|
         handle_errors_while(rep) { compile_rep(rep, is_outdated: @outdatedness_store.include?(rep)) }
       end

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

@@ -12,16 +12,34 @@ module Nanoc::Int::Compiler::Stages
 
     contract C::None => C::Any
     def run
-      outdated_reps_tmp = @reps.select do |r|
-        @outdatedness_store.include?(r) || @outdatedness_checker.outdated?(r)
-      end
+      outdated_items = select_outdated_items
+      outdated_reps = reps_of_items(outdated_items)
 
-      outdated_items = outdated_reps_tmp.map(&:item).uniq
-      outdated_reps = Set.new(outdated_items.flat_map { |i| @reps[i] })
-
-      outdated_reps.each { |r| @outdatedness_store.add(r) }
+      store_outdated_reps(outdated_reps)
 
       outdated_items
     end
+
+    private
+
+    def store_outdated_reps(reps)
+      @outdatedness_store.clear
+      reps.each { |r| @outdatedness_store.add(r) }
+    end
+
+    def select_outdated_items
+      @reps
+        .select { |r| outdated?(r) }
+        .map(&:item)
+        .uniq
+    end
+
+    def reps_of_items(items)
+      Set.new(items.flat_map { |i| @reps[i] })
+    end
+
+    def outdated?(r)
+      @outdatedness_store.include?(r) || @outdatedness_checker.outdated?(r)
+    end
   end
 end

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

@@ -10,9 +10,9 @@ module Nanoc::Int::Compiler::Stages
       @reps = reps
     end
 
-    contract C::None => C::Any
-    def run
-      @action_provider.postprocess(@site, @reps)
+    contract Nanoc::Int::Compiler => C::Any
+    def run(compiler)
+      @action_provider.postprocess(@site, compiler, @reps)
     end
   end
 end

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

@@ -10,6 +10,8 @@ module Nanoc::Int::Compiler::Stages
     end
 
     def run
+      return if @site.preprocessed?
+
       if @action_provider.need_preprocessing?
         @site.data_source = Nanoc::Int::InMemDataSource.new(@site.items, @site.layouts)
         @action_provider.preprocess(@site)
@@ -19,6 +21,7 @@ module Nanoc::Int::Compiler::Stages
         @checksum_store.objects = @site.items.to_a + @site.layouts.to_a + @site.code_snippets + [@site.config]
       end
 
+      @site.mark_as_preprocessed
       @site.freeze
     end
   end

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

@@ -14,12 +14,10 @@ module Nanoc::Int
       checksum_store =
         Nanoc::Int::ChecksumStore.new(site: site, objects: objects)
 
-      item_rep_repo = Nanoc::Int::ItemRepRepo.new
-
       action_provider ||= Nanoc::Int::ActionProvider.named(:rule_dsl).for(site)
 
       outdatedness_store =
-        Nanoc::Int::OutdatednessStore.new(site: site, reps: item_rep_repo)
+        Nanoc::Int::OutdatednessStore.new(site: site)
 
       compiled_content_cache =
         Nanoc::Int::CompiledContentCache.new(
@@ -32,7 +30,6 @@ module Nanoc::Int
         checksum_store: checksum_store,
         action_sequence_store: action_sequence_store,
         dependency_store: dependency_store,
-        reps: item_rep_repo,
         action_provider: action_provider,
         outdatedness_store: outdatedness_store,
       }

data/lib/nanoc/base/views.rb

@@ -2,21 +2,28 @@
 
 require_relative 'views/mixins/document_view_mixin'
 require_relative 'views/mixins/mutable_document_view_mixin'
-require_relative 'views/mixins/with_reps_view_mixin'
+
+require_relative 'views/view_context_for_compilation'
+require_relative 'views/view_context_for_pre_compilation'
+require_relative 'views/view_context_for_shell'
 
 require_relative 'views/view'
-require_relative 'views/view_context'
+
+require_relative 'views/basic_item_rep_view'
+require_relative 'views/basic_item_rep_collection_view'
+require_relative 'views/basic_item_view'
+
+require_relative 'views/compilation_item_rep_view'
+require_relative 'views/compilation_item_rep_collection_view'
+require_relative 'views/compilation_item_view'
 
 require_relative 'views/config_view'
 require_relative 'views/identifiable_collection_view'
-require_relative 'views/item_without_reps_view'
-require_relative 'views/item_with_reps_view'
 require_relative 'views/item_collection_with_reps_view'
 require_relative 'views/item_collection_without_reps_view'
-require_relative 'views/item_rep_view'
-require_relative 'views/item_rep_collection_view'
 require_relative 'views/layout_view'
 require_relative 'views/layout_collection_view'
+
 require_relative 'views/mutable_config_view'
 require_relative 'views/mutable_identifiable_collection_view'
 require_relative 'views/mutable_item_view'

data/lib/nanoc/base/views/{item_rep_collection_view.rb → basic_item_rep_collection_view.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nanoc
-  class ItemRepCollectionView < ::Nanoc::View
+  class BasicItemRepCollectionView < ::Nanoc::View
     include Enumerable
 
     class NoSuchItemRepError < ::Nanoc::Error
@@ -23,7 +23,7 @@ module Nanoc
 
     # @api private
     def view_class
-      Nanoc::ItemRepView
+      Nanoc::BasicItemRepView
     end
 
     def to_ary
@@ -53,16 +53,16 @@ module Nanoc
     #
     # @return [nil] if no item rep with the given name was found
     #
-    # @return [Nanoc::ItemRepView] if an item rep with the given name was found
+    # @return [Nanoc::BasicItemRepView] if an item rep with the given name was found
     def [](rep_name)
       case rep_name
       when Symbol
         res = @item_reps.find { |ir| ir.name == rep_name }
         res && view_class.new(res, @context)
       when Integer
-        raise ArgumentError, "expected ItemRepCollectionView#[] to be called with a symbol (you likely want `.reps[:default]` rather than `.reps[#{rep_name}]`)"
+        raise ArgumentError, "expected BasicItemRepCollectionView#[] to be called with a symbol (you likely want `.reps[:default]` rather than `.reps[#{rep_name}]`)"
       else
-        raise ArgumentError, 'expected ItemRepCollectionView#[] to be called with a symbol'
+        raise ArgumentError, 'expected BasicItemRepCollectionView#[] to be called with a symbol'
       end
     end
 
@@ -71,7 +71,7 @@ module Nanoc
     #
     # @param [Symbol] rep_name
     #
-    # @return [Nanoc::ItemRepView]
+    # @return [Nanoc::BasicItemRepView]
     #
     # @raise if no rep was found
     def fetch(rep_name)

data/lib/nanoc/base/views/{item_rep_view.rb → basic_item_rep_view.rb}

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
 module Nanoc
-  class ItemRepView < ::Nanoc::View
+  class BasicItemRepView < ::Nanoc::View
     # @api private
     def initialize(item_rep, context)
       super(context)
       @item_rep = item_rep
     end
 
+    # @abstract
+    def item_view_class
+      Nanoc::BasicItemView
+    end
+
     # @api private
     def unwrap
       @item_rep
@@ -35,19 +40,6 @@ module Nanoc
       @item_rep.name
     end
 
-    # Returns the compiled content.
-    #
-    # @param [String] snapshot The name of the snapshot from which to
-    #   fetch the compiled content. By default, the returned compiled content
-    #   will be the content compiled right before the first layout call (if
-    #   any).
-    #
-    # @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)
-    end
-
     def snapshot?(name)
       @context.dependency_tracker.bounce(unwrap.item, compiled_content: true)
       @item_rep.snapshot?(name)
@@ -69,22 +61,9 @@ module Nanoc
 
     # Returns the item that this item rep belongs to.
     #
-    # @return [Nanoc::ItemWithRepsView]
+    # @return [Nanoc::CompilationItemView]
     def item
-      Nanoc::ItemWithRepsView.new(@item_rep.item, @context)
-    end
-
-    # @api private
-    def raw_path(snapshot: :last)
-      @context.dependency_tracker.bounce(unwrap.item, compiled_content: true)
-
-      res = @item_rep.raw_path(snapshot: snapshot)
-
-      unless @item_rep.compiled?
-        Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(@item_rep))
-      end
-
-      res
+      item_view_class.new(@item_rep.item, @context)
     end
 
     # @api private

data/lib/nanoc/base/views/{item_without_reps_view.rb → basic_item_view.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module Nanoc
-  class ItemWithoutRepsView < ::Nanoc::View
+  class BasicItemView < ::Nanoc::View
     include Nanoc::DocumentViewMixin
 
     # Returns the children of this item. For items with identifiers that have
     # extensions, returns an empty collection.
     #
-    # @return [Enumerable<Nanoc::ItemWithRepsView>]
+    # @return [Enumerable<Nanoc::CompilationItemView>]
     def children
       unless unwrap.identifier.legacy?
         raise Nanoc::Int::Errors::CannotGetParentOrChildrenOfNonLegacyItem.new(unwrap.identifier)
@@ -22,7 +22,7 @@ module Nanoc
     # Returns the parent of this item, if one exists. For items with identifiers
     # that have extensions, returns nil.
     #
-    # @return [Nanoc::ItemWithRepsView] if the item has a parent
+    # @return [Nanoc::CompilationItemView] if the item has a parent
     #
     # @return [nil] if the item has no parent
     def parent

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Nanoc
+  class CompilationItemRepCollectionView < ::Nanoc::BasicItemRepCollectionView
+    # @api private
+    def view_class
+      Nanoc::CompilationItemRepView
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Nanoc
+  class CompilationItemRepView < ::Nanoc::BasicItemRepView
+    # @abstract
+    def item_view_class
+      Nanoc::CompilationItemView
+    end
+
+    # Returns the item rep’s raw path. It includes the path to the output
+    # directory and the full filename.
+    #
+    # @param [Symbol] snapshot The snapshot for which the path should be
+    #   returned.
+    #
+    # @return [String] The item rep’s raw path.
+    def raw_path(snapshot: :last)
+      @context.dependency_tracker.bounce(unwrap.item, compiled_content: true)
+
+      res = @item_rep.raw_path(snapshot: snapshot)
+
+      unless @item_rep.compiled?
+        Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(@item_rep))
+      end
+
+      res
+    end
+
+    # Returns the compiled content.
+    #
+    # @param [String] snapshot The name of the snapshot from which to
+    #   fetch the compiled content. By default, the returned compiled content
+    #   will be the content compiled right before the first layout call (if
+    #   any).
+    #
+    # @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)
+    end
+  end
+end

data/lib/nanoc/base/views/{mixins/with_reps_view_mixin.rb → compilation_item_view.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nanoc
-  module WithRepsViewMixin
+  class CompilationItemView < ::Nanoc::BasicItemView
     # Returns the compiled content.
     #
     # @param [String] rep The name of the representation
@@ -37,9 +37,9 @@ module Nanoc
 
     # Returns the representations of this item.
     #
-    # @return [Nanoc::ItemRepCollectionView]
+    # @return [Nanoc::BasicItemRepCollectionView]
     def reps
-      Nanoc::ItemRepCollectionView.new(@context.reps[unwrap], @context)
+      Nanoc::CompilationItemRepCollectionView.new(@context.reps[unwrap], @context)
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Nanoc
   class ItemCollectionWithRepsView < ::Nanoc::IdentifiableCollectionView
     # @api private
     def view_class
-      Nanoc::ItemWithRepsView
+      Nanoc::CompilationItemView
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Nanoc
   class ItemCollectionWithoutRepsView < ::Nanoc::IdentifiableCollectionView
     # @api private
     def view_class
-      Nanoc::ItemWithoutRepsView
+      Nanoc::BasicItemView
     end
   end
 end

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

@@ -36,7 +36,7 @@ module Nanoc
       disallowed_value_classes = Set.new([
         Nanoc::Int::Item,
         Nanoc::Int::Layout,
-        Nanoc::ItemWithRepsView,
+        Nanoc::CompilationItemView,
         Nanoc::LayoutView,
       ])
       if disallowed_value_classes.include?(value.class)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nanoc
-  class MutableItemView < Nanoc::ItemWithoutRepsView
+  class MutableItemView < Nanoc::BasicItemView
     include Nanoc::MutableDocumentViewMixin
   end
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nanoc
-  class PostCompileItemRepCollectionView < Nanoc::ItemRepCollectionView
+  class PostCompileItemRepCollectionView < Nanoc::BasicItemRepCollectionView
     # @api private
     def view_class
       Nanoc::PostCompileItemRepView