nanoc-core 4.11.11 → 4.11.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d054faa7611049b1815255844cb5514e8225684890551acec517db27512ade1
-  data.tar.gz: e0e17509d2745fec12f7ecfb04abf863ad0713f7171c272c99bb84a4e0aa8474
+  metadata.gz: bf201905e79de9d9711910668d228863a48b53e13a78694a50122932960d6189
+  data.tar.gz: ffae70af266ec5c189b0d09976bfb9ebada587f5ea1eeb73b12dfeaebeb07d36
 SHA512:
-  metadata.gz: 1c378a5a778cdcec8cdda0fefe6e9fc94ab1c72a843ffc9c7da05f7bb85cc5f8592cd6a84f554ea74695903f51d821edde5621ee9b28e7ed581ae6009cf4ea6c
-  data.tar.gz: 87c8ec712d58e5b1c3c8206011f5177a71865df1abeff9985659968dc96fbe6a4e4235c8de66de843c5b4e23dc94564969cde11826968936206700889baa9b45
+  metadata.gz: bf812e2fc282b019b2d907ee39a84fe7999b2b2f8565139cc442e3ca38cb75949ea70f27b07058ef4bd52af9a1291c0ca73e6db53790e431976a729f6a4dd3c8
+  data.tar.gz: ef670404975dfde21013d6878afbf272e7bd41d7dee120e124cb2c61e37e1ad1f5ac64ccc1f4554f57dcde1d1303cac32ef6e088853d569c24f1c070c72abc7c

data/lib/nanoc/core/compilation_context.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class CompilationContext
+      class FilterNameAndArgs
+        include Nanoc::Core::ContractsSupport
+
+        attr_reader :name
+        attr_reader :args
+
+        contract C::KeywordArgs[name: C::Maybe[Symbol], args: Hash] => C::Any
+        def initialize(name:, args:)
+          @name = name
+          @args = args
+        end
+      end
+
+      class UndefinedFilterForLayoutError < ::Nanoc::Core::Error
+        def initialize(layout)
+          super("There is no filter defined for the layout #{layout.identifier}")
+        end
+      end
+
+      include Nanoc::Core::ContractsSupport
+
+      attr_reader :site
+      attr_reader :reps
+      attr_reader :compiled_content_cache
+      attr_reader :compiled_content_store
+
+      C_COMPILED_CONTENT_CACHE =
+        C::Or[
+          Nanoc::Core::CompiledContentCache,
+          Nanoc::Core::TextualCompiledContentCache,
+          Nanoc::Core::BinaryCompiledContentCache,
+        ]
+
+      contract C::KeywordArgs[
+        action_provider: Nanoc::Core::ActionProvider,
+        reps: Nanoc::Core::ItemRepRepo,
+        site: Nanoc::Core::Site,
+        compiled_content_cache: C_COMPILED_CONTENT_CACHE,
+        compiled_content_store: Nanoc::Core::CompiledContentStore,
+      ] => C::Any
+      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
+
+      contract Nanoc::Core::Layout => FilterNameAndArgs
+      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 UndefinedFilterForLayoutError.new(layout)
+        end
+
+        FilterNameAndArgs.new(name: seq[0].filter_name, args: seq[0].params)
+      end
+    end
+  end
+end

data/lib/nanoc/core/dependency_tracker.rb

@@ -6,10 +6,33 @@ module Nanoc
     class DependencyTracker
       include Nanoc::Core::ContractsSupport
 
-      C_OBJ = C::Or[Nanoc::Core::Item, Nanoc::Core::Layout, Nanoc::Core::Configuration, Nanoc::Core::IdentifiableCollection]
-      C_RAW_CONTENT = C::Or[C::IterOf[C::Or[String, Regexp]], C::Bool]
-      C_ATTR = C::Or[C::IterOf[Symbol], C::Bool]
-      C_ARGS = C::KeywordArgs[raw_content: C::Optional[C_RAW_CONTENT], attributes: C::Optional[C_ATTR], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]]
+      C_OBJ =
+        C::Or[
+          Nanoc::Core::Item,
+          Nanoc::Core::Layout,
+          Nanoc::Core::Configuration,
+          Nanoc::Core::IdentifiableCollection
+        ]
+
+      C_RAW_CONTENT =
+        C::Or[
+          C::IterOf[C::Or[String, Regexp]],
+          C::Bool
+        ]
+
+      C_ATTR =
+        C::Or[
+          C::IterOf[Symbol],
+          C::Bool
+        ]
+
+      C_ARGS =
+        C::KeywordArgs[
+          raw_content: C::Optional[C_RAW_CONTENT],
+          attributes: C::Optional[C_ATTR],
+          compiled_content: C::Optional[C::Bool],
+          path: C::Optional[C::Bool]
+        ]
 
       attr_reader :dependency_store
 

data/lib/nanoc/core/in_memory_data_source.rb

@@ -3,9 +3,12 @@
 module Nanoc
   module Core
     class InMemoryDataSource < Nanoc::Core::DataSource
+      include Nanoc::Core::ContractsSupport
+
       attr_reader :items
       attr_reader :layouts
 
+      contract Nanoc::Core::ItemCollection, Nanoc::Core::LayoutCollection, C::Maybe[Nanoc::Core::DataSource] => C::Any
       def initialize(items, layouts, orig_data_source = nil)
         super({}, '/', '/', {})
 

data/lib/nanoc/core/item_rep_router.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    # Assigns paths to reps.
+    #
+    # @api private
+    class ItemRepRouter
+      include Nanoc::Core::ContractsSupport
+
+      class IdenticalRoutesError < ::Nanoc::Core::Error
+        def initialize(output_path, rep_a, rep_b)
+          super("The item representations #{rep_a} and #{rep_b} are both routed to #{output_path}.")
+        end
+      end
+
+      class RouteWithoutSlashError < ::Nanoc::Core::Error
+        def initialize(output_path, rep)
+          super("The item representation #{rep} is routed to #{output_path}, which does not start with a slash, as required.")
+        end
+      end
+
+      contract Nanoc::Core::ItemRepRepo, Nanoc::Core::ActionProvider, Nanoc::Core::Site => C::Any
+      def initialize(reps, action_provider, site)
+        @reps = reps
+        @action_provider = action_provider
+        @site = site
+      end
+
+      def run
+        action_sequences = {}
+        assigned_paths = {}
+        @reps.each do |rep|
+          # Sigh. We route reps twice, because the first time, the paths might not have converged
+          # yet. This isn’t ideal, but it’s the only way to work around the divergence issues that
+          # I can think of. For details, see
+          # https://github.com/nanoc/nanoc/pull/1085#issuecomment-280628426.
+
+          @action_provider.action_sequence_for(rep).paths.each do |(snapshot_names, paths)|
+            route_rep(rep, paths, snapshot_names, {})
+          end
+
+          seq = @action_provider.action_sequence_for(rep)
+          action_sequences[rep] = seq
+          seq.paths.each do |(snapshot_names, paths)|
+            route_rep(rep, paths, snapshot_names, assigned_paths)
+          end
+
+          # TODO: verify that paths converge
+        end
+
+        action_sequences
+      end
+
+      contract Nanoc::Core::ItemRep, C::IterOf[String], C::IterOf[Symbol], C::HashOf[String => Nanoc::Core::ItemRep] => C::Any
+      def route_rep(rep, paths, snapshot_names, assigned_paths)
+        # Encode
+        paths = paths.map { |path| path.encode('UTF-8') }
+
+        # Validate format
+        paths.each do |path|
+          unless path.start_with?('/')
+            raise RouteWithoutSlashError.new(path, rep)
+          end
+        end
+
+        # Validate uniqueness
+        paths.each do |path|
+          if assigned_paths.include?(path)
+            # TODO: Include snapshot names in error message
+            reps = [assigned_paths[path], rep].sort_by { |r| [r.item.identifier, r.name] }
+            raise IdenticalRoutesError.new(path, *reps)
+          end
+        end
+        paths.each do |path|
+          assigned_paths[path] = rep
+        end
+
+        # Assign
+        snapshot_names.each do |snapshot_name|
+          rep.raw_paths[snapshot_name] = paths.map { |path| @site.config.output_dir + path }
+          rep.paths[snapshot_name] = paths.map { |path| strip_index_filename(path) }
+        end
+      end
+
+      contract String => String
+      def strip_index_filename(basic_path)
+        @site.config[:index_filenames].each do |index_filename|
+          slashed_index_filename = '/' + index_filename
+          if basic_path.end_with?(slashed_index_filename)
+            return basic_path[0..-index_filename.length - 1]
+          end
+        end
+
+        basic_path
+      end
+    end
+  end
+end

data/lib/nanoc/core/processing_actions/filter.rb

@@ -4,6 +4,8 @@ module Nanoc
   module Core
     module ProcessingActions
       class Filter < Nanoc::Core::ProcessingAction
+        # TODO: rename params to args
+
         # filter :foo
         # filter :foo, params
 

data/lib/nanoc/core/store.rb

@@ -49,6 +49,7 @@ module Nanoc
         )
       end
 
+      contract String => String
       def self.tmp_path_prefix(output_dir)
         dir = Digest::SHA1.hexdigest(output_dir)[0..12]
         File.join('tmp', 'nanoc', dir)

data/lib/nanoc/core/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Core
-    VERSION = '4.11.11'
+    VERSION = '4.11.12'
   end
 end

data/lib/nanoc/core/view_context_for_compilation.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ViewContextForCompilation
+      include Nanoc::Core::ContractsSupport
+
+      attr_reader :reps
+      attr_reader :items
+      attr_reader :dependency_tracker
+      attr_reader :compilation_context
+      attr_reader :compiled_content_store
+
+      contract C::KeywordArgs[
+        reps: Nanoc::Core::ItemRepRepo,
+        items: Nanoc::Core::IdentifiableCollection,
+        dependency_tracker: Nanoc::Core::DependencyTracker,
+        compilation_context: Nanoc::Core::CompilationContext,
+        compiled_content_store: Nanoc::Core::CompiledContentStore,
+      ] => C::Any
+      def initialize(reps:, items:, dependency_tracker:, compilation_context:, compiled_content_store:)
+        @reps = reps
+        @items = items
+        @dependency_tracker = dependency_tracker
+        @compilation_context = compilation_context
+        @compiled_content_store = compiled_content_store
+      end
+
+      contract Nanoc::Core::ItemRep, C::KeywordArgs[site: Nanoc::Core::Site] => Hash
+      def assigns_for(rep, site:)
+        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
+
+        content_or_filename_assigns.merge(
+          item: Nanoc::CompilationItemView.new(rep.item, self),
+          rep: Nanoc::CompilationItemRepView.new(rep, self),
+          item_rep: Nanoc::CompilationItemRepView.new(rep, self),
+          items: Nanoc::ItemCollectionWithRepsView.new(site.items, self),
+          layouts: Nanoc::LayoutCollectionView.new(site.layouts, self),
+          config: Nanoc::ConfigView.new(site.config, self),
+        )
+      end
+    end
+  end
+end

data/lib/nanoc/core/view_context_for_pre_compilation.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ViewContextForPreCompilation
+      include Nanoc::Core::ContractsSupport
+
+      attr_reader :items
+      attr_reader :dependency_tracker
+
+      contract C::KeywordArgs[items: Nanoc::Core::IdentifiableCollection] => C::Any
+      def initialize(items:)
+        @items = items
+
+        @dependency_tracker = Nanoc::Core::DependencyTracker::Null.new
+      end
+    end
+  end
+end

data/lib/nanoc/core/view_context_for_shell.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ViewContextForShell
+      include Nanoc::Core::ContractsSupport
+
+      attr_reader :items
+      attr_reader :reps
+      attr_reader :dependency_tracker
+
+      contract C::KeywordArgs[
+        items: Nanoc::Core::IdentifiableCollection,
+        reps: Nanoc::Core::ItemRepRepo,
+      ] => C::Any
+      def initialize(items:, reps:)
+        @items = items
+        @reps = reps
+
+        @dependency_tracker = Nanoc::Core::DependencyTracker::Null.new
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-core
 version: !ruby/object:Gem::Version
-  version: 4.11.11
+  version: 4.11.12
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-07 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ddmemoize
@@ -130,6 +130,7 @@ files:
 - lib/nanoc/core/checksum_store.rb
 - lib/nanoc/core/checksummer.rb
 - lib/nanoc/core/code_snippet.rb
+- lib/nanoc/core/compilation_context.rb
 - lib/nanoc/core/compilation_stage.rb
 - lib/nanoc/core/compiled_content_cache.rb
 - lib/nanoc/core/compiled_content_store.rb
@@ -158,6 +159,7 @@ files:
 - lib/nanoc/core/item_collection.rb
 - lib/nanoc/core/item_rep.rb
 - lib/nanoc/core/item_rep_repo.rb
+- lib/nanoc/core/item_rep_router.rb
 - lib/nanoc/core/layout.rb
 - lib/nanoc/core/layout_collection.rb
 - lib/nanoc/core/lazy_value.rb
@@ -182,6 +184,9 @@ files:
 - lib/nanoc/core/textual_compiled_content_cache.rb
 - lib/nanoc/core/textual_content.rb
 - lib/nanoc/core/version.rb
+- lib/nanoc/core/view_context_for_compilation.rb
+- lib/nanoc/core/view_context_for_pre_compilation.rb
+- lib/nanoc/core/view_context_for_shell.rb
 homepage: https://nanoc.ws/
 licenses:
 - MIT