nanoc-core 4.11.12 → 4.11.13

data/lib/nanoc/core/compiler_loader.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    # @api private
+    class CompilerLoader
+      def load(site, action_provider: nil)
+        action_sequence_store = Nanoc::Core::ActionSequenceStore.new(config: site.config)
+
+        dependency_store =
+          Nanoc::Core::DependencyStore.new(site.items, site.layouts, site.config)
+
+        objects = site.items.to_a + site.layouts.to_a + site.code_snippets + [site.config]
+
+        checksum_store =
+          Nanoc::Core::ChecksumStore.new(config: site.config, objects: objects)
+
+        action_provider ||= Nanoc::Core::ActionProvider.named(site.config.action_provider).for(site)
+
+        outdatedness_store =
+          Nanoc::Core::OutdatednessStore.new(config: site.config)
+
+        compiled_content_cache =
+          compiled_content_cache_class.new(config: site.config)
+
+        params = {
+          compiled_content_cache: compiled_content_cache,
+          checksum_store: checksum_store,
+          action_sequence_store: action_sequence_store,
+          dependency_store: dependency_store,
+          action_provider: action_provider,
+          outdatedness_store: outdatedness_store,
+        }
+
+        Nanoc::Core::Compiler.new(site, params)
+      end
+
+      def compiled_content_cache_class
+        feature_name = Nanoc::Core::Feature::BINARY_COMPILED_CONTENT_CACHE
+        if Nanoc::Core::Feature.enabled?(feature_name)
+          Nanoc::Core::CompiledContentCache
+        else
+          Nanoc::Core::TextualCompiledContentCache
+        end
+      end
+    end
+  end
+end

data/lib/nanoc/core/config_loader.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    # @api private
+    class ConfigLoader
+      class NoConfigFileFoundError < ::Nanoc::Core::Error
+        def initialize
+          super('No configuration file found')
+        end
+      end
+
+      class NoParentConfigFileFoundError < ::Nanoc::Core::Error
+        def initialize(filename)
+          super("There is no parent configuration file at #{filename}")
+        end
+      end
+
+      class CyclicalConfigFileError < ::Nanoc::Core::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::Core::Feature.enabled?(Nanoc::Core::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::Core::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

data/lib/nanoc/core/config_view.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class ConfigView < ::Nanoc::Core::View
+      # @api private
+      def initialize(config, context)
+        super(context)
+        @config = config
+      end
+
+      # @api private
+      def _unwrap
+        @config
+      end
+
+      # @api private
+      def output_dir
+        @config.output_dir
+      end
+
+      # @see Hash#fetch
+      def fetch(key, fallback = Nanoc::Core::UNDEFINED, &_block)
+        @context.dependency_tracker.bounce(_unwrap, attributes: [key])
+        @config.fetch(key) do
+          if !Nanoc::Core::UNDEFINED.equal?(fallback)
+            fallback
+          elsif block_given?
+            yield(key)
+          else
+            raise KeyError, "key not found: #{key.inspect}"
+          end
+        end
+      end
+
+      # @see Hash#key?
+      def key?(key)
+        @context.dependency_tracker.bounce(_unwrap, attributes: [key])
+        @config.key?(key)
+      end
+
+      # @see Hash#[]
+      def [](key)
+        @context.dependency_tracker.bounce(_unwrap, attributes: [key])
+        @config[key]
+      end
+
+      # @see Hash#each
+      def each(&block)
+        @context.dependency_tracker.bounce(_unwrap, attributes: true)
+        @config.each(&block)
+      end
+
+      # @see Configuration#env_name
+      def env_name
+        @context.dependency_tracker.bounce(_unwrap, attributes: true)
+        @config.env_name
+      end
+
+      # @see Hash#dig
+      def dig(*keys)
+        @context.dependency_tracker.bounce(_unwrap, attributes: keys.take(1))
+        @config.dig(*keys)
+      end
+    end
+  end
+end

data/lib/nanoc/core/configuration.rb

@@ -6,8 +6,6 @@ module Nanoc
     class Configuration
       include Nanoc::Core::ContractsSupport
 
-      NONE = Object.new.freeze
-
       # The default configuration for a data source. A data source's
       # configuration overrides these options.
       DEFAULT_DATA_SOURCE_CONFIG = {
@@ -104,9 +102,9 @@ module Nanoc
       end
 
       contract C::Any, C::Maybe[C::Any], C::Maybe[C::Func[C::None => C::Any]] => C::Any
-      def fetch(key, fallback = NONE, &_block)
+      def fetch(key, fallback = Nanoc::Core::UNDEFINED, &_block)
         @wrapped.fetch(key) do
-          if !fallback.equal?(NONE)
+          if !Nanoc::Core::UNDEFINED.equal?(fallback)
             fallback
           elsif block_given?
             yield(key)

data/lib/nanoc/core/document_view_mixin.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    module DocumentViewMixin
+      # @api private
+      def initialize(document, context)
+        super(context)
+        @document = document
+      end
+
+      # @api private
+      def _unwrap
+        @document
+      end
+
+      # @see Object#==
+      def ==(other)
+        other.respond_to?(:identifier) && identifier == other.identifier
+      end
+
+      # @see Object#eql?
+      def eql?(other)
+        other.is_a?(self.class) && identifier.eql?(other.identifier)
+      end
+
+      # @see Object#hash
+      def hash
+        self.class.hash ^ identifier.hash
+      end
+
+      # @return [Nanoc::Core::Identifier]
+      def identifier
+        _unwrap.identifier
+      end
+
+      # @see Hash#[]
+      def [](key)
+        @context.dependency_tracker.bounce(_unwrap, attributes: [key])
+        _unwrap.attributes[key]
+      end
+
+      # @return [Hash]
+      def attributes
+        # TODO: Refine dependencies
+        @context.dependency_tracker.bounce(_unwrap, attributes: true)
+        _unwrap.attributes
+      end
+
+      # @see Hash#fetch
+      def fetch(key, fallback = Nanoc::Core::UNDEFINED, &_block)
+        @context.dependency_tracker.bounce(_unwrap, attributes: [key])
+
+        if _unwrap.attributes.key?(key)
+          _unwrap.attributes[key]
+        elsif !Nanoc::Core::UNDEFINED.equal?(fallback)
+          fallback
+        elsif block_given?
+          yield(key)
+        else
+          raise KeyError, "key not found: #{key.inspect}"
+        end
+      end
+
+      # @see Hash#key?
+      def key?(key)
+        @context.dependency_tracker.bounce(_unwrap, attributes: [key])
+        _unwrap.attributes.key?(key)
+      end
+
+      # @api private
+      def reference
+        _unwrap.reference
+      end
+
+      # @api private
+      def raw_content
+        @context.dependency_tracker.bounce(_unwrap, raw_content: true)
+        _unwrap.content.string
+      end
+
+      def inspect
+        "<#{self.class} identifier=#{_unwrap.identifier}>"
+      end
+    end
+  end
+end

data/lib/nanoc/core/errors.rb

@@ -24,6 +24,31 @@ module Nanoc
         end
       end
 
+      # Error that is raised when compilation of an item rep fails. The
+      # underlying error is available by calling `#unwrap`.
+      class CompilationError < ::Nanoc::Core::Error
+        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 < ::Nanoc::Core::Error
+        # @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 when an rep cannot be compiled because it depends
       # on other representations.
       class UnmetDependency < ::Nanoc::Core::Error
@@ -44,6 +69,25 @@ module Nanoc
         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 < ::Nanoc::Core::Error
+        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 the compiled content of a binary item is attempted to be accessed.
       class CannotGetCompiledContentOfBinaryItem < ::Nanoc::Core::Error
         # @param [Nanoc::Core::ItemRep] rep The binary item representation whose compiled content was attempted to be accessed
@@ -51,6 +95,59 @@ module Nanoc
           super("You cannot access the compiled content of a binary item representation (but you can access the path). The offending item rep is #{rep}.")
         end
       end
+
+      # Error that is raised when attempting to call #parent or #children on an item with a legacy identifier.
+      class CannotGetParentOrChildrenOfNonLegacyItem < ::Nanoc::Core::Error
+        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
+
+      # Error that is raised during site compilation when an item uses a layout
+      # that is not present in the site.
+      class UnknownLayout < ::Nanoc::Core::Error
+        # @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 when a binary item is attempted to be laid out.
+      class CannotLayoutBinaryItem < ::Nanoc::Core::Error
+        # @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 < ::Nanoc::Core::Error
+        # @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 < ::Nanoc::Core::Error
+        # @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
+
+      class InternalInconsistency < ::Nanoc::Core::Error
+      end
     end
   end
 end

data/lib/nanoc/core/executor.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Core
+    class Executor
+      def initialize(rep, compilation_context, dependency_tracker)
+        @rep = rep
+        @compilation_context = compilation_context
+        @dependency_tracker = dependency_tracker
+      end
+
+      def filter(filter_name, filter_args = {})
+        filter = filter_for_filtering(filter_name)
+
+        begin
+          Nanoc::Core::NotificationCenter.post(:filtering_started, @rep, filter_name)
+
+          # Run filter
+          last = @compilation_context.compiled_content_store.get_current(@rep)
+          source = last.binary? ? last.filename : last.string
+          filter_args.freeze
+          result = filter.setup_and_run(source, filter_args)
+          last =
+            if filter.class.to_binary?
+              Nanoc::Core::BinaryContent.new(filter.output_filename).tap(&:freeze)
+            else
+              Nanoc::Core::TextualContent.new(result).tap(&:freeze)
+            end
+
+          # Store
+          @compilation_context.compiled_content_store.set_current(@rep, last)
+        ensure
+          Nanoc::Core::NotificationCenter.post(:filtering_ended, @rep, filter_name)
+        end
+      end
+
+      def layout(layout_identifier, extra_filter_args = nil)
+        layout = find_layout(layout_identifier)
+        filter_name_and_args = @compilation_context.filter_name_and_args_for_layout(layout)
+        filter_name = filter_name_and_args.name
+        if filter_name.nil?
+          raise ::Nanoc::Core::Error, "Cannot find rule for layout matching #{layout_identifier}"
+        end
+
+        filter_args = filter_name_and_args.args
+        filter_args = filter_args.merge(extra_filter_args || {})
+        filter_args.freeze
+
+        # Check whether item can be laid out
+        last = @compilation_context.compiled_content_store.get_current(@rep)
+        raise Nanoc::Core::Errors::CannotLayoutBinaryItem.new(@rep) if last.binary?
+
+        # Create filter
+        klass = Nanoc::Core::Filter.named!(filter_name)
+        layout_view = Nanoc::Core::LayoutView.new(layout, view_context)
+        filter = klass.new(assigns.merge(layout: layout_view))
+
+        # Visit
+        @dependency_tracker.bounce(layout, raw_content: true)
+
+        begin
+          Nanoc::Core::NotificationCenter.post(:filtering_started, @rep, filter_name)
+
+          # Layout
+          content = layout.content
+          arg = content.binary? ? content.filename : content.string
+          res = filter.setup_and_run(arg, filter_args)
+
+          # Store
+          last = Nanoc::Core::TextualContent.new(res).tap(&:freeze)
+          @compilation_context.compiled_content_store.set_current(@rep, last)
+        ensure
+          Nanoc::Core::NotificationCenter.post(:filtering_ended, @rep, filter_name)
+        end
+      end
+
+      def snapshot(snapshot_name)
+        last = @compilation_context.compiled_content_store.get_current(@rep)
+        @compilation_context.compiled_content_store.set(@rep, snapshot_name, last)
+        Nanoc::Core::NotificationCenter.post(:snapshot_created, @rep, snapshot_name)
+      end
+
+      def assigns
+        view_context.assigns_for(@rep, site: @compilation_context.site)
+      end
+
+      def layouts
+        @compilation_context.site.layouts
+      end
+
+      def find_layout(arg)
+        req_id = arg.__nanoc_cleaned_identifier
+        layout = layouts[req_id]
+        return layout if layout
+
+        if use_globs?
+          pat = Nanoc::Core::Pattern.from(arg)
+          layout = layouts.find { |l| pat.match?(l.identifier) }
+          return layout if layout
+        end
+
+        raise Nanoc::Core::Errors::UnknownLayout.new(arg)
+      end
+
+      def filter_for_filtering(filter_name)
+        klass = Nanoc::Core::Filter.named!(filter_name)
+
+        last = @compilation_context.compiled_content_store.get_current(@rep)
+        if klass.from_binary? && !last.binary?
+          raise Nanoc::Core::Errors::CannotUseBinaryFilter.new(@rep, klass)
+        elsif !klass.from_binary? && last.binary?
+          raise Nanoc::Core::Errors::CannotUseTextualFilter.new(@rep, klass)
+        end
+
+        klass.new(assigns)
+      end
+
+      def use_globs?
+        @compilation_context.site.config[:string_pattern_type] == 'glob'
+      end
+
+      def view_context
+        @_view_context ||=
+          Nanoc::Core::ViewContextForCompilation.new(
+            reps: @compilation_context.reps,
+            items: @compilation_context.site.items,
+            dependency_tracker: @dependency_tracker,
+            compilation_context: @compilation_context,
+            compiled_content_store: @compilation_context.compiled_content_store,
+          )
+      end
+    end
+  end
+end