nanoc 4.11.8 → 4.11.9

data/lib/nanoc/base/repos/item_rep_repo.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # Stores item reps (in memory).
-    #
-    # @api private
-    class ItemRepRepo
-      include Enumerable
-
-      def initialize
-        @reps = []
-        @reps_by_item = {}
-      end
-
-      def <<(rep)
-        @reps << rep
-
-        @reps_by_item[rep.item] ||= []
-        @reps_by_item[rep.item] << rep
-      end
-
-      def to_a
-        @reps
-      end
-
-      def each(&block)
-        @reps.each(&block)
-        self
-      end
-
-      def [](item)
-        @reps_by_item.fetch(item, [])
-      end
-    end
-  end
-end

data/lib/nanoc/base/repos/outdatedness_store.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # @api private
-    class OutdatednessStore < ::Nanoc::Int::Store
-      include Nanoc::Core::ContractsSupport
-
-      contract C::KeywordArgs[config: Nanoc::Core::Configuration] => C::Any
-      def initialize(config:)
-        super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'outdatedness'), 1)
-
-        @outdated_refs = Set.new
-      end
-
-      contract Nanoc::Core::ItemRep => C::Bool
-      def include?(obj)
-        @outdated_refs.include?(obj.reference)
-      end
-
-      contract Nanoc::Core::ItemRep => self
-      def add(obj)
-        @outdated_refs << obj.reference
-        self
-      end
-
-      contract Nanoc::Core::ItemRep => self
-      def remove(obj)
-        @outdated_refs.delete(obj.reference)
-        self
-      end
-
-      contract C::None => C::Bool
-      def empty?
-        @outdated_refs.empty?
-      end
-
-      contract C::None => self
-      def clear
-        @outdated_refs = Set.new
-        self
-      end
-
-      protected
-
-      def data
-        @outdated_refs
-      end
-
-      def data=(new_data)
-        @outdated_refs = Set.new(new_data)
-      end
-    end
-  end
-end

data/lib/nanoc/base/repos/prefixed_data_source.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    class PrefixedDataSource < Nanoc::DataSource
-      def initialize(data_source, items_prefix, layouts_prefix)
-        super({}, '/', '/', {})
-
-        @data_source = data_source
-        @items_prefix = items_prefix
-        @layouts_prefix = layouts_prefix
-      end
-
-      def items
-        @data_source.items.map { |d| d.with_identifier_prefix(@items_prefix) }
-      end
-
-      def layouts
-        @data_source.layouts.map { |d| d.with_identifier_prefix(@layouts_prefix) }
-      end
-
-      def item_changes
-        @data_source.item_changes
-      end
-
-      def layout_changes
-        @data_source.layout_changes
-      end
-    end
-  end
-end

data/lib/nanoc/base/repos/store.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # An abstract superclass for classes that need to store data to the
-    # filesystem, such as checksums, cached compiled content and dependency
-    # graphs.
-    #
-    # Each store has a version number. When attempting to load data from a store
-    # that has an incompatible version number, no data will be loaded, but
-    # {#version_mismatch_detected} will be called.
-    #
-    # @abstract Subclasses must implement {#data} and {#data=}, and may
-    #   implement {#no_data_found} and {#version_mismatch_detected}.
-    #
-    # @api private
-    class Store
-      include Nanoc::Core::ContractsSupport
-
-      # @return [String] The name of the file where data will be loaded from and
-      #   stored to.
-      attr_reader :filename
-
-      # @return [Numeric] The version number corresponding to the file format
-      #   the data is in. When the file format changes, the version number
-      #   should be incremented.
-      attr_reader :version
-
-      # Creates a new store for the given filename.
-      #
-      # @param [String] filename The name of the file where data will be loaded
-      #   from and stored to.
-      #
-      # @param [Numeric] version The version number corresponding to the file
-      #   format the data is in. When the file format changes, the version
-      #   number should be incremented.
-      def initialize(filename, version)
-        @filename = filename
-        @version  = version
-      end
-
-      # Logic for building tmp path from active environment and store name
-      # @api private
-      contract C::KeywordArgs[config: Nanoc::Core::Configuration, store_name: String] => C::AbsolutePathString
-      def self.tmp_path_for(store_name:, config:)
-        File.absolute_path(
-          File.join(tmp_path_prefix(config.output_dir), store_name),
-          config.dir,
-        )
-      end
-
-      def self.tmp_path_prefix(output_dir)
-        dir = Digest::SHA1.hexdigest(output_dir)[0..12]
-        File.join('tmp', 'nanoc', dir)
-      end
-
-      # @group Loading and storing data
-
-      # @return The data that should be written to the disk
-      #
-      # @abstract This method must be implemented by the subclass.
-      def data
-        raise NotImplementedError.new('Nanoc::Int::Store subclasses must implement #data and #data=')
-      end
-
-      # @param new_data The data that has been loaded from the disk
-      #
-      # @abstract This method must be implemented by the subclass.
-      #
-      # @return [void]
-      def data=(new_data) # rubocop:disable Lint/UnusedMethodArgument
-        raise NotImplementedError.new('Nanoc::Int::Store subclasses must implement #data and #data=')
-      end
-
-      # Loads the data from the filesystem into memory. This method will set the
-      #   loaded data using the {#data=} method.
-      #
-      # @return [void]
-      def load
-        return unless File.file?(filename)
-
-        begin
-          pstore.transaction do
-            return if pstore[:version] != version
-
-            self.data = pstore[:data]
-          end
-        rescue
-          FileUtils.rm_f(filename)
-          load
-        end
-      end
-
-      # Stores the data contained in memory to the filesystem. This method will
-      #   use the {#data} method to fetch the data that should be written.
-      #
-      # @return [void]
-      def store
-        FileUtils.mkdir_p(File.dirname(filename))
-
-        pstore.transaction do
-          pstore[:data]    = data
-          pstore[:version] = version
-        end
-      end
-
-      private
-
-      def pstore
-        @pstore ||= PStore.new(filename)
-      end
-    end
-  end
-end

data/lib/nanoc/base/repos/textual_compiled_content_cache.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # Represents a cache than can be used to store already compiled content,
-    # to prevent it from being needlessly recompiled.
-    #
-    # @api private
-    class TextualCompiledContentCache < ::Nanoc::Int::Store
-      include Nanoc::Core::ContractsSupport
-
-      contract C::KeywordArgs[config: Nanoc::Core::Configuration] => C::Any
-      def initialize(config:)
-        super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'compiled_content'), 2)
-
-        @cache = {}
-      end
-
-      contract Nanoc::Core::ItemRep => C::Maybe[C::HashOf[Symbol => Nanoc::Core::Content]]
-      # Returns the cached compiled content for the given item representation.
-      #
-      # This cached compiled content is a hash where the keys are the snapshot
-      # names, and the values the compiled content at the given snapshot.
-      def [](rep)
-        item_cache = @cache[rep.item.identifier] || {}
-        item_cache[rep.name]
-      end
-
-      contract Nanoc::Core::ItemRep => C::Bool
-      def include?(rep)
-        item_cache = @cache[rep.item.identifier] || {}
-        item_cache.key?(rep.name)
-      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
-      # names, and the values the compiled content at the given snapshot.
-      def []=(rep, content)
-        # FIXME: once the binary content cache is properly enabled (no longer
-        # behind a feature flag), change contract to be TextualContent, rather
-        # than Content.
-
-        @cache[rep.item.identifier] ||= {}
-        @cache[rep.item.identifier][rep.name] = content
-      end
-
-      def prune(items:)
-        item_identifiers = Set.new(items.map(&:identifier))
-
-        @cache.each_key do |key|
-          # TODO: remove unused item reps
-          next if item_identifiers.include?(key)
-
-          @cache.delete(key)
-        end
-      end
-
-      # True if there is cached compiled content available for this item, and
-      # all entries are textual.
-      def full_cache_available?(rep)
-        cache = self[rep]
-        cache ? cache.none? { |_snapshot_name, content| content.binary? } : false
-      end
-
-      protected
-
-      def data
-        @cache
-      end
-
-      def data=(new_data)
-        @cache = {}
-
-        new_data.each_pair do |item_identifier, content_per_rep|
-          @cache[item_identifier] ||= content_per_rep
-        end
-      end
-    end
-  end
-end

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

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # @api private
-    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]]
-
-      class Null
-        include Nanoc::Core::ContractsSupport
-
-        contract C_OBJ, C_ARGS => C::Any
-        def enter(_obj, raw_content: false, attributes: false, compiled_content: false, path: false); end
-
-        contract C_OBJ => C::Any
-        def exit; end
-
-        contract C_OBJ, C_ARGS => C::Any
-        def bounce(_obj, raw_content: false, attributes: false, compiled_content: false, path: false); end
-      end
-
-      attr_reader :dependency_store
-
-      def initialize(dependency_store)
-        @dependency_store = dependency_store
-        @stack = []
-      end
-
-      contract C_OBJ, C_ARGS => C::Any
-      def enter(obj, raw_content: false, attributes: false, compiled_content: false, path: false)
-        unless @stack.empty?
-          Nanoc::Core::NotificationCenter.post(:dependency_created, @stack.last, obj)
-          @dependency_store.record_dependency(
-            @stack.last,
-            obj,
-            raw_content: raw_content,
-            attributes: attributes,
-            compiled_content: compiled_content,
-            path: path,
-          )
-        end
-
-        @stack.push(obj)
-      end
-
-      contract C_OBJ => C::Any
-      def exit
-        @stack.pop
-      end
-
-      contract C_OBJ, C_ARGS => C::Any
-      def bounce(obj, raw_content: false, attributes: false, compiled_content: false, path: false)
-        enter(obj, raw_content: raw_content, attributes: attributes, compiled_content: compiled_content, path: path)
-        exit
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # @api private
-    class OutdatednessRule
-      include Nanoc::Core::ContractsSupport
-      include Singleton
-
-      def call(obj, outdatedness_checker)
-        Nanoc::Core::Instrumentor.call(:outdatedness_rule_ran, self.class) do
-          apply(obj, outdatedness_checker)
-        end
-      end
-
-      def apply(_obj, _outdatedness_checker)
-        raise NotImplementedError.new('Nanoc::Int::OutdatednessRule subclasses must implement #apply')
-      end
-
-      contract C::None => String
-      def inspect
-        "#{self.class.name}(#{reason})"
-      end
-
-      def self.affects_props(*names)
-        @affected_props = Set.new(names)
-      end
-
-      def self.affected_props
-        @affected_props
-      end
-    end
-  end
-end