nanoc-core 4.11.2 → 4.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b7b9df65548c9c0fc675054ce420c5b81c4be85f42fbe68357a69f74b8dfc3
-  data.tar.gz: 668532d1aad92d0775cd521bcc0a17af669e6ccba9431d1e4858eb36e9c8d796
+  metadata.gz: 81268371fca3b0d630f91ce6290ca35c685092b8a0f62ead810cc973d4a24d68
+  data.tar.gz: 101af420b1fcd1701dd3c21392bdf6623121e952d64a3be09eed90ba4dde67b4
 SHA512:
-  metadata.gz: 4eb2feeb52ae3925ae7a877934a595151835939281d3af4a8263b9b54f1ec848255aeb7c68490fb908d0591d3a0eb5378285267b31f7e68c5162a87202fece30
-  data.tar.gz: 24f2f09de0e1d872a7253c9e6bc6f7679934ae78877c70bb0e009853a965abb4c3514bda94350dd4d8c13220205c1eb5b4fced77c29cb7e53b645399c8167f4c
+  metadata.gz: 7b82d40f993402eae07367d4ae9170b3d7ad7fc80013f3f8ab8c42d944a2fa240bb37a01b693f6cfb305490eed65992d14334ecf581bc470550fcd61f5b9be8d
+  data.tar.gz: 3bfe0233488f5c1df56f09af4059031fef6b622a99c8bbd7e23981a1f4aaa48c81854b19854ae086b22e24a6b8ac870d0c07914a67e24edff9f63dd3eb1a36a0

data/lib/nanoc/core/action_provider.rb

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

data/lib/nanoc/core/action_sequence.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ActionSequence
+      include Nanoc::Core::ContractsSupport
+      include Enumerable
+      DDMemoize.activate(self)
+
+      attr_reader :item_rep
+      attr_reader :actions
+
+      def initialize(item_rep, actions: [])
+        @item_rep = item_rep
+        @actions = actions
+      end
+
+      contract C::None => Numeric
+      def size
+        @actions.size
+      end
+
+      contract Numeric => C::Maybe[Nanoc::Core::ProcessingAction]
+      def [](idx)
+        @actions[idx]
+      end
+
+      contract C::None => C::ArrayOf[Nanoc::Core::ProcessingAction]
+      def snapshot_actions
+        @actions.select { |a| a.is_a?(Nanoc::Core::ProcessingActions::Snapshot) }
+      end
+
+      contract C::None => Array
+      def paths
+        snapshot_actions.map { |a| [a.snapshot_names, a.paths] }
+      end
+
+      memoized def serialize
+        serialize_uncached
+      end
+
+      contract C::None => Array
+      def serialize_uncached
+        to_a.map(&:serialize)
+      end
+
+      contract C::Func[Nanoc::Core::ProcessingAction => C::Any] => self
+      def each
+        @actions.each { |a| yield(a) }
+        self
+      end
+
+      contract C::Func[Nanoc::Core::ProcessingAction => C::Any] => self
+      def map
+        self.class.new(
+          @item_rep,
+          actions: @actions.map { |a| yield(a) },
+        )
+      end
+    end
+  end
+end

data/lib/nanoc/core/action_sequence_builder.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ActionSequenceBuilder
+      include Nanoc::Core::ContractsSupport
+
+      # Error that is raised when a snapshot with an existing name is made.
+      class CannotCreateMultipleSnapshotsWithSameNameError < ::Nanoc::Core::Error
+        include Nanoc::Core::ContractsSupport
+
+        contract Nanoc::Core::ItemRep, Symbol => C::Any
+        def initialize(rep, snapshot)
+          super("Attempted to create a snapshot with a duplicate name #{snapshot.inspect} for the item rep #{rep}")
+        end
+      end
+
+      def self.build(rep)
+        builder = new(rep)
+        yield(builder)
+        builder.action_sequence
+      end
+
+      def initialize(item_rep)
+        @item_rep = item_rep
+        @actions = []
+      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::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::Core::ProcessingActions::Snapshot.new([snapshot_name], path ? [path] : [])
+        self
+      end
+
+      contract C::None => Nanoc::Core::ActionSequence
+      def action_sequence
+        Nanoc::Core::ActionSequence.new(@item_rep, actions: @actions)
+      end
+
+      private
+
+      def will_add_snapshot(name)
+        @_snapshot_names ||= Set.new
+        if @_snapshot_names.include?(name)
+          raise CannotCreateMultipleSnapshotsWithSameNameError.new(@item_rep, name)
+        else
+          @_snapshot_names << name
+        end
+      end
+    end
+  end
+end

data/lib/nanoc/core/checksum_collection.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ChecksumCollection
+      include Nanoc::Core::ContractsSupport
+
+      c_obj = C::Or[Nanoc::Core::Item, Nanoc::Core::Layout, Nanoc::Core::Configuration, Nanoc::Core::CodeSnippet]
+
+      def initialize(checksums)
+        @checksums = checksums
+      end
+
+      contract c_obj => C::Maybe[String]
+      def checksum_for(obj)
+        @checksums[obj.reference]
+      end
+
+      contract c_obj => C::Maybe[String]
+      def content_checksum_for(obj)
+        @checksums[[obj.reference, :content]]
+      end
+
+      contract c_obj => C::Maybe[C::HashOf[Symbol, String]]
+      def attributes_checksum_for(obj)
+        @checksums[[obj.reference, :each_attribute]]
+      end
+
+      def to_h
+        @checksums
+      end
+    end
+  end
+end

data/lib/nanoc/core/document.rb

@@ -8,11 +8,6 @@ module Nanoc
       # @return [Nanoc::Core::Content]
       attr_reader :content
 
-      # @return [Hash]
-      def attributes
-        @attributes.value
-      end
-
       # @return [Nanoc::Core::Identifier]
       attr_reader :identifier
 
@@ -56,6 +51,11 @@ module Nanoc
         @attributes_checksum_data = attributes_checksum_data
       end
 
+      # @return [Hash]
+      def attributes
+        @attributes.value
+      end
+
       contract C::None => self
       # @return [void]
       def freeze

data/lib/nanoc/core/instrumentor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    # @api private
+    class Instrumentor
+      def self.call(key, *args)
+        stopwatch = DDMetrics::Stopwatch.new
+        stopwatch.start
+        yield
+      ensure
+        stopwatch.stop
+        Nanoc::Core::NotificationCenter.post(key, stopwatch.duration, *args)
+      end
+    end
+  end
+end

data/lib/nanoc/core/textual_content.rb

@@ -3,17 +3,17 @@
 module Nanoc
   module Core
     class TextualContent < Content
-      contract C::None => String
-      def string
-        @string.value
-      end
-
       contract C::Or[String, Proc], C::KeywordArgs[filename: C::Optional[C::Maybe[String]]] => C::Any
       def initialize(string, filename: nil)
         super(filename)
         @string = Nanoc::Core::LazyValue.new(string)
       end
 
+      contract C::None => String
+      def string
+        @string.value
+      end
+
       contract C::None => self
       def freeze
         super

data/lib/nanoc/core/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Core
-    VERSION = '4.11.2'
+    VERSION = '4.11.3'
   end
 end

data/lib/nanoc/core.rb

@@ -2,6 +2,7 @@
 
 # Ruby stdlib
 require 'singleton'
+require 'tmpdir'
 
 # External gems
 require 'json_schema'
@@ -11,6 +12,11 @@ require 'ddplugin'
 require 'hamster'
 require 'zeitwerk'
 
+module Nanoc
+  module Core
+  end
+end
+
 DDMemoize.enable_metrics
 
 inflector_class = Class.new(Zeitwerk::Inflector) do
@@ -27,7 +33,8 @@ end
 loader = Zeitwerk::Loader.new
 loader.inflector = inflector_class.new
 loader.push_dir(__dir__ + '/..')
-loader.ignore(File.expand_path('core/core_ext', __dir__))
+loader.ignore(__dir__ + '/../nanoc-core.rb')
+loader.ignore(__dir__ + '/core/core_ext')
 loader.setup
 loader.eager_load
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-core
 version: !ruby/object:Gem::Version
-  version: 4.11.2
+  version: 4.11.3
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ddmemoize
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
 description: Contains the core of Nanoc
 email: denis+rubygems@denis.ws
 executables: []
@@ -104,7 +104,11 @@ files:
 - README.md
 - lib/nanoc-core.rb
 - lib/nanoc/core.rb
+- lib/nanoc/core/action_provider.rb
+- lib/nanoc/core/action_sequence.rb
+- lib/nanoc/core/action_sequence_builder.rb
 - lib/nanoc/core/binary_content.rb
+- lib/nanoc/core/checksum_collection.rb
 - lib/nanoc/core/checksummer.rb
 - lib/nanoc/core/code_snippet.rb
 - lib/nanoc/core/configuration-schema.json
@@ -121,6 +125,7 @@ files:
 - lib/nanoc/core/error.rb
 - lib/nanoc/core/identifiable_collection.rb
 - lib/nanoc/core/identifier.rb
+- lib/nanoc/core/instrumentor.rb
 - lib/nanoc/core/item.rb
 - lib/nanoc/core/item_collection.rb
 - lib/nanoc/core/item_rep.rb
@@ -140,7 +145,7 @@ files:
 - lib/nanoc/core/temp_filename_factory.rb
 - lib/nanoc/core/textual_content.rb
 - lib/nanoc/core/version.rb
-homepage: http://nanoc.ws/
+homepage: https://nanoc.ws/
 licenses:
 - MIT
 metadata: {}
@@ -159,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Core of Nanoc