jekyll 4.0.1 → 4.2.1

data/lib/jekyll/hooks.rb

@@ -1,106 +1,107 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Hooks
-    DEFAULT_PRIORITY = 20
-
-    # compatibility layer for octopress-hooks users
-    PRIORITY_MAP = {
-      :low    => 10,
-      :normal => 20,
-      :high   => 30,
-    }.freeze
-
-    # initial empty hooks
-    @registry = {
-      :site      => {
-        :after_init  => [],
-        :after_reset => [],
-        :post_read   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
-      },
-      :pages     => {
-        :post_init   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
-      },
-      :posts     => {
-        :post_init   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
-      },
-      :documents => {
-        :post_init   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
-      },
-      :clean     => {
-        :on_obsolete => [],
-      },
-    }
-
-    # map of all hooks and their priorities
-    @hook_priority = {}
-
-    NotAvailable = Class.new(RuntimeError)
-    Uncallable = Class.new(RuntimeError)
-
-    # register hook(s) to be called later, public API
-    def self.register(owners, event, priority: DEFAULT_PRIORITY, &block)
-      Array(owners).each do |owner|
-        register_one(owner, event, priority_value(priority), &block)
-      end
-    end
-
-    # Ensure the priority is a Fixnum
-    def self.priority_value(priority)
-      return priority if priority.is_a?(Integer)
-
-      PRIORITY_MAP[priority] || DEFAULT_PRIORITY
-    end
-
-    # register a single hook to be called later, internal API
-    def self.register_one(owner, event, priority, &block)
-      @registry[owner] ||= {
-        :post_init   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
-      }
-
-      unless @registry[owner][event]
-        raise NotAvailable, "Invalid hook. #{owner} supports only the " \
-          "following hooks #{@registry[owner].keys.inspect}"
-      end
-
-      raise Uncallable, "Hooks must respond to :call" unless block.respond_to? :call
-
-      insert_hook owner, event, priority, &block
-    end
-
-    def self.insert_hook(owner, event, priority, &block)
-      @hook_priority[block] = [-priority, @hook_priority.size]
-      @registry[owner][event] << block
-    end
-
-    # interface for Jekyll core components to trigger hooks
-    def self.trigger(owner, event, *args)
-      # proceed only if there are hooks to call
-      return unless @registry[owner]
-      return unless @registry[owner][event]
-
-      # hooks to call for this owner and event
-      hooks = @registry[owner][event]
-
-      # sort and call hooks according to priority and load order
-      hooks.sort_by { |h| @hook_priority[h] }.each do |hook|
-        hook.call(*args)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Hooks
+    DEFAULT_PRIORITY = 20
+
+    # compatibility layer for octopress-hooks users
+    PRIORITY_MAP = {
+      :low    => 10,
+      :normal => 20,
+      :high   => 30,
+    }.freeze
+
+    # initial empty hooks
+    @registry = {
+      :site      => {
+        :after_init  => [],
+        :after_reset => [],
+        :post_read   => [],
+        :pre_render  => [],
+        :post_render => [],
+        :post_write  => [],
+      },
+      :pages     => {
+        :post_init    => [],
+        :pre_render   => [],
+        :post_convert => [],
+        :post_render  => [],
+        :post_write   => [],
+      },
+      :posts     => {
+        :post_init    => [],
+        :pre_render   => [],
+        :post_convert => [],
+        :post_render  => [],
+        :post_write   => [],
+      },
+      :documents => {
+        :post_init    => [],
+        :pre_render   => [],
+        :post_convert => [],
+        :post_render  => [],
+        :post_write   => [],
+      },
+      :clean     => {
+        :on_obsolete => [],
+      },
+    }
+
+    # map of all hooks and their priorities
+    @hook_priority = {}
+
+    NotAvailable = Class.new(RuntimeError)
+    Uncallable = Class.new(RuntimeError)
+
+    # register hook(s) to be called later, public API
+    def self.register(owners, event, priority: DEFAULT_PRIORITY, &block)
+      Array(owners).each do |owner|
+        register_one(owner, event, priority_value(priority), &block)
+      end
+    end
+
+    # Ensure the priority is a Fixnum
+    def self.priority_value(priority)
+      return priority if priority.is_a?(Integer)
+
+      PRIORITY_MAP[priority] || DEFAULT_PRIORITY
+    end
+
+    # register a single hook to be called later, internal API
+    def self.register_one(owner, event, priority, &block)
+      @registry[owner] ||= {
+        :post_init    => [],
+        :pre_render   => [],
+        :post_convert => [],
+        :post_render  => [],
+        :post_write   => [],
+      }
+
+      unless @registry[owner][event]
+        raise NotAvailable, "Invalid hook. #{owner} supports only the " \
+          "following hooks #{@registry[owner].keys.inspect}"
+      end
+
+      raise Uncallable, "Hooks must respond to :call" unless block.respond_to? :call
+
+      insert_hook owner, event, priority, &block
+    end
+
+    def self.insert_hook(owner, event, priority, &block)
+      @hook_priority[block] = [-priority, @hook_priority.size]
+      @registry[owner][event] << block
+    end
+
+    # interface for Jekyll core components to trigger hooks
+    def self.trigger(owner, event, *args)
+      # proceed only if there are hooks to call
+      hooks = @registry.dig(owner, event)
+      return if hooks.nil? || hooks.empty?
+
+      # sort and call hooks according to priority and load order
+      hooks.sort_by { |h| @hook_priority[h] }.each do |hook|
+        hook.call(*args)
+      end
+    end
+  end
+end

data/lib/jekyll/inclusion.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class Inclusion
+    attr_reader :site, :name, :path
+    private :site
+
+    def initialize(site, base, name)
+      @site = site
+      @name = name
+      @path = PathManager.join(base, name)
+    end
+
+    def render(context)
+      @template ||= site.liquid_renderer.file(path).parse(content)
+      @template.render!(context)
+    rescue Liquid::Error => e
+      e.template_name  = path
+      e.markup_context = "included " if e.markup_context.nil?
+      raise e
+    end
+
+    def content
+      @content ||= File.read(path, **site.file_read_opts)
+    end
+
+    def inspect
+      "#{self.class} #{path.inspect}"
+    end
+    alias_method :to_s, :inspect
+  end
+end

data/lib/jekyll/layout.rb

@@ -1,62 +1,67 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class Layout
-    include Convertible
-
-    # Gets the Site object.
-    attr_reader :site
-
-    # Gets the name of this layout.
-    attr_reader :name
-
-    # Gets the path to this layout.
-    attr_reader :path
-
-    # Gets the path to this layout relative to its base
-    attr_reader :relative_path
-
-    # Gets/Sets the extension of this layout.
-    attr_accessor :ext
-
-    # Gets/Sets the Hash that holds the metadata for this layout.
-    attr_accessor :data
-
-    # Gets/Sets the content of this layout.
-    attr_accessor :content
-
-    # Initialize a new Layout.
-    #
-    # site - The Site.
-    # base - The String path to the source.
-    # name - The String filename of the post file.
-    def initialize(site, base, name)
-      @site = site
-      @base = base
-      @name = name
-
-      if site.theme && site.theme.layouts_path.eql?(base)
-        @base_dir = site.theme.root
-        @path = site.in_theme_dir(base, name)
-      else
-        @base_dir = site.source
-        @path = site.in_source_dir(base, name)
-      end
-      @relative_path = @path.sub(@base_dir, "")
-
-      self.data = {}
-
-      process(name)
-      read_yaml(base, name)
-    end
-
-    # Extract information from the layout filename.
-    #
-    # name - The String filename of the layout file.
-    #
-    # Returns nothing.
-    def process(name)
-      self.ext = File.extname(name)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class Layout
+    include Convertible
+
+    # Gets the Site object.
+    attr_reader :site
+
+    # Gets the name of this layout.
+    attr_reader :name
+
+    # Gets the path to this layout.
+    attr_reader :path
+
+    # Gets the path to this layout relative to its base
+    attr_reader :relative_path
+
+    # Gets/Sets the extension of this layout.
+    attr_accessor :ext
+
+    # Gets/Sets the Hash that holds the metadata for this layout.
+    attr_accessor :data
+
+    # Gets/Sets the content of this layout.
+    attr_accessor :content
+
+    # Initialize a new Layout.
+    #
+    # site - The Site.
+    # base - The String path to the source.
+    # name - The String filename of the post file.
+    def initialize(site, base, name)
+      @site = site
+      @base = base
+      @name = name
+
+      if site.theme && site.theme.layouts_path.eql?(base)
+        @base_dir = site.theme.root
+        @path = site.in_theme_dir(base, name)
+      else
+        @base_dir = site.source
+        @path = site.in_source_dir(base, name)
+      end
+      @relative_path = @path.sub(@base_dir, "")
+
+      self.data = {}
+
+      process(name)
+      read_yaml(base, name)
+    end
+
+    # Extract information from the layout filename.
+    #
+    # name - The String filename of the layout file.
+    #
+    # Returns nothing.
+    def process(name)
+      self.ext = File.extname(name)
+    end
+
+    # Returns the object as a debug String.
+    def inspect
+      "#<#{self.class} @path=#{@path.inspect}>"
+    end
+  end
+end

data/lib/jekyll/liquid_extensions.rb

@@ -1,22 +1,22 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module LiquidExtensions
-    # Lookup a Liquid variable in the given context.
-    #
-    # context  - the Liquid context in question.
-    # variable - the variable name, as a string.
-    #
-    # Returns the value of the variable in the context
-    #   or the variable name if not found.
-    def lookup_variable(context, variable)
-      lookup = context
-
-      variable.split(".").each do |value|
-        lookup = lookup[value]
-      end
-
-      lookup || variable
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module LiquidExtensions
+    # Lookup a Liquid variable in the given context.
+    #
+    # context  - the Liquid context in question.
+    # variable - the variable name, as a string.
+    #
+    # Returns the value of the variable in the context
+    #   or the variable name if not found.
+    def lookup_variable(context, variable)
+      lookup = context
+
+      variable.split(".").each do |value|
+        lookup = lookup[value]
+      end
+
+      lookup || variable
+    end
+  end
+end

data/lib/jekyll/liquid_renderer/file.rb

@@ -1,77 +1,77 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class LiquidRenderer
-    class File
-      def initialize(renderer, filename)
-        @renderer = renderer
-        @filename = filename
-      end
-
-      def parse(content)
-        measure_time do
-          @renderer.cache[@filename] ||= Liquid::Template.parse(content, :line_numbers => true)
-        end
-        @template = @renderer.cache[@filename]
-
-        self
-      end
-
-      def render(*args)
-        reset_template_assigns
-
-        measure_time do
-          measure_bytes do
-            measure_counts do
-              @template.render(*args)
-            end
-          end
-        end
-      end
-
-      # This method simply 'rethrows any error' before attempting to render the template.
-      def render!(*args)
-        reset_template_assigns
-
-        measure_time do
-          measure_bytes do
-            measure_counts do
-              @template.render!(*args)
-            end
-          end
-        end
-      end
-
-      def warnings
-        @template.warnings
-      end
-
-      private
-
-      # clear assigns to `Liquid::Template` instance prior to rendering since
-      # `Liquid::Template` instances are cached in Jekyll 4.
-      def reset_template_assigns
-        @template.instance_assigns.clear
-      end
-
-      def measure_counts
-        @renderer.increment_count(@filename)
-        yield
-      end
-
-      def measure_bytes
-        yield.tap do |str|
-          @renderer.increment_bytes(@filename, str.bytesize)
-        end
-      end
-
-      def measure_time
-        before = Time.now
-        yield
-      ensure
-        after = Time.now
-        @renderer.increment_time(@filename, after - before)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class LiquidRenderer
+    class File
+      def initialize(renderer, filename)
+        @renderer = renderer
+        @filename = filename
+      end
+
+      def parse(content)
+        measure_time do
+          @renderer.cache[@filename] ||= Liquid::Template.parse(content, :line_numbers => true)
+        end
+        @template = @renderer.cache[@filename]
+
+        self
+      end
+
+      def render(*args)
+        reset_template_assigns
+
+        measure_time do
+          measure_bytes do
+            measure_counts do
+              @template.render(*args)
+            end
+          end
+        end
+      end
+
+      # This method simply 'rethrows any error' before attempting to render the template.
+      def render!(*args)
+        reset_template_assigns
+
+        measure_time do
+          measure_bytes do
+            measure_counts do
+              @template.render!(*args)
+            end
+          end
+        end
+      end
+
+      def warnings
+        @template.warnings
+      end
+
+      private
+
+      # clear assigns to `Liquid::Template` instance prior to rendering since
+      # `Liquid::Template` instances are cached in Jekyll 4.
+      def reset_template_assigns
+        @template.instance_assigns.clear
+      end
+
+      def measure_counts
+        @renderer.increment_count(@filename)
+        yield
+      end
+
+      def measure_bytes
+        yield.tap do |str|
+          @renderer.increment_bytes(@filename, str.bytesize)
+        end
+      end
+
+      def measure_time
+        before = Time.now
+        yield
+      ensure
+        after = Time.now
+        @renderer.increment_time(@filename, after - before)
+      end
+    end
+  end
+end