jekyll 4.2.1 → 4.3.0

data/lib/jekyll/convertible.rb

@@ -1,257 +1,257 @@
-# frozen_string_literal: true
-
-# Convertible provides methods for converting a pagelike item
-# from a certain type of markup into actual content
-#
-# Requires
-#   self.site -> Jekyll::Site
-#   self.content
-#   self.content=
-#   self.data=
-#   self.ext=
-#   self.output=
-#   self.name
-#   self.path
-#   self.type -> :page, :post or :draft
-
-module Jekyll
-  module Convertible
-    # Returns the contents as a String.
-    def to_s
-      content || ""
-    end
-
-    # Whether the file is published or not, as indicated in YAML front-matter
-    def published?
-      !(data.key?("published") && data["published"] == false)
-    end
-
-    # Read the YAML frontmatter.
-    #
-    # base - The String path to the dir containing the file.
-    # name - The String filename of the file.
-    # opts - optional parameter to File.read, default at site configs
-    #
-    # Returns nothing.
-    # rubocop:disable Metrics/AbcSize
-    def read_yaml(base, name, opts = {})
-      filename = @path || site.in_source_dir(base, name)
-      Jekyll.logger.debug "Reading:", relative_path
-
-      begin
-        self.content = File.read(filename, **Utils.merged_file_read_opts(site, opts))
-        if content =~ Document::YAML_FRONT_MATTER_REGEXP
-          self.content = Regexp.last_match.post_match
-          self.data = SafeYAML.load(Regexp.last_match(1))
-        end
-      rescue Psych::SyntaxError => e
-        Jekyll.logger.warn "YAML Exception reading #{filename}: #{e.message}"
-        raise e if site.config["strict_front_matter"]
-      rescue StandardError => e
-        Jekyll.logger.warn "Error reading file #{filename}: #{e.message}"
-        raise e if site.config["strict_front_matter"]
-      end
-
-      self.data ||= {}
-
-      validate_data! filename
-      validate_permalink! filename
-
-      self.data
-    end
-    # rubocop:enable Metrics/AbcSize
-
-    def validate_data!(filename)
-      unless self.data.is_a?(Hash)
-        raise Errors::InvalidYAMLFrontMatterError,
-              "Invalid YAML front matter in #{filename}"
-      end
-    end
-
-    def validate_permalink!(filename)
-      if self.data["permalink"] == ""
-        raise Errors::InvalidPermalinkError, "Invalid permalink in #{filename}"
-      end
-    end
-
-    # Transform the contents based on the content type.
-    #
-    # Returns the transformed contents.
-    def transform
-      renderer.convert(content)
-    end
-
-    # Determine the extension depending on content_type.
-    #
-    # Returns the String extension for the output file.
-    #   e.g. ".html" for an HTML output file.
-    def output_ext
-      renderer.output_ext
-    end
-
-    # Determine which converter to use based on this convertible's
-    # extension.
-    #
-    # Returns the Converter instance.
-    def converters
-      renderer.converters
-    end
-
-    # Render Liquid in the content
-    #
-    # content - the raw Liquid content to render
-    # payload - the payload for Liquid
-    # info    - the info for Liquid
-    #
-    # Returns the converted content
-    def render_liquid(content, payload, info, path)
-      renderer.render_liquid(content, payload, info, path)
-    end
-
-    # Convert this Convertible's data to a Hash suitable for use by Liquid.
-    #
-    # Returns the Hash representation of this Convertible.
-    def to_liquid(attrs = nil)
-      further_data = \
-        (attrs || self.class::ATTRIBUTES_FOR_LIQUID).each_with_object({}) do |attribute, hsh|
-          hsh[attribute] = send(attribute)
-        end
-
-      Utils.deep_merge_hashes defaults, Utils.deep_merge_hashes(data, further_data)
-    end
-
-    # The type of a document,
-    #   i.e., its classname downcase'd and to_sym'd.
-    #
-    # Returns the type of self.
-    def type
-      :pages if is_a?(Page)
-    end
-
-    # returns the owner symbol for hook triggering
-    def hook_owner
-      :pages if is_a?(Page)
-    end
-
-    # Determine whether the document is an asset file.
-    # Asset files include CoffeeScript files and Sass/SCSS files.
-    #
-    # Returns true if the extname belongs to the set of extensions
-    #   that asset files use.
-    def asset_file?
-      sass_file? || coffeescript_file?
-    end
-
-    # Determine whether the document is a Sass file.
-    #
-    # Returns true if extname == .sass or .scss, false otherwise.
-    def sass_file?
-      Jekyll::Document::SASS_FILE_EXTS.include?(ext)
-    end
-
-    # Determine whether the document is a CoffeeScript file.
-    #
-    # Returns true if extname == .coffee, false otherwise.
-    def coffeescript_file?
-      ext == ".coffee"
-    end
-
-    # Determine whether the file should be rendered with Liquid.
-    #
-    # Returns true if the file has Liquid Tags or Variables, false otherwise.
-    def render_with_liquid?
-      return false if data["render_with_liquid"] == false
-
-      Jekyll::Utils.has_liquid_construct?(content)
-    end
-
-    # Determine whether the file should be placed into layouts.
-    #
-    # Returns false if the document is an asset file or if the front matter
-    #   specifies `layout: none`
-    def place_in_layout?
-      !(asset_file? || no_layout?)
-    end
-
-    # Checks if the layout specified in the document actually exists
-    #
-    # layout - the layout to check
-    #
-    # Returns true if the layout is invalid, false if otherwise
-    def invalid_layout?(layout)
-      !data["layout"].nil? && layout.nil? && !(is_a? Jekyll::Excerpt)
-    end
-
-    # Recursively render layouts
-    #
-    # layouts - a list of the layouts
-    # payload - the payload for Liquid
-    # info    - the info for Liquid
-    #
-    # Returns nothing
-    def render_all_layouts(layouts, payload, info)
-      renderer.layouts = layouts
-      self.output = renderer.place_in_layouts(output, payload, info)
-    ensure
-      @renderer = nil # this will allow the modifications above to disappear
-    end
-
-    # Add any necessary layouts to this convertible document.
-    #
-    # payload - The site payload Drop or Hash.
-    # layouts - A Hash of {"name" => "layout"}.
-    #
-    # Returns nothing.
-    def do_layout(payload, layouts)
-      self.output = renderer.tap do |doc_renderer|
-        doc_renderer.layouts = layouts
-        doc_renderer.payload = payload
-      end.run
-
-      Jekyll.logger.debug "Post-Render Hooks:", relative_path
-      Jekyll::Hooks.trigger hook_owner, :post_render, self
-    ensure
-      @renderer = nil # this will allow the modifications above to disappear
-    end
-
-    # Write the generated page file to the destination directory.
-    #
-    # dest - The String path to the destination dir.
-    #
-    # Returns nothing.
-    def write(dest)
-      path = destination(dest)
-      FileUtils.mkdir_p(File.dirname(path))
-      Jekyll.logger.debug "Writing:", path
-      File.write(path, output, :mode => "wb")
-      Jekyll::Hooks.trigger hook_owner, :post_write, self
-    end
-
-    # Accessor for data properties by Liquid.
-    #
-    # property - The String name of the property to retrieve.
-    #
-    # Returns the String value or nil if the property isn't included.
-    def [](property)
-      if self.class::ATTRIBUTES_FOR_LIQUID.include?(property)
-        send(property)
-      else
-        data[property]
-      end
-    end
-
-    def renderer
-      @renderer ||= Jekyll::Renderer.new(site, self)
-    end
-
-    private
-
-    def defaults
-      @defaults ||= site.frontmatter_defaults.all(relative_path, type)
-    end
-
-    def no_layout?
-      data["layout"] == "none"
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Convertible provides methods for converting a pagelike item
+# from a certain type of markup into actual content
+#
+# Requires
+#   self.site -> Jekyll::Site
+#   self.content
+#   self.content=
+#   self.data=
+#   self.ext=
+#   self.output=
+#   self.name
+#   self.path
+#   self.type -> :page, :post or :draft
+
+module Jekyll
+  module Convertible
+    # Returns the contents as a String.
+    def to_s
+      content || ""
+    end
+
+    # Whether the file is published or not, as indicated in YAML front-matter
+    def published?
+      !(data.key?("published") && data["published"] == false)
+    end
+
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    # opts - optional parameter to File.read, default at site configs
+    #
+    # Returns nothing.
+    # rubocop:disable Metrics/AbcSize
+    def read_yaml(base, name, opts = {})
+      filename = @path || site.in_source_dir(base, name)
+      Jekyll.logger.debug "Reading:", relative_path
+
+      begin
+        self.content = File.read(filename, **Utils.merged_file_read_opts(site, opts))
+        if content =~ Document::YAML_FRONT_MATTER_REGEXP
+          self.content = Regexp.last_match.post_match
+          self.data = SafeYAML.load(Regexp.last_match(1))
+        end
+      rescue Psych::SyntaxError => e
+        Jekyll.logger.warn "YAML Exception reading #{filename}: #{e.message}"
+        raise e if site.config["strict_front_matter"]
+      rescue StandardError => e
+        Jekyll.logger.warn "Error reading file #{filename}: #{e.message}"
+        raise e if site.config["strict_front_matter"]
+      end
+
+      self.data ||= {}
+
+      validate_data! filename
+      validate_permalink! filename
+
+      self.data
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def validate_data!(filename)
+      unless self.data.is_a?(Hash)
+        raise Errors::InvalidYAMLFrontMatterError,
+              "Invalid YAML front matter in #{filename}"
+      end
+    end
+
+    def validate_permalink!(filename)
+      if self.data["permalink"] == ""
+        raise Errors::InvalidPermalinkError, "Invalid permalink in #{filename}"
+      end
+    end
+
+    # Transform the contents based on the content type.
+    #
+    # Returns the transformed contents.
+    def transform
+      renderer.convert(content)
+    end
+
+    # Determine the extension depending on content_type.
+    #
+    # Returns the String extension for the output file.
+    #   e.g. ".html" for an HTML output file.
+    def output_ext
+      renderer.output_ext
+    end
+
+    # Determine which converter to use based on this convertible's
+    # extension.
+    #
+    # Returns the Converter instance.
+    def converters
+      renderer.converters
+    end
+
+    # Render Liquid in the content
+    #
+    # content - the raw Liquid content to render
+    # payload - the payload for Liquid
+    # info    - the info for Liquid
+    #
+    # Returns the converted content
+    def render_liquid(content, payload, info, path)
+      renderer.render_liquid(content, payload, info, path)
+    end
+
+    # Convert this Convertible's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Convertible.
+    def to_liquid(attrs = nil)
+      further_data = \
+        (attrs || self.class::ATTRIBUTES_FOR_LIQUID).each_with_object({}) do |attribute, hsh|
+          hsh[attribute] = send(attribute)
+        end
+
+      Utils.deep_merge_hashes defaults, Utils.deep_merge_hashes(data, further_data)
+    end
+
+    # The type of a document,
+    #   i.e., its classname downcase'd and to_sym'd.
+    #
+    # Returns the type of self.
+    def type
+      :pages if is_a?(Page)
+    end
+
+    # returns the owner symbol for hook triggering
+    def hook_owner
+      :pages if is_a?(Page)
+    end
+
+    # Determine whether the document is an asset file.
+    # Asset files include CoffeeScript files and Sass/SCSS files.
+    #
+    # Returns true if the extname belongs to the set of extensions
+    #   that asset files use.
+    def asset_file?
+      sass_file? || coffeescript_file?
+    end
+
+    # Determine whether the document is a Sass file.
+    #
+    # Returns true if extname == .sass or .scss, false otherwise.
+    def sass_file?
+      Jekyll::Document::SASS_FILE_EXTS.include?(ext)
+    end
+
+    # Determine whether the document is a CoffeeScript file.
+    #
+    # Returns true if extname == .coffee, false otherwise.
+    def coffeescript_file?
+      ext == ".coffee"
+    end
+
+    # Determine whether the file should be rendered with Liquid.
+    #
+    # Returns true if the file has Liquid Tags or Variables, false otherwise.
+    def render_with_liquid?
+      return false if data["render_with_liquid"] == false
+
+      Jekyll::Utils.has_liquid_construct?(content)
+    end
+
+    # Determine whether the file should be placed into layouts.
+    #
+    # Returns false if the document is an asset file or if the front matter
+    #   specifies `layout: none`
+    def place_in_layout?
+      !(asset_file? || no_layout?)
+    end
+
+    # Checks if the layout specified in the document actually exists
+    #
+    # layout - the layout to check
+    #
+    # Returns true if the layout is invalid, false if otherwise
+    def invalid_layout?(layout)
+      !data["layout"].nil? && layout.nil? && !(is_a? Jekyll::Excerpt)
+    end
+
+    # Recursively render layouts
+    #
+    # layouts - a list of the layouts
+    # payload - the payload for Liquid
+    # info    - the info for Liquid
+    #
+    # Returns nothing
+    def render_all_layouts(layouts, payload, info)
+      renderer.layouts = layouts
+      self.output = renderer.place_in_layouts(output, payload, info)
+    ensure
+      @renderer = nil # this will allow the modifications above to disappear
+    end
+
+    # Add any necessary layouts to this convertible document.
+    #
+    # payload - The site payload Drop or Hash.
+    # layouts - A Hash of {"name" => "layout"}.
+    #
+    # Returns nothing.
+    def do_layout(payload, layouts)
+      self.output = renderer.tap do |doc_renderer|
+        doc_renderer.layouts = layouts
+        doc_renderer.payload = payload
+      end.run
+
+      Jekyll.logger.debug "Post-Render Hooks:", relative_path
+      Jekyll::Hooks.trigger hook_owner, :post_render, self
+    ensure
+      @renderer = nil # this will allow the modifications above to disappear
+    end
+
+    # Write the generated page file to the destination directory.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns nothing.
+    def write(dest)
+      path = destination(dest)
+      FileUtils.mkdir_p(File.dirname(path))
+      Jekyll.logger.debug "Writing:", path
+      File.write(path, output, :mode => "wb")
+      Jekyll::Hooks.trigger hook_owner, :post_write, self
+    end
+
+    # Accessor for data properties by Liquid.
+    #
+    # property - The String name of the property to retrieve.
+    #
+    # Returns the String value or nil if the property isn't included.
+    def [](property)
+      if self.class::ATTRIBUTES_FOR_LIQUID.include?(property)
+        send(property)
+      else
+        data[property]
+      end
+    end
+
+    def renderer
+      @renderer ||= Jekyll::Renderer.new(site, self)
+    end
+
+    private
+
+    def defaults
+      @defaults ||= site.frontmatter_defaults.all(relative_path, type)
+    end
+
+    def no_layout?
+      data["layout"] == "none"
+    end
+  end
+end

data/lib/jekyll/data_entry.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class DataEntry
+    attr_accessor :context
+    attr_reader :data
+
+    # Create a Jekyll wrapper for given parsed data object.
+    #
+    #        site - The current Jekyll::Site instance.
+    #    abs_path - Absolute path to the data source file.
+    # parsed_data - Parsed representation of data source file contents.
+    #
+    # Returns nothing.
+    def initialize(site, abs_path, parsed_data)
+      @site = site
+      @path = abs_path
+      @data = parsed_data
+    end
+
+    # Liquid representation of current instance is the parsed data object.
+    #
+    # Mark as a dependency for regeneration here since every renderable object primarily uses the
+    # parsed data object while the parent resource is being rendered by Liquid. Accessing the data
+    # object directly via Ruby interface `#[]()` is outside the scope of regeneration.
+    #
+    # FIXME: Marking as dependency on every call is non-ideal. Optimize at later day.
+    #
+    # Returns the parsed data object.
+    def to_liquid
+      add_regenerator_dependencies if incremental_build?
+      @data
+    end
+
+    # -- Overrides to maintain backwards compatibility --
+
+    # Any missing method will be forwarded to the underlying data object stored in the instance
+    # variable `@data`.
+    def method_missing(method, *args, &block)
+      @data.respond_to?(method) ? @data.send(method, *args, &block) : super
+    end
+
+    def respond_to_missing?(method, *)
+      @data.respond_to?(method) || super
+    end
+
+    def <=>(other)
+      data <=> (other.is_a?(self.class) ? other.data : other)
+    end
+
+    def ==(other)
+      data == (other.is_a?(self.class) ? other.data : other)
+    end
+
+    # Explicitly defined to bypass re-routing from `method_missing` hook for greater performance.
+    #
+    # Returns string representation of parsed data object.
+    def inspect
+      @data.inspect
+    end
+
+    private
+
+    def incremental_build?
+      @incremental = @site.config["incremental"] if @incremental.nil?
+      @incremental
+    end
+
+    def add_regenerator_dependencies
+      page = context.registers[:page]
+      return unless page&.key?("path")
+
+      absolute_path = \
+        if page["collection"]
+          @site.in_source_dir(@site.config["collections_dir"], page["path"])
+        else
+          @site.in_source_dir(page["path"])
+        end
+
+      @site.regenerator.add_dependency(absolute_path, @path)
+    end
+  end
+end

data/lib/jekyll/data_hash.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Jekyll
+  # A class that behaves very similar to Ruby's `Hash` class yet different in how it is handled by
+  # Liquid. This class emulates Hash by delegation instead of inheritance to minimize overridden
+  # methods especially since some Hash methods returns another Hash instance instead of the
+  # subclass instance.
+  class DataHash
+    #
+    # Delegate given (zero-arity) method(s) to the Hash object stored in instance variable
+    # `@registry`.
+    # NOTE: Avoiding the use of `Forwardable` module's `def_delegators` for preventing unnecessary
+    # creation of interim objects on multiple calls.
+    def self.delegate_to_registry(*symbols)
+      symbols.each { |sym| define_method(sym) { @registry.send(sym) } }
+    end
+    private_class_method :delegate_to_registry
+
+    # -- core instance methods --
+
+    attr_accessor :context
+
+    def initialize
+      @registry = {}
+    end
+
+    def [](key)
+      @registry[key].tap do |value|
+        value.context = context if value.respond_to?(:context=)
+      end
+    end
+
+    # `Hash#to_liquid` returns the Hash instance itself.
+    # Mimic that behavior by returning `self` instead of returning the `@registry` variable value.
+    def to_liquid
+      self
+    end
+
+    # -- supplementary instance methods to emulate Hash --
+
+    delegate_to_registry :freeze, :inspect
+
+    def merge(other, &block)
+      merged_registry = @registry.merge(other, &block)
+      dup.tap { |d| d.instance_variable_set(:@registry, merged_registry) }
+    end
+
+    def merge!(other, &block)
+      @registry.merge!(other, &block)
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      @registry.send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, *)
+      @registry.respond_to?(method)
+    end
+  end
+end