nanoc 4.11.0 → 4.11.1

data/lib/nanoc/base/entities/layout.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int
-  # @api private
-  class Layout < ::Nanoc::Int::Document
-    def reference
-      "layout:#{identifier}"
-    end
-  end
-end

data/lib/nanoc/base/entities/layout_collection.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int
-  # @api private
-  class LayoutCollection < IdentifiableCollection
-    def initialize(config, objects = [])
-      initialize_basic(config, objects, 'layouts')
-    end
-
-    def reference
-      'layouts'
-    end
-  end
-end

data/lib/nanoc/base/entities/lazy_value.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int
-  # Holds a value that might be generated lazily.
-  #
-  # @api private
-  class LazyValue
-    include Nanoc::Int::ContractsSupport
-
-    # @param [Object, Proc] value_or_proc A value or a proc to generate the value
-    def initialize(value_or_proc)
-      @value = { raw: value_or_proc }
-    end
-
-    # @return [Object] The value, generated when needed
-    def value
-      if @value.key?(:raw)
-        value = @value.delete(:raw)
-        @value[:final] = value.respond_to?(:call) ? value.call : value
-        @value.__nanoc_freeze_recursively if frozen?
-      end
-      @value[:final]
-    end
-
-    contract C::Func[C::Any => C::Any] => self
-    # Returns a new lazy value that will apply the given transformation when the value is requested.
-    #
-    # @yield resolved value
-    #
-    # @return [Nanoc::Int::LazyValue]
-    def map
-      Nanoc::Int::LazyValue.new(-> { yield(value) })
-    end
-
-    contract C::None => self
-    # @return [void]
-    def freeze
-      super
-      @value.__nanoc_freeze_recursively unless @value[:raw]
-      self
-    end
-  end
-end

data/lib/nanoc/base/entities/pattern.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int
-  # @api private
-  class Pattern
-    include Nanoc::Int::ContractsSupport
-
-    contract C::Any => self
-    def self.from(obj)
-      case obj
-      when Nanoc::Int::StringPattern, Nanoc::Int::RegexpPattern
-        obj
-      when String
-        Nanoc::Int::StringPattern.new(obj)
-      when Regexp
-        Nanoc::Int::RegexpPattern.new(obj)
-      when Symbol
-        Nanoc::Int::StringPattern.new(obj.to_s)
-      else
-        raise ArgumentError, "Do not know how to convert `#{obj.inspect}` into a Nanoc::Pattern"
-      end
-    end
-
-    def initialize(_obj)
-      raise NotImplementedError
-    end
-
-    def match?(_identifier)
-      raise NotImplementedError
-    end
-
-    def captures(_identifier)
-      raise NotImplementedError
-    end
-  end
-
-  # @api private
-  class StringPattern < Pattern
-    MATCH_OPTS = File::FNM_PATHNAME | File::FNM_EXTGLOB
-
-    contract String => C::Any
-    def initialize(string)
-      @string = string
-    end
-
-    contract C::Or[Nanoc::Identifier, String] => C::Bool
-    def match?(identifier)
-      File.fnmatch(@string, identifier.to_s, MATCH_OPTS)
-    end
-
-    contract C::Or[Nanoc::Identifier, String] => nil
-    def captures(_identifier)
-      nil
-    end
-
-    contract C::None => String
-    def to_s
-      @string
-    end
-  end
-
-  # @api private
-  class RegexpPattern < Pattern
-    contract Regexp => C::Any
-    def initialize(regexp)
-      @regexp = regexp
-    end
-
-    contract C::Or[Nanoc::Identifier, String] => C::Bool
-    def match?(identifier)
-      (identifier.to_s =~ @regexp) != nil
-    end
-
-    contract C::Or[Nanoc::Identifier, String] => C::Maybe[C::ArrayOf[String]]
-    def captures(identifier)
-      matches = @regexp.match(identifier.to_s)
-      matches&.captures
-    end
-
-    contract C::None => String
-    def to_s
-      @regexp.to_s
-    end
-  end
-end

data/lib/nanoc/base/entities/processing_action.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int
-  class ProcessingAction
-    def serialize
-      raise NotImplementedError.new('Nanoc::ProcessingAction subclasses must implement #serialize and #to_s')
-    end
-
-    def to_s
-      raise NotImplementedError.new('Nanoc::ProcessingAction subclasses must implement #serialize and #to_s')
-    end
-
-    def inspect
-      format(
-        '<%s %s>',
-        self.class.to_s,
-        serialize[1..-1].map(&:inspect).join(', '),
-      )
-    end
-  end
-end

data/lib/nanoc/base/entities/processing_actions.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'processing_actions/filter'
-require_relative 'processing_actions/layout'
-require_relative 'processing_actions/snapshot'

data/lib/nanoc/base/entities/processing_actions/filter.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int::ProcessingActions
-  class Filter < Nanoc::Int::ProcessingAction
-    # filter :foo
-    # filter :foo, params
-
-    attr_reader :filter_name
-    attr_reader :params
-
-    def initialize(filter_name, params)
-      @filter_name = filter_name
-      @params      = params
-    end
-
-    def serialize
-      [:filter, @filter_name, Nanoc::Int::Checksummer.calc(@params)]
-    end
-
-    def to_s
-      "filter #{@filter_name.inspect}, #{@params.inspect}"
-    end
-
-    def hash
-      self.class.hash ^ filter_name.hash ^ params.hash
-    end
-
-    def ==(other)
-      self.class == other.class && filter_name == other.filter_name && params == other.params
-    end
-
-    def eql?(other)
-      self == other
-    end
-  end
-end

data/lib/nanoc/base/entities/processing_actions/layout.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int::ProcessingActions
-  class Layout < Nanoc::Int::ProcessingAction
-    # layout '/foo.erb'
-    # layout '/foo.erb', params
-
-    attr_reader :layout_identifier
-    attr_reader :params
-
-    def initialize(layout_identifier, params)
-      @layout_identifier = layout_identifier
-      @params = params
-    end
-
-    def serialize
-      [:layout, @layout_identifier, Nanoc::Int::Checksummer.calc(@params)]
-    end
-
-    def to_s
-      "layout #{@layout_identifier.inspect}, #{@params.inspect}"
-    end
-
-    def hash
-      self.class.hash ^ layout_identifier.hash ^ params.hash
-    end
-
-    def ==(other)
-      self.class == other.class && layout_identifier == other.layout_identifier && params == other.params
-    end
-
-    def eql?(other)
-      self == other
-    end
-  end
-end

data/lib/nanoc/base/entities/processing_actions/snapshot.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int::ProcessingActions
-  class Snapshot < Nanoc::Int::ProcessingAction
-    # snapshot :before_layout
-    # snapshot :before_layout, path: '/about.md'
-
-    include Nanoc::Int::ContractsSupport
-
-    attr_reader :snapshot_names
-    attr_reader :paths
-
-    contract C::IterOf[Symbol], C::IterOf[String] => C::Any
-    def initialize(snapshot_names, paths)
-      @snapshot_names = snapshot_names
-      @paths = paths
-    end
-
-    contract C::None => Array
-    def serialize
-      [:snapshot, @snapshot_names, true, @paths]
-    end
-
-    contract C::KeywordArgs[snapshot_names: C::Optional[C::IterOf[Symbol]], paths: C::Optional[C::IterOf[String]]] => self
-    def update(snapshot_names: [], paths: [])
-      self.class.new(@snapshot_names + snapshot_names.to_a, @paths + paths.to_a)
-    end
-
-    contract C::None => String
-    def to_s
-      "snapshot #{@snapshot_names.inspect}, paths: #{@paths.inspect}"
-    end
-
-    def hash
-      self.class.hash ^ snapshot_names.hash ^ paths.hash
-    end
-
-    def ==(other)
-      self.class == other.class && snapshot_names == other.snapshot_names && paths == other.paths
-    end
-
-    def eql?(other)
-      self == other
-    end
-  end
-end

data/lib/nanoc/base/entities/snapshot_def.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module Int
-    class SnapshotDef
-      include Nanoc::Int::ContractsSupport
-
-      attr_reader :name
-      attr_reader :binary
-
-      contract Symbol, C::KeywordArgs[binary: C::Optional[C::Bool]] => C::Any
-      def initialize(name, binary:)
-        @name = name
-        @binary = binary
-      end
-
-      def binary?
-        @binary
-      end
-    end
-  end
-end

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

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  # Responsible for loading site data. It is the (abstract) superclass for all
-  # data sources. Subclasses must at least implement the data reading methods
-  # ({#items} and {#layouts}).
-  #
-  # Apart from the methods for loading and storing data, there are the {#up}
-  # and {#down} methods for bringing up and tearing down the connection to the
-  # data source. These should be overridden in subclasses. The {#loading}
-  # method wraps {#up} and {#down}. {#loading} is a convenience method for the
-  # more low-level methods {#use} and {#unuse}, which respectively increment
-  # and decrement the reference count; when the reference count goes from 0 to
-  # 1, the data source will be loaded ({#up} will be called) and when the
-  # reference count goes from 1 to 0, the data source will be unloaded
-  # ({#down} will be called).
-  #
-  # @abstract Subclasses should at least implement {#items} and {#layouts}.
-  class DataSource
-    # @return [String] The root path where items returned by this data source
-    #   should be mounted.
-    attr_reader :items_root
-
-    # @return [String] The root path where layouts returned by this data
-    #   source should be mounted.
-    attr_reader :layouts_root
-
-    # @return [Hash] The configuration for this data source. For example,
-    #   online data sources could contain authentication details.
-    attr_reader :config
-
-    extend DDPlugin::Plugin
-
-    def initialize(site_config, items_root, layouts_root, config)
-      @site_config  = site_config
-      @items_root   = items_root
-      @layouts_root = layouts_root
-      @config       = config || {}
-
-      @references = 0
-    end
-
-    # Marks the data source as used by the caller.
-    #
-    # Calling this method increases the internal reference count. When the
-    # data source is used for the first time (first {#use} call), the data
-    # source will be loaded ({#up} will be called).
-    #
-    # @return [void]
-    def use
-      up if @references.zero?
-      @references += 1
-    end
-
-    # Marks the data source as unused by the caller.
-    #
-    # Calling this method decreases the internal reference count. When the
-    # reference count reaches zero, i.e. when the data source is not used any
-    # more, the data source will be unloaded ({#down} will be called).
-    #
-    # @return [void]
-    def unuse
-      @references -= 1
-      down if @references.zero?
-    end
-
-    # Brings up the connection to the data. Depending on the way data is
-    # stored, this may not be necessary. This is the ideal place to connect to
-    # the database, for example.
-    #
-    # Subclasses may override this method, but are not required to do so; the
-    # default implementation simply does nothing.
-    #
-    # @return [void]
-    def up; end
-
-    # Brings down the connection to the data. This method should undo the
-    # effects of the {#up} method. For example, a database connection
-    # established in {#up} should be closed in this method.
-    #
-    # Subclasses may override this method, but are not required to do so; the
-    # default implementation simply does nothing.
-    #
-    # @return [void]
-    def down; end
-
-    # Returns the collection of items (represented by {Nanoc::Int::Item}) in
-    # this site. The default implementation simply returns an empty array.
-    #
-    # Subclasses should not prepend `items_root` to the item's identifiers, as
-    # this will be done automatically.
-    #
-    # Subclasses may override this method, but are not required to do so; the
-    # default implementation simply does nothing.
-    #
-    # @return [Enumerable] The collection of items
-    def items
-      []
-    end
-
-    # @api private
-    def item_changes
-      warn "Caution: Data source #{self.class.identifier.inspect} does not implement #item_changes; live compilation will not pick up changes in this data source."
-      Enumerator.new { |_y| sleep }
-    end
-
-    # @api private
-    def layout_changes
-      warn "Caution: Data source #{self.class.identifier.inspect} does not implement #layout_changes; live compilation will not pick up changes in this data source."
-      Enumerator.new { |_y| sleep }
-    end
-
-    # Returns the collection of layouts (represented by {Nanoc::Int::Layout}) in
-    # this site. The default implementation simply returns an empty array.
-    #
-    # Subclasses should prepend `layout_root` to the layout's identifiers,
-    # since this is not done automatically.
-    #
-    # Subclasses may override this method, but are not required to do so; the
-    # default implementation simply does nothing.
-    #
-    # @return [Enumerable] The collection of layouts
-    def layouts
-      []
-    end
-
-    # Creates a new in-memory item instance. This is intended for use within
-    # the {#items} method.
-    #
-    # @param [String, Proc] content The uncompiled item content
-    #   (if it is a textual item) or the path to the filename containing the
-    #   content (if it is a binary item).
-    #
-    # @param [Hash, Proc] attributes A hash containing this item's attributes.
-    #
-    # @param [String] identifier This item's identifier.
-    #
-    # @param [Boolean] binary Whether or not this item is binary
-    #
-    # @param [String, nil] checksum_data
-    #
-    # @param [String, nil] content_checksum_data
-    #
-    # @param [String, nil] attributes_checksum_data
-    def new_item(content, attributes, identifier, binary: false, checksum_data: nil, content_checksum_data: nil, attributes_checksum_data: nil)
-      content = Nanoc::Int::Content.create(content, binary: binary)
-      Nanoc::Int::Item.new(content, attributes, identifier, checksum_data: checksum_data, content_checksum_data: content_checksum_data, attributes_checksum_data: attributes_checksum_data)
-    end
-
-    # Creates a new in-memory layout instance. This is intended for use within
-    # the {#layouts} method.
-    #
-    # @param [String] raw_content The raw content of this layout.
-    #
-    # @param [Hash] attributes A hash containing this layout's attributes.
-    #
-    # @param [String] identifier This layout's identifier.
-    #
-    # @param [String, nil] checksum_data
-    #
-    # @param [String, nil] content_checksum_data
-    #
-    # @param [String, nil] attributes_checksum_data
-    def new_layout(raw_content, attributes, identifier, checksum_data: nil, content_checksum_data: nil, attributes_checksum_data: nil)
-      Nanoc::Int::Layout.new(raw_content, attributes, identifier, checksum_data: checksum_data, content_checksum_data: content_checksum_data, attributes_checksum_data: attributes_checksum_data)
-    end
-  end
-end