jekyll 3.9.3 → 4.4.1

data/lib/jekyll/hooks.rb

@@ -22,22 +22,25 @@ module Jekyll
         :post_write  => [],
       },
       :pages     => {
-        :post_init   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
+        :post_init    => [],
+        :pre_render   => [],
+        :post_convert => [],
+        :post_render  => [],
+        :post_write   => [],
       },
       :posts     => {
-        :post_init   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
+        :post_init    => [],
+        :pre_render   => [],
+        :post_convert => [],
+        :post_render  => [],
+        :post_write   => [],
       },
       :documents => {
-        :post_init   => [],
-        :pre_render  => [],
-        :post_render => [],
-        :post_write  => [],
+        :post_init    => [],
+        :pre_render   => [],
+        :post_convert => [],
+        :post_render  => [],
+        :post_write   => [],
       },
       :clean     => {
         :on_obsolete => [],
@@ -60,26 +63,26 @@ module Jekyll
     # 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  => [],
+        :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}"
+        raise NotAvailable, "Invalid hook. #{owner} supports only the following hooks " \
+                            "#{@registry[owner].keys.inspect}"
       end
 
-      unless block.respond_to? :call
-        raise Uncallable, "Hooks must respond to :call"
-      end
+      raise Uncallable, "Hooks must respond to :call" unless block.respond_to? :call
 
       insert_hook owner, event, priority, &block
     end
@@ -92,11 +95,8 @@ module Jekyll
     # 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]
+      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|

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

@@ -4,26 +4,14 @@ module Jekyll
   class Layout
     include Convertible
 
-    # Gets the Site object.
-    attr_reader :site
+    attr_accessor :content, # content of layout
+                  :data,    # the Hash that holds the metadata for this layout
+                  :ext      # extension of layout
 
-    # 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
+    attr_reader :name, # name of layout
+                :path, # path to layout
+                :site, # the Site object
+                :relative_path # path to layout relative to its base
 
     # Initialize a new Layout.
     #
@@ -58,5 +46,10 @@ module Jekyll
     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

@@ -2,7 +2,6 @@
 
 module Jekyll
   module LiquidExtensions
-
     # Lookup a Liquid variable in the given context.
     #
     # context  - the Liquid context in question.
@@ -19,6 +18,5 @@ module Jekyll
 
       lookup || variable
     end
-
   end
 end

data/lib/jekyll/liquid_renderer/file.rb

@@ -10,24 +10,34 @@ module Jekyll
 
       def parse(content)
         measure_time do
-          @template = Liquid::Template.parse(content, :line_numbers => true)
+          @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
-            @template.render(*args)
+            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
-            @template.render!(*args)
+            measure_counts do
+              @template.render!(*args)
+            end
           end
         end
       end
@@ -38,6 +48,17 @@ module Jekyll
 
       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)

data/lib/jekyll/liquid_renderer/table.rb

@@ -1,96 +1,45 @@
 # frozen_string_literal: true
 
 module Jekyll
-  class LiquidRenderer::Table
-    def initialize(stats)
-      @stats = stats
-    end
-
-    def to_s(num_of_rows = 50)
-      data = data_for_table(num_of_rows)
-      widths = table_widths(data)
-      generate_table(data, widths)
-    end
-
-    private
-
-    def generate_table(data, widths)
-      str = String.new("\n")
-
-      table_head = data.shift
-      str << generate_row(table_head, widths)
-      str << generate_table_head_border(table_head, widths)
+  class LiquidRenderer
+    class Table
+      GAUGES = [:count, :bytes, :time].freeze
 
-      data.each do |row_data|
-        str << generate_row(row_data, widths)
+      def initialize(stats)
+        @stats = stats
       end
 
-      str << "\n"
-      str
-    end
-
-    def generate_table_head_border(row_data, widths)
-      str = String.new("")
-
-      row_data.each_index do |cell_index|
-        str << "-" * widths[cell_index]
-        str << "-+-" unless cell_index == row_data.length - 1
+      def to_s(num_of_rows = 50)
+        Jekyll::Profiler.tabulate(data_for_table(num_of_rows))
       end
 
-      str << "\n"
-      str
-    end
+      private
 
-    def generate_row(row_data, widths)
-      str = String.new("")
+      def data_for_table(num_of_rows)
+        sorted = @stats.sort_by { |_, file_stats| -file_stats[:time] }
+        sorted = sorted.slice(0, num_of_rows)
 
-      row_data.each_with_index do |cell_data, cell_index|
-        str << if cell_index.zero?
-                 cell_data.ljust(widths[cell_index], " ")
-               else
-                 cell_data.rjust(widths[cell_index], " ")
-               end
+        table  = [header_labels]
+        sorted.each do |filename, file_stats|
+          row = []
+          row << filename
+          row << file_stats[:count].to_s
+          row << format_bytes(file_stats[:bytes])
+          row << format("%.3f", file_stats[:time])
+          table << row
+        end
 
-        str << " | " unless cell_index == row_data.length - 1
+        table
       end
 
-      str << "\n"
-      str
-    end
-
-    def table_widths(data)
-      widths = []
-
-      data.each do |row|
-        row.each_with_index do |cell, index|
-          widths[index] = [cell.length, widths[index]].compact.max
-        end
+      def header_labels
+        GAUGES.map { |gauge| gauge.to_s.capitalize }.unshift("Filename")
       end
 
-      widths
-    end
-
-    def data_for_table(num_of_rows)
-      sorted = @stats.sort_by { |_, file_stats| -file_stats[:time] }
-      sorted = sorted.slice(0, num_of_rows)
-
-      table = [%w(Filename Count Bytes Time)]
-
-      sorted.each do |filename, file_stats|
-        row = []
-        row << filename
-        row << file_stats[:count].to_s
-        row << format_bytes(file_stats[:bytes])
-        row << format("%.3f", file_stats[:time])
-        table << row
+      def format_bytes(bytes)
+        bytes /= 1024.0
+        format("%.2fK", bytes)
       end
-
-      table
-    end
-
-    def format_bytes(bytes)
-      bytes /= 1024.0
-      format("%.2fK", bytes)
     end
   end
 end

data/lib/jekyll/liquid_renderer.rb

@@ -5,11 +5,6 @@ require_relative "liquid_renderer/table"
 
 module Jekyll
   class LiquidRenderer
-    extend Forwardable
-
-    private def_delegator :@site, :in_source_dir, :source_dir
-    private def_delegator :@site, :in_theme_dir, :theme_dir
-
     def initialize(site)
       @site = site
       Liquid::Template.error_mode = @site.config["liquid"]["error_mode"].to_sym
@@ -18,19 +13,13 @@ module Jekyll
 
     def reset
       @stats = {}
+      @cache = {}
     end
 
     def file(filename)
-      filename.match(filename_regex)
-      filename =
-        if Regexp.last_match(1) == theme_dir("")
-          ::File.join(::File.basename(Regexp.last_match(1)), Regexp.last_match(2))
-        else
-          Regexp.last_match(2)
-        end
+      filename = normalize_path(filename)
       LiquidRenderer::File.new(self, filename).tap do
         @stats[filename] ||= new_profile_hash
-        @stats[filename][:count] += 1
       end
     end
 
@@ -42,6 +31,10 @@ module Jekyll
       @stats[filename][:time] += time
     end
 
+    def increment_count(filename)
+      @stats[filename][:count] += 1
+    end
+
     def stats_table(num_of_rows = 50)
       LiquidRenderer::Table.new(@stats).to_s(num_of_rows)
     end
@@ -50,11 +43,33 @@ module Jekyll
       "#{error.message} in #{path}"
     end
 
+    # A persistent cache to store and retrieve parsed templates based on the filename
+    # via `LiquidRenderer::File#parse`
+    #
+    # It is emptied when `self.reset` is called.
+    def cache
+      @cache ||= {}
+    end
+
     private
 
-    def filename_regex
-      @filename_regex ||= begin
-        %r!\A(#{Regexp.escape(source_dir)}/|#{Regexp.escape(theme_dir.to_s)}/|/*)(.*)!i
+    def normalize_path(filename)
+      @normalize_path ||= {}
+      @normalize_path[filename] ||= begin
+        theme_dir = @site.theme&.root
+        case filename
+        when %r!\A(#{Regexp.escape(@site.source)}/)(?<rest>.*)!io
+          Regexp.last_match(:rest)
+        when %r!(/gems/.*)*/gems/(?<dirname>[^/]+)(?<rest>.*)!,
+             %r!(?<dirname>[^/]+/lib)(?<rest>.*)!
+          "#{Regexp.last_match(:dirname)}#{Regexp.last_match(:rest)}"
+        when theme_dir && %r!\A#{Regexp.escape(theme_dir)}/(?<rest>.*)!io
+          PathManager.join(@site.theme.basename, Regexp.last_match(:rest))
+        when %r!\A/(.*)!
+          Regexp.last_match(1)
+        else
+          filename
+        end
       end
     end
 

data/lib/jekyll/log_adapter.rb

@@ -29,7 +29,9 @@ module Jekyll
     #
     # Returns nothing
     def log_level=(level)
-      writer.level = LOG_LEVELS.fetch(level)
+      writer.level = level if level.is_a?(Integer) && level.between?(0, 3)
+      writer.level = LOG_LEVELS[level] ||
+        raise(ArgumentError, "unknown log level")
       @level = level
     end
 
@@ -41,6 +43,7 @@ module Jekyll
         self.log_level = :debug
       end
       debug "Logging at level:", LOG_LEVELS.key(writer.level).to_s
+      debug "Jekyll Version:", Jekyll::VERSION
     end
 
     # Public: Print a debug message
@@ -141,6 +144,7 @@ module Jekyll
     # the appropriate writer method, e.g. writer.info.
     def write(level_of_message, topic, message = nil, &block)
       return false unless write_message?(level_of_message)
+
       writer.public_send(level_of_message, message(topic, message, &block))
     end
   end

data/lib/jekyll/page.rb

@@ -5,18 +5,15 @@ module Jekyll
     include Convertible
 
     attr_writer :dir
-    attr_accessor :site, :pager
-    attr_accessor :name, :ext, :basename
-    attr_accessor :data, :content, :output
+    attr_accessor :basename, :content, :data, :ext, :name, :output, :pager, :site
 
     alias_method :extname, :ext
 
-    FORWARD_SLASH = "/".freeze
-
     # Attributes for Liquid templates
     ATTRIBUTES_FOR_LIQUID = %w(
       content
       dir
+      excerpt
       name
       path
       url
@@ -49,10 +46,11 @@ module Jekyll
               end
 
       process(name)
-      read_yaml(File.join(base, dir), name)
+      read_yaml(PathManager.join(base, dir), name)
+      generate_excerpt if site.config["page_excerpts"]
 
       data.default_proc = proc do |_, key|
-        site.frontmatter_defaults.find(File.join(dir, name), type, key)
+        site.frontmatter_defaults.find(relative_path, type, key)
       end
 
       Jekyll::Hooks.trigger :pages, :post_init, self
@@ -64,12 +62,7 @@ module Jekyll
     #
     # Returns the String destination directory.
     def dir
-      if url.end_with?(FORWARD_SLASH)
-        url
-      else
-        url_dir = File.dirname(url)
-        url_dir.end_with?(FORWARD_SLASH) ? url_dir : "#{url_dir}/"
-      end
+      url.end_with?("/") ? url : url_dir
     end
 
     # The full path and filename of the post. Defined in the YAML of the post
@@ -97,11 +90,11 @@ module Jekyll
     #
     # Returns the String url.
     def url
-      @url ||= URL.new({
+      @url ||= URL.new(
         :template     => template,
         :placeholders => url_placeholders,
-        :permalink    => permalink,
-      }).to_s
+        :permalink    => permalink
+      ).to_s
     end
 
     # Returns a hash of URL placeholder names (as symbols) mapping to the
@@ -118,10 +111,13 @@ module Jekyll
     #
     # name - The String filename of the page file.
     #
+    # NOTE: `String#gsub` removes all trailing periods (in comparison to `String#chomp`)
     # Returns nothing.
     def process(name)
+      return unless name
+
       self.ext = File.extname(name)
-      self.basename = name[0..-ext.length - 1]
+      self.basename = name[0..-ext.length - 1].gsub(%r!\.*\z!, "")
     end
 
     # Add any necessary layouts to this post
@@ -146,7 +142,7 @@ module Jekyll
 
     # The path to the page source file, relative to the site source
     def relative_path
-      File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).sub(%r!\A\/!, "")
+      @relative_path ||= PathManager.join(@dir, @name).delete_prefix("/")
     end
 
     # Obtain destination path.
@@ -155,15 +151,18 @@ module Jekyll
     #
     # Returns the destination file path String.
     def destination(dest)
-      path = site.in_dest_dir(dest, URL.unescape_path(url))
-      path = File.join(path, "index") if url.end_with?("/")
-      path << output_ext unless path.end_with? output_ext
-      path
+      @destination ||= {}
+      @destination[dest] ||= begin
+        path = site.in_dest_dir(dest, URL.unescape_path(url))
+        path = File.join(path, "index") if url.end_with?("/")
+        path << output_ext unless path.end_with? output_ext
+        path
+      end
     end
 
     # Returns the object as a debug String.
     def inspect
-      "#<Jekyll::Page @name=#{name.inspect}>"
+      "#<#{self.class} @relative_path=#{relative_path.inspect}>"
     end
 
     # Returns the Boolean of whether this Page is HTML or not.
@@ -183,5 +182,34 @@ module Jekyll
     def write?
       true
     end
+
+    def excerpt_separator
+      @excerpt_separator ||= (data["excerpt_separator"] || site.config["excerpt_separator"]).to_s
+    end
+
+    def excerpt
+      return @excerpt if defined?(@excerpt)
+
+      @excerpt = data["excerpt"] ? data["excerpt"].to_s : nil
+    end
+
+    def generate_excerpt?
+      !excerpt_separator.empty? && instance_of?(Jekyll::Page) && html?
+    end
+
+    private
+
+    def generate_excerpt
+      return unless generate_excerpt?
+
+      data["excerpt"] ||= Jekyll::PageExcerpt.new(self)
+    end
+
+    def url_dir
+      @url_dir ||= begin
+        value = File.dirname(url)
+        value.end_with?("/") ? value : "#{value}/"
+      end
+    end
   end
 end

data/lib/jekyll/page_excerpt.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class PageExcerpt < Excerpt
+    attr_reader :doc
+    alias_method :id, :relative_path
+
+    EXCERPT_ATTRIBUTES = (Page::ATTRIBUTES_FOR_LIQUID - %w(excerpt)).freeze
+    private_constant :EXCERPT_ATTRIBUTES
+
+    def to_liquid
+      @to_liquid ||= doc.to_liquid(EXCERPT_ATTRIBUTES)
+    end
+
+    def render_with_liquid?
+      return false if data["render_with_liquid"] == false
+
+      Jekyll::Utils.has_liquid_construct?(content)
+    end
+
+    def inspect
+      "#<#{self.class} id=#{id.inspect}>"
+    end
+  end
+end

data/lib/jekyll/page_without_a_file.rb

@@ -10,9 +10,5 @@ module Jekyll
     def read_yaml(*)
       @data ||= {}
     end
-
-    def inspect
-      "#<Jekyll:PageWithoutAFile @name=#{name.inspect}>"
-    end
   end
 end