nanoc 4.11.0 → 4.11.1

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

@@ -1,24 +1,26 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  class InMemDataSource < Nanoc::DataSource
-    attr_reader :items
-    attr_reader :layouts
+module Nanoc
+  module Int
+    class InMemDataSource < Nanoc::DataSource
+      attr_reader :items
+      attr_reader :layouts
 
-    def initialize(items, layouts, orig_data_source = nil)
-      super({}, '/', '/', {})
+      def initialize(items, layouts, orig_data_source = nil)
+        super({}, '/', '/', {})
 
-      @items = items
-      @layouts = layouts
-      @orig_data_source = orig_data_source
-    end
+        @items = items
+        @layouts = layouts
+        @orig_data_source = orig_data_source
+      end
 
-    def item_changes
-      @orig_data_source ? @orig_data_source.item_changes : super
-    end
+      def item_changes
+        @orig_data_source ? @orig_data_source.item_changes : super
+      end
 
-    def layout_changes
-      @orig_data_source ? @orig_data_source.layout_changes : super
+      def layout_changes
+        @orig_data_source ? @orig_data_source.layout_changes : super
+      end
     end
   end
 end

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

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

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

@@ -1,53 +1,55 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  # @api private
-  class OutdatednessStore < ::Nanoc::Int::Store
-    include Nanoc::Int::ContractsSupport
-
-    contract C::KeywordArgs[config: Nanoc::Int::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::Int::ItemRep => C::Bool
-    def include?(obj)
-      @outdated_refs.include?(obj.reference)
-    end
-
-    contract Nanoc::Int::ItemRep => self
-    def add(obj)
-      @outdated_refs << obj.reference
-      self
-    end
-
-    contract Nanoc::Int::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)
+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,29 +1,31 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  class PrefixedDataSource < Nanoc::DataSource
-    def initialize(data_source, items_prefix, layouts_prefix)
-      super({}, '/', '/', {})
+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
+        @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 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 layouts
+        @data_source.layouts.map { |d| d.with_identifier_prefix(@layouts_prefix) }
+      end
 
-    def item_changes
-      @data_source.item_changes
-    end
+      def item_changes
+        @data_source.item_changes
+      end
 
-    def layout_changes
-      @data_source.layout_changes
+      def layout_changes
+        @data_source.layout_changes
+      end
     end
   end
 end

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

@@ -1,100 +1,102 @@
 # frozen_string_literal: true
 
-module Nanoc::Int
-  class SiteLoader
-    def new_from_cwd
-      site_from_config(Nanoc::Int::ConfigLoader.new.new_from_cwd)
-    end
+module Nanoc
+  module Int
+    class SiteLoader
+      def new_from_cwd
+        site_from_config(Nanoc::Int::ConfigLoader.new.new_from_cwd)
+      end
 
-    # @return [Boolean]
-    def self.cwd_is_nanoc_site?
-      Nanoc::Int::ConfigLoader.cwd_is_nanoc_site?
-    end
+      # @return [Boolean]
+      def self.cwd_is_nanoc_site?
+        Nanoc::Int::ConfigLoader.cwd_is_nanoc_site?
+      end
 
-    def gen_data_source_for_config(config)
-      data_sources_to_aggregate =
-        with_data_sources(config) do |data_sources|
-          data_sources.map do |ds|
-            Nanoc::Int::PrefixedDataSource.new(ds, ds.items_root, ds.layouts_root)
+      def gen_data_source_for_config(config)
+        data_sources_to_aggregate =
+          with_data_sources(config) do |data_sources|
+            data_sources.map do |ds|
+              Nanoc::Int::PrefixedDataSource.new(ds, ds.items_root, ds.layouts_root)
+            end
           end
-        end
 
-      Nanoc::Int::AggregateDataSource.new(data_sources_to_aggregate, config)
-    end
+        Nanoc::Int::AggregateDataSource.new(data_sources_to_aggregate, config)
+      end
 
-    private
+      private
 
-    def site_from_config(config)
-      code_snippets = code_snippets_from_config(config)
-      code_snippets.each(&:load)
+      def site_from_config(config)
+        code_snippets = code_snippets_from_config(config)
+        code_snippets.each(&:load)
 
-      data_source = gen_data_source_for_config(config)
+        data_source = gen_data_source_for_config(config)
 
-      Nanoc::Int::Site.new(
-        config: config,
-        code_snippets: code_snippets,
-        data_source: data_source,
-      )
-    end
+        Nanoc::Int::Site.new(
+          config: config,
+          code_snippets: code_snippets,
+          data_source: data_source,
+        )
+      end
 
-    def with_data_sources(config, &_block)
-      data_sources = create_data_sources(config)
+      def with_data_sources(config, &_block)
+        data_sources = create_data_sources(config)
 
-      begin
-        data_sources.each(&:use)
-        yield(data_sources)
-      ensure
-        data_sources.each(&:unuse)
+        begin
+          data_sources.each(&:use)
+          yield(data_sources)
+        ensure
+          data_sources.each(&:unuse)
+        end
       end
-    end
 
-    def create_data_sources(config)
-      config[:data_sources].map do |data_source_hash|
-        # Get data source class
-        data_source_class = Nanoc::DataSource.named(data_source_hash[:type].to_sym)
-        if data_source_class.nil?
-          raise Nanoc::Int::Errors::UnknownDataSource.new(data_source_hash[:type])
-        end
+      def create_data_sources(config)
+        config[:data_sources].map do |data_source_hash|
+          # Get data source class
+          data_source_class = Nanoc::DataSource.named(data_source_hash[:type].to_sym)
+          if data_source_class.nil?
+            raise Nanoc::Int::Errors::UnknownDataSource.new(data_source_hash[:type])
+          end
 
-        # Create data source
-        data_source_class.new(
-          config,
-          data_source_hash[:items_root],
-          data_source_hash[:layouts_root],
-          data_source_hash.merge(data_source_hash[:config] || {}),
-        )
+          # Create data source
+          data_source_class.new(
+            config,
+            data_source_hash[:items_root],
+            data_source_hash[:layouts_root],
+            data_source_hash.merge(data_source_hash[:config] || {}),
+          )
+        end
       end
-    end
 
-    def code_snippets_from_config(config)
-      config[:lib_dirs].flat_map do |lib|
-        Dir["#{lib}/**/*.rb"].sort.map do |filename|
-          Nanoc::Int::CodeSnippet.new(
-            read_code_snippet_contents(filename),
-            filename,
-          )
+      def code_snippets_from_config(config)
+        config[:lib_dirs].flat_map do |lib|
+          Dir["#{lib}/**/*.rb"].sort.map do |filename|
+            Nanoc::Core::CodeSnippet.new(
+              read_code_snippet_contents(filename),
+              filename,
+            )
+          end
         end
       end
-    end
 
-    ENCODING_REGEX = /\A#\s+(-\*-\s+)?(en)?coding: (?<encoding>[^\s]+)(\s+-\*-\s*)?\n{0,2}/.freeze
+      ENCODING_REGEX = /\A#\s+(-\*-\s+)?(en)?coding: (?<encoding>[^\s]+)(\s+-\*-\s*)?\n{0,2}/.freeze
 
-    def encoding_from_magic_comment(raw)
-      match = ENCODING_REGEX.match(raw)
-      match ? match['encoding'] : nil
-    end
+      def encoding_from_magic_comment(raw)
+        match = ENCODING_REGEX.match(raw)
+        match ? match['encoding'] : nil
+      end
 
-    def read_code_snippet_contents(filename)
-      raw = File.read(filename, encoding: 'ASCII-8BIT')
+      def read_code_snippet_contents(filename)
+        raw = File.read(filename, encoding: 'ASCII-8BIT')
 
-      enc = encoding_from_magic_comment(raw)
-      if enc
-        raw = raw.force_encoding(enc).encode('UTF-8').sub(ENCODING_REGEX, '')
-      else
-        raw.force_encoding('UTF-8')
-      end
+        enc = encoding_from_magic_comment(raw)
+        if enc
+          raw = raw.force_encoding(enc).encode('UTF-8').sub(ENCODING_REGEX, '')
+        else
+          raw.force_encoding('UTF-8')
+        end
 
-      raw
+        raw
+      end
     end
   end
 end

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

@@ -1,112 +1,114 @@
 # frozen_string_literal: true
 
-module Nanoc::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::Int::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.
+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.
     #
-    # @param [String] filename The name of the file where data will be loaded
-    #   from and stored to.
+    # 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}.
     #
-    # @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::Int::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
+    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
 
-    # @group Loading and storing data
+      # 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
 
-    # @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
+      def self.tmp_path_prefix(output_dir)
+        dir = Digest::SHA1.hexdigest(output_dir)[0..12]
+        File.join('tmp', 'nanoc', dir)
+      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
+      # @group Loading and storing data
 
-    # 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)
+      # @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
 
-      begin
-        pstore.transaction do
-          return if pstore[:version] != version
+      # @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
 
-          self.data = pstore[:data]
+      # 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
-      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))
+      # 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
+        pstore.transaction do
+          pstore[:data]    = data
+          pstore[:version] = version
+        end
       end
-    end
 
-    private
+      private
 
-    def pstore
-      @pstore ||= PStore.new(filename)
+      def pstore
+        @pstore ||= PStore.new(filename)
+      end
     end
   end
 end