jekyll 3.8.7 → 4.1.0

data/lib/jekyll/page_excerpt.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class PageExcerpt < Excerpt
+    attr_reader :output, :doc
+    alias_method :id, :relative_path
+
+    # The Liquid representation of this instance is simply the rendered output string.
+    alias_method :to_liquid, :output
+
+    def initialize(doc)
+      super
+      self.output = Renderer.new(site, self, site.site_payload).run
+    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

data/lib/jekyll/path_manager.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jekyll
+  # A singleton class that caches frozen instances of path strings returned from its methods.
+  #
+  # NOTE:
+  #   This class exists because `File.join` allocates an Array and returns a new String on every
+  #   call using **the same arguments**. Caching the result means reduced memory usage.
+  #   However, the caches are never flushed so that they can be used even when a site is
+  #   regenerating. The results are frozen to deter mutation of the cached string.
+  #
+  #   Therefore, employ this class only for situations where caching the result is necessary
+  #   for performance reasons.
+  #
+  class PathManager
+    # This class cannot be initialized from outside
+    private_class_method :new
+
+    # Wraps `File.join` to cache the frozen result.
+    # Reassigns `nil`, empty strings and empty arrays to a frozen empty string beforehand.
+    #
+    # Returns a frozen string.
+    def self.join(base, item)
+      base = "" if base.nil? || base.empty?
+      item = "" if item.nil? || item.empty?
+      @join ||= {}
+      @join[base] ||= {}
+      @join[base][item] ||= File.join(base, item).freeze
+    end
+  end
+end

data/lib/jekyll/plugin.rb

@@ -13,7 +13,7 @@ module Jekyll
     #
 
     def self.inherited(const)
-      return catch_inheritance(const) do |const_|
+      catch_inheritance(const) do |const_|
         catch_inheritance(const_)
       end
     end
@@ -23,9 +23,7 @@ module Jekyll
     def self.catch_inheritance(const)
       const.define_singleton_method :inherited do |const_|
         (@children ||= Set.new).add const_
-        if block_given?
-          yield const_
-        end
+        yield const_ if block_given?
       end
     end
 
@@ -48,9 +46,7 @@ module Jekyll
     # Returns the Symbol priority.
     def self.priority(priority = nil)
       @priority ||= nil
-      if priority && PRIORITIES.key?(priority)
-        @priority = priority
-      end
+      @priority = priority if priority && PRIORITIES.key?(priority)
       @priority || :normal
     end
 
@@ -62,9 +58,7 @@ module Jekyll
     #
     # Returns the safety Boolean.
     def self.safe(safe = nil)
-      unless defined?(@safe) && safe.nil?
-        @safe = safe
-      end
+      @safe = safe unless defined?(@safe) && safe.nil?
       @safe || false
     end
 
@@ -74,7 +68,7 @@ module Jekyll
     #
     # Returns -1, 0, 1.
     def self.<=>(other)
-      PRIORITIES[other.priority] <=> PRIORITIES[self.priority]
+      PRIORITIES[other.priority] <=> PRIORITIES[priority]
     end
 
     # Spaceship is priority [higher -> lower]

data/lib/jekyll/plugin_manager.rb

@@ -37,8 +37,10 @@ module Jekyll
     # Returns false only if no dependencies have been specified, otherwise nothing.
     def require_theme_deps
       return false unless site.theme.runtime_dependencies
+
       site.theme.runtime_dependencies.each do |dep|
         next if dep.name == "jekyll"
+
         External.require_with_graceful_fail(dep.name) if plugin_allowed?(dep.name)
       end
     end

data/lib/jekyll/profiler.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class Profiler
+    TERMINAL_TABLE_STYLES = {
+      :alignment     => :right,
+      :border_top    => false,
+      :border_bottom => false,
+    }.freeze
+    private_constant :TERMINAL_TABLE_STYLES
+
+    def self.tabulate(table_rows)
+      require "terminal-table"
+
+      rows   = table_rows.dup
+      header = rows.shift
+      footer = rows.pop
+      output = +"\n"
+
+      table = Terminal::Table.new do |t|
+        t << header
+        t << :separator
+        rows.each { |row| t << row }
+        t << :separator
+        t << footer
+        t.style = TERMINAL_TABLE_STYLES
+        t.align_column(0, :left)
+      end
+
+      output << table.to_s << "\n"
+    end
+
+    def initialize(site)
+      @site = site
+    end
+
+    def profile_process
+      profile_data = { "PHASE" => "TIME" }
+      total_time = 0
+
+      [:reset, :read, :generate, :render, :cleanup, :write].each do |method|
+        start_time = Time.now
+        @site.send(method)
+        end_time = (Time.now - start_time).round(4)
+        profile_data[method.to_s.upcase] = format("%.4f", end_time)
+        total_time += end_time
+      end
+
+      profile_data["TOTAL TIME"] = format("%.4f", total_time)
+
+      Jekyll.logger.info "\nBuild Process Summary:"
+      Jekyll.logger.info Profiler.tabulate(Array(profile_data))
+
+      Jekyll.logger.info "\nSite Render Stats:"
+      @site.print_stats
+    end
+  end
+end

data/lib/jekyll/reader.rb

@@ -14,6 +14,7 @@ module Jekyll
     def read
       @site.layouts = LayoutReader.new(site).read
       read_directories
+      read_included_excludes
       sort_files!
       @site.data = DataReader.new(site).read(site.config["data_dir"])
       CollectionReader.new(site).read
@@ -39,13 +40,21 @@ module Jekyll
 
       return unless File.directory?(base)
 
+      dot_dirs = []
+      dot_pages = []
+      dot_static_files = []
+
       dot = Dir.chdir(base) { filter_entries(Dir.entries("."), base) }
-      dot_dirs = dot.select { |file| File.directory?(@site.in_source_dir(base, file)) }
-      dot_files = (dot - dot_dirs)
-      dot_pages = dot_files.select do |file|
-        Utils.has_yaml_header?(@site.in_source_dir(base, file))
+      dot.each do |entry|
+        file_path = @site.in_source_dir(base, entry)
+        if File.directory?(file_path)
+          dot_dirs << entry
+        elsif Utils.has_yaml_header?(file_path)
+          dot_pages << entry
+        else
+          dot_static_files << entry
+        end
       end
-      dot_static_files = dot_files - dot_pages
 
       retrieve_posts(dir)
       retrieve_dirs(base, dir, dot_dirs)
@@ -61,6 +70,7 @@ module Jekyll
     # Returns nothing.
     def retrieve_posts(dir)
       return if outside_configured_directory?(dir)
+
       site.posts.docs.concat(post_reader.read_posts(dir))
       site.posts.docs.concat(post_reader.read_drafts(dir)) if site.show_drafts
     end
@@ -75,10 +85,8 @@ module Jekyll
     def retrieve_dirs(_base, dir, dot_dirs)
       dot_dirs.each do |file|
         dir_path = site.in_source_dir(dir, file)
-        rel_path = File.join(dir, file)
-        unless @site.dest.chomp("/") == dir_path
-          @site.reader.read_directories(rel_path)
-        end
+        rel_path = PathManager.join(dir, file)
+        @site.reader.read_directories(rel_path) unless @site.dest.chomp("/") == dir_path
       end
     end
 
@@ -126,6 +134,7 @@ module Jekyll
     def get_entries(dir, subfolder)
       base = site.in_source_dir(dir, subfolder)
       return [] unless File.exist?(base)
+
       entries = Dir.chdir(base) { filter_entries(Dir["**/*"], base) }
       entries.delete_if { |e| File.directory?(site.in_source_dir(base, e)) }
     end
@@ -150,5 +159,29 @@ module Jekyll
     def post_reader
       @post_reader ||= PostReader.new(site)
     end
+
+    def read_included_excludes
+      entry_filter = EntryFilter.new(site)
+
+      site.include.each do |entry|
+        next if entry == ".htaccess"
+
+        entry_path = site.in_source_dir(entry)
+        next if File.directory?(entry_path)
+        next if entry_filter.symlink?(entry_path)
+
+        read_included_file(entry_path) if File.file?(entry_path)
+      end
+    end
+
+    def read_included_file(entry_path)
+      dir  = File.dirname(entry_path).sub(site.source, "")
+      file = Array(File.basename(entry_path))
+      if Utils.has_yaml_header?(entry_path)
+        site.pages.concat(PageReader.new(site, dir).read(file))
+      else
+        site.static_files.concat(StaticFileReader.new(site, dir).read(file))
+      end
+    end
   end
 end

data/lib/jekyll/readers/collection_reader.rb

@@ -5,6 +5,7 @@ module Jekyll
     SPECIAL_COLLECTIONS = %w(posts data).freeze
 
     attr_reader :site, :content
+
     def initialize(site)
       @site = site
       @content = {}

data/lib/jekyll/readers/data_reader.rb

@@ -3,6 +3,7 @@
 module Jekyll
   class DataReader
     attr_reader :site, :content
+
     def initialize(site)
       @site = site
       @content = {}
@@ -54,16 +55,14 @@ module Jekyll
     def read_data_file(path)
       case File.extname(path).downcase
       when ".csv"
-        CSV.read(path, {
-          :headers  => true,
-          :encoding => site.config["encoding"],
-        }).map(&:to_hash)
+        CSV.read(path,
+                 :headers  => true,
+                 :encoding => site.config["encoding"]).map(&:to_hash)
       when ".tsv"
-        CSV.read(path, {
-          :col_sep  => "\t",
-          :headers  => true,
-          :encoding => site.config["encoding"],
-        }).map(&:to_hash)
+        CSV.read(path,
+                 :col_sep  => "\t",
+                 :headers  => true,
+                 :encoding => site.config["encoding"]).map(&:to_hash)
       else
         SafeYAML.load_file(path)
       end

data/lib/jekyll/readers/layout_reader.rb

@@ -3,6 +3,7 @@
 module Jekyll
   class LayoutReader
     attr_reader :site
+
     def initialize(site)
       @site = site
       @layouts = {}
@@ -23,7 +24,7 @@ module Jekyll
     end
 
     def layout_directory
-      @layout_directory ||= (layout_directory_in_cwd || layout_directory_inside_source)
+      @layout_directory ||= site.in_source_dir(site.config["layouts_dir"])
     end
 
     def theme_layout_directory
@@ -54,18 +55,8 @@ module Jekyll
 
     def within(directory)
       return unless File.exist?(directory)
-      Dir.chdir(directory) { yield }
-    end
 
-    def layout_directory_inside_source
-      site.in_source_dir(site.config["layouts_dir"])
-    end
-
-    def layout_directory_in_cwd
-      dir = Jekyll.sanitized_path(Dir.pwd, site.config["layouts_dir"])
-      if File.directory?(dir) && !site.safe
-        dir
-      end
+      Dir.chdir(directory) { yield }
     end
   end
 end

data/lib/jekyll/readers/page_reader.rb

@@ -3,20 +3,20 @@
 module Jekyll
   class PageReader
     attr_reader :site, :dir, :unfiltered_content
+
     def initialize(site, dir)
       @site = site
       @dir = dir
       @unfiltered_content = []
     end
 
-    # Read all the files in <source>/<dir>/ for Yaml header and create a new Page
-    # object for each file.
+    # Create a new `Jekyll::Page` object for each entry in a given array.
     #
-    # dir - The String relative path of the directory to read.
+    # files - An array of file names inside `@dir`
     #
-    # Returns an array of static pages.
+    # Returns an array of publishable `Jekyll::Page` objects.
     def read(files)
-      files.map do |page|
+      files.each do |page|
         @unfiltered_content << Page.new(@site, @site.source, @dir, page)
       end
       @unfiltered_content.select { |page| site.publisher.publish?(page) }

data/lib/jekyll/readers/post_reader.rb

@@ -3,6 +3,7 @@
 module Jekyll
   class PostReader
     attr_reader :site, :unfiltered_content
+
     def initialize(site)
       @site = site
     end
@@ -34,19 +35,9 @@ module Jekyll
     #
     # Returns nothing.
     def read_publishable(dir, magic_dir, matcher)
-      read_content(dir, magic_dir, matcher).tap { |docs| docs.each(&:read) }
-        .select do |doc|
-          if doc.content.valid_encoding?
-            site.publisher.publish?(doc).tap do |will_publish|
-              if !will_publish && site.publisher.hidden_in_the_future?(doc)
-                Jekyll.logger.debug "Skipping:", "#{doc.relative_path} has a future date"
-              end
-            end
-          else
-            Jekyll.logger.debug "Skipping:", "#{doc.relative_path} is not valid UTF-8"
-            false
-          end
-        end
+      read_content(dir, magic_dir, matcher)
+        .tap { |docs| docs.each(&:read) }
+        .select { |doc| processable?(doc) }
     end
 
     # Read all the content files from <source>/<dir>/magic_dir
@@ -60,13 +51,35 @@ module Jekyll
     # Returns klass type of content files
     def read_content(dir, magic_dir, matcher)
       @site.reader.get_entries(dir, magic_dir).map do |entry|
-        next unless entry =~ matcher
+        next unless matcher.match?(entry)
+
         path = @site.in_source_dir(File.join(dir, magic_dir, entry))
-        Document.new(path, {
-          :site       => @site,
-          :collection => @site.posts,
-        })
+        Document.new(path,
+                     :site       => @site,
+                     :collection => @site.posts)
       end.reject(&:nil?)
     end
+
+    private
+
+    def processable?(doc)
+      if doc.content.nil?
+        Jekyll.logger.debug "Skipping:", "Content in #{doc.relative_path} is nil"
+        false
+      elsif !doc.content.valid_encoding?
+        Jekyll.logger.debug "Skipping:", "#{doc.relative_path} is not valid UTF-8"
+        false
+      else
+        publishable?(doc)
+      end
+    end
+
+    def publishable?(doc)
+      site.publisher.publish?(doc).tap do |will_publish|
+        if !will_publish && site.publisher.hidden_in_the_future?(doc)
+          Jekyll.logger.warn "Skipping:", "#{doc.relative_path} has a future date"
+        end
+      end
+    end
   end
 end