nanoc 4.11.12 → 4.11.17

data/lib/nanoc/base.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-module Nanoc
-  module Int
-  end
-end
-
-require_relative 'base/error'
-require_relative 'base/errors'
-require_relative 'base/changes_stream'
-
-require_relative 'base/feature'
-require_relative 'base/repos'
-require_relative 'base/services'
-require_relative 'base/views'

data/lib/nanoc/base/changes_stream.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class ChangesStream
-    class ChangesListener
-      def initialize(y)
-        @y = y
-      end
-
-      def unknown
-        @y << :unknown
-      end
-
-      def lib
-        @y << :lib
-      end
-
-      def to_stop(&block)
-        if block_given?
-          @to_stop = block
-        else
-          @to_stop
-        end
-      end
-    end
-
-    def initialize(enum: nil)
-      @enum = enum
-      @enum ||=
-        Enumerator.new do |y|
-          @listener = ChangesListener.new(y)
-          yield(@listener)
-        end.lazy
-    end
-
-    def stop
-      @listener&.to_stop&.call
-    end
-
-    def map
-      self.class.new(enum: @enum.map { |e| yield(e) })
-    end
-
-    def to_enum
-      @enum
-    end
-
-    def each
-      @enum.each { |e| yield(e) }
-      nil
-    end
-  end
-end

data/lib/nanoc/base/error.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  # Generic error. Superclass for all Nanoc-specific errors.
-  class Error < ::StandardError
-  end
-end

data/lib/nanoc/base/errors.rb

@@ -1,163 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # Module that contains all Nanoc-specific errors.
-    #
-    # @api private
-    module Errors
-      Generic = ::Nanoc::Error
-
-      UnmetDependency = ::Nanoc::Core::Errors::UnmetDependency
-      NoSuchSnapshot = ::Nanoc::Core::Errors::NoSuchSnapshot
-      CannotGetCompiledContentOfBinaryItem = ::Nanoc::Core::Errors::CannotGetCompiledContentOfBinaryItem
-
-      # Generic trivial error. Superclass for all Nanoc-specific errors that are
-      # considered "trivial", i.e. errors that do not require a full crash report.
-      class GenericTrivial < Generic
-      end
-
-      # Error that is raised when compilation of an item rep fails. The
-      # underlying error is available by calling `#unwrap`.
-      class CompilationError < Generic
-        attr_reader :item_rep
-
-        def initialize(wrapped, item_rep)
-          @wrapped = wrapped
-          @item_rep = item_rep
-        end
-
-        def unwrap
-          @wrapped
-        end
-      end
-
-      # Error that is raised when a site is loaded that uses a data source with
-      # an unknown identifier.
-      class UnknownDataSource < Generic
-        # @param [String] data_source_name The data source name for which no
-        #   data source could be found
-        def initialize(data_source_name)
-          super("The data source specified in the site’s configuration file, “#{data_source_name}”, does not exist.")
-        end
-      end
-
-      # Error that is raised during site compilation when an item uses a layout
-      # that is not present in the site.
-      class UnknownLayout < Generic
-        # @param [String] layout_identifier The layout identifier for which no
-        #   layout could be found
-        def initialize(layout_identifier)
-          super("The site does not have a layout with identifier “#{layout_identifier}”.")
-        end
-      end
-
-      # Error that is raised during site compilation when a layout is compiled
-      # for which the filter cannot be determined. This is similar to the
-      # {UnknownFilter} error, but specific for filters for layouts.
-      class CannotDetermineFilter < Generic
-        # @param [String] layout_identifier The identifier of the layout for
-        #   which the filter could not be determined
-        def initialize(layout_identifier)
-          super("The filter to be used for the “#{layout_identifier}” layout could not be determined. Make sure the layout does have a filter.")
-        end
-      end
-
-      # Error that is raised during site compilation when an item (directly or
-      # indirectly) includes its own item content, leading to endless recursion.
-      class DependencyCycle < Generic
-        def initialize(stack)
-          start_idx = stack.index(stack.last)
-          cycle = stack[start_idx..-2]
-
-          msg_bits = []
-          msg_bits << 'The site cannot be compiled because there is a dependency cycle:'
-          msg_bits << ''
-          cycle.each.with_index do |r, i|
-            msg_bits << "    (#{i + 1}) item #{r.item.identifier}, rep #{r.name.inspect}, uses compiled content of"
-          end
-          msg_bits << msg_bits.pop + ' (1)'
-
-          super(msg_bits.map { |x| x + "\n" }.join(''))
-        end
-      end
-
-      # Error that is raised when no rules file can be found in the current
-      # working directory.
-      class NoRulesFileFound < Generic
-        def initialize
-          super('This site does not have a rules file, which is required for Nanoc sites.')
-        end
-      end
-
-      # Error that is raised when no compilation rule that can be applied to the
-      # current item can be found.
-      class NoMatchingCompilationRuleFound < Generic
-        # @param [Nanoc::Core::Item] item The item for which no compilation rule
-        #   could be found
-        def initialize(item)
-          super("No compilation rules were found for the “#{item.identifier}” item.")
-        end
-      end
-
-      # Error that is raised when no routing rule that can be applied to the
-      # current item can be found.
-      class NoMatchingRoutingRuleFound < Generic
-        # @param [Nanoc::Core::ItemRep] rep The item repiresentation for which no
-        #   routing rule could be found
-        def initialize(rep)
-          super("No routing rules were found for the “#{rep.item.identifier}” item (rep “#{rep.name}”).")
-        end
-      end
-
-      # Error that is raised when a binary item is attempted to be laid out.
-      class CannotLayoutBinaryItem < Generic
-        # @param [Nanoc::Core::ItemRep] rep The item representation that was attempted
-        #   to be laid out
-        def initialize(rep)
-          super("The “#{rep.item.identifier}” item (rep “#{rep.name}”) cannot be laid out because it is a binary item. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.")
-        end
-      end
-
-      # Error that is raised when a textual filter is attempted to be applied to
-      # a binary item representation.
-      class CannotUseTextualFilter < Generic
-        # @param [Nanoc::Core::ItemRep] rep The item representation that was
-        #   attempted to be filtered
-        #
-        # @param [Class] filter_class The filter class that was used
-        def initialize(rep, filter_class)
-          super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because textual filters cannot be used on binary items.")
-        end
-      end
-
-      # Error that is raised when a binary filter is attempted to be applied to
-      # a textual item representation.
-      class CannotUseBinaryFilter < Generic
-        # @param [Nanoc::Core::ItemRep] rep The item representation that was
-        #   attempted to be filtered
-        #
-        # @param [Class] filter_class The filter class that was used
-        def initialize(rep, filter_class)
-          super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.")
-        end
-      end
-
-      # Error that is raised when attempting to call #parent or #children on an item with a legacy identifier.
-      class CannotGetParentOrChildrenOfNonLegacyItem < Generic
-        def initialize(identifier)
-          super("You cannot get the parent or children of an item that has a “full” identifier (#{identifier}). Getting the parent or children of an item is only possible for items that have a legacy identifier.")
-        end
-      end
-
-      class AmbiguousMetadataAssociation < Generic
-        def initialize(content_filenames, meta_filename)
-          super("There are multiple content files (#{content_filenames.sort.join(', ')}) that could match the file containing metadata (#{meta_filename}).")
-        end
-      end
-
-      class InternalInconsistency < Generic
-      end
-    end
-  end
-end

data/lib/nanoc/base/feature.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  # @api private
-  #
-  # @example Defining a feature and checking its enabledness
-  #
-  #     Nanoc::Feature.define('environments', version: '4.3')
-  #     Nanoc::Feature.enabled?(Nanoc::Feature::ENVIRONMENTS)
-  #
-  module Feature
-    # Defines a new feature with the given name, experimental in the given
-    # version. The feature will be made available as a constant with the same
-    # name, in uppercase, on the Nanoc::Feature module.
-    #
-    # @example Defining Nanoc::Feature::ENVIRONMENTS
-    #
-    #     Nanoc::Feature.define('environments', version: '4.3')
-    #
-    # @param name The name of the feature
-    #
-    # @param version The minor version in which the feature is considered
-    #   experimental.
-    #
-    # @return [void]
-    def self.define(name, version:)
-      repo[name] = version
-      const_set(name.upcase, name)
-    end
-
-    # Undefines the feature with the given name. For testing purposes only.
-    #
-    # @param name The name of the feature
-    #
-    # @return [void]
-    #
-    # @private
-    def self.undefine(name)
-      repo.delete(name)
-      remove_const(name.upcase)
-    end
-
-    # @param [String] feature_name
-    #
-    # @return [Boolean] Whether or not the feature with the given name is enabled
-    def self.enabled?(feature_name)
-      enabled_features.include?(feature_name) ||
-        enabled_features.include?('all')
-    end
-
-    # @api private
-    def self.enable(feature_name)
-      raise ArgumentError, 'no block given' unless block_given?
-
-      if enabled?(feature_name)
-        yield
-      else
-        begin
-          enabled_features << feature_name
-          yield
-        ensure
-          enabled_features.delete(feature_name)
-        end
-      end
-    end
-
-    # @api private
-    def self.reset_caches
-      @enabled_features = nil
-    end
-
-    # @api private
-    def self.enabled_features
-      @enabled_features ||= Set.new(ENV.fetch('NANOC_FEATURES', '').split(','))
-    end
-
-    # @api private
-    def self.repo
-      @repo ||= {}
-    end
-
-    # @return [Enumerable<String>] Names of features that still exist, but
-    #   should not be considered as experimental in the current version of
-    #   Nanoc.
-    def self.all_outdated
-      repo.keys.reject do |name|
-        version = repo[name]
-        Nanoc::VERSION.start_with?(version)
-      end
-    end
-  end
-end
-
-# Tracking issue:
-# https://github.com/nanoc/features/issues/24
-Nanoc::Feature.define('live_cmd', version: '4.11')
-
-# Tracking issue:
-# https://github.com/nanoc/features/issues/40
-Nanoc::Feature.define('toml', version: '4.11')
-
-# Tracking issue:
-# https://github.com/nanoc/features/issues/20
-Nanoc::Feature.define('binary_compiled_content_cache', version: '4.11')

data/lib/nanoc/base/repos.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'repos/config_loader'
-require_relative 'repos/site_loader'

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

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    # @api private
-    class ConfigLoader
-      class NoConfigFileFoundError < ::Nanoc::Error
-        def initialize
-          super('No configuration file found')
-        end
-      end
-
-      class NoParentConfigFileFoundError < ::Nanoc::Error
-        def initialize(filename)
-          super("There is no parent configuration file at #{filename}")
-        end
-      end
-
-      class CyclicalConfigFileError < ::Nanoc::Error
-        def initialize(filename)
-          super("The parent configuration file at #{filename} includes one of its descendants")
-        end
-      end
-
-      # @return [Boolean]
-      def self.cwd_is_nanoc_site?
-        !config_filename_for_cwd.nil?
-      end
-
-      # @return [String]
-      def self.config_filename_for_cwd
-        filenames =
-          if Nanoc::Feature.enabled?(Nanoc::Feature::TOML)
-            %w[nanoc.yaml config.yaml nanoc.toml]
-          else
-            %w[nanoc.yaml config.yaml]
-          end
-        candidate = filenames.find { |f| File.file?(f) }
-        candidate && File.expand_path(candidate)
-      end
-
-      def new_from_cwd
-        # Determine path
-        filename = self.class.config_filename_for_cwd
-        raise NoConfigFileFoundError if filename.nil?
-
-        # Read
-        config =
-          apply_parent_config(
-            Nanoc::Core::Configuration.new(
-              hash: load_file(filename),
-              dir: File.dirname(filename),
-            ),
-            [filename],
-          ).with_defaults
-
-        # Load environment
-        config.with_environment
-      end
-
-      def load_file(filename)
-        case File.extname(filename)
-        when '.yaml'
-          YAML.load_file(filename)
-        when '.toml'
-          Tomlrb.load_file(filename)
-        else
-          raise Nanoc::Int::Errors::InternalInconsistency, 'Unhandled config file extension'
-        end
-      end
-
-      # @api private
-      def apply_parent_config(config, processed_paths = [])
-        parent_path = config[:parent_config_file]
-        return config if parent_path.nil?
-
-        # Get absolute path
-        parent_path = File.absolute_path(parent_path, File.dirname(processed_paths.last))
-        unless File.file?(parent_path)
-          raise NoParentConfigFileFoundError.new(parent_path)
-        end
-
-        # Check recursion
-        if processed_paths.include?(parent_path)
-          raise CyclicalConfigFileError.new(parent_path)
-        end
-
-        # Load
-        parent_config = Nanoc::Core::Configuration.new(hash: load_file(parent_path), dir: config.dir)
-        full_parent_config = apply_parent_config(parent_config, processed_paths + [parent_path])
-        full_parent_config.merge(config.without(:parent_config_file))
-      end
-    end
-  end
-end