jekyll 4.0.0.pre.beta1 → 4.2.0

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/path_manager.rb

@@ -16,16 +16,59 @@ module Jekyll
     # 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
+    class << self
+      # 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 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
+
+      # Ensures the questionable path is prefixed with the base directory
+      # and prepends the questionable path with the base directory if false.
+      #
+      # Returns a frozen string.
+      def sanitized_path(base_directory, questionable_path)
+        @sanitized_path ||= {}
+        @sanitized_path[base_directory] ||= {}
+        @sanitized_path[base_directory][questionable_path] ||= begin
+          if questionable_path.nil?
+            base_directory.freeze
+          else
+            sanitize_and_join(base_directory, questionable_path).freeze
+          end
+        end
+      end
+
+      private
+
+      def sanitize_and_join(base_directory, questionable_path)
+        clean_path = if questionable_path.start_with?("~")
+                       questionable_path.dup.insert(0, "/")
+                     else
+                       questionable_path
+                     end
+        clean_path = File.expand_path(clean_path, "/")
+        return clean_path if clean_path.eql?(base_directory)
+
+        # remove any remaining extra leading slashes not stripped away by calling
+        # `File.expand_path` above.
+        clean_path.squeeze!("/")
+        return clean_path if clean_path.start_with?(slashed_dir_cache(base_directory))
+
+        clean_path.sub!(%r!\A\w:/!, "/")
+        join(base_directory, clean_path)
+      end
+
+      def slashed_dir_cache(base_directory)
+        @slashed_dir_cache ||= {}
+        @slashed_dir_cache[base_directory] ||= base_directory.sub(%r!\z!, "/")
+      end
     end
   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

@@ -164,8 +164,6 @@ module Jekyll
       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)
@@ -175,13 +173,20 @@ module Jekyll
     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))
+        conditionally_generate_entry(entry_path, site.pages, PageReader)
       else
-        site.static_files.concat(StaticFileReader.new(site, dir).read(file))
+        conditionally_generate_entry(entry_path, site.static_files, StaticFileReader)
       end
     end
+
+    def conditionally_generate_entry(entry_path, container, reader)
+      return if container.find { |item| site.in_source_dir(item.relative_path) == entry_path }
+
+      dir, files = File.split(entry_path)
+      dir.sub!(site.source, "")
+      files = Array(files)
+      container.concat(reader.new(site, dir).read(files))
+    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,10 +3,12 @@
 module Jekyll
   class DataReader
     attr_reader :site, :content
+
     def initialize(site)
       @site = site
       @content = {}
       @entry_filter = EntryFilter.new(site)
+      @source_dir = site.in_source_dir("/")
     end
 
     # Read all the files in <dir> and adds them to @content
@@ -52,6 +54,8 @@ module Jekyll
     #
     # Returns the contents of the data file.
     def read_data_file(path)
+      Jekyll.logger.debug "Reading:", path.sub(@source_dir, "")
+
       case File.extname(path).downcase
       when ".csv"
         CSV.read(path,

data/lib/jekyll/readers/layout_reader.rb

@@ -3,6 +3,7 @@
 module Jekyll
   class LayoutReader
     attr_reader :site
+
     def initialize(site)
       @site = site
       @layouts = {}

data/lib/jekyll/readers/page_reader.rb

@@ -3,6 +3,7 @@
 module Jekyll
   class PageReader
     attr_reader :site, :dir, :unfiltered_content
+
     def initialize(site, dir)
       @site = site
       @dir = dir

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
@@ -56,7 +57,7 @@ module Jekyll
         Document.new(path,
                      :site       => @site,
                      :collection => @site.posts)
-      end.reject(&:nil?)
+      end.tap(&:compact!)
     end
 
     private

data/lib/jekyll/readers/static_file_reader.rb

@@ -3,6 +3,7 @@
 module Jekyll
   class StaticFileReader
     attr_reader :site, :dir, :unfiltered_content
+
     def initialize(site, dir)
       @site = site
       @dir = dir

data/lib/jekyll/readers/theme_assets_reader.rb

@@ -3,6 +3,7 @@
 module Jekyll
   class ThemeAssetsReader
     attr_reader :site
+
     def initialize(site)
       @site = site
     end

data/lib/jekyll/related_posts.rb

@@ -46,7 +46,7 @@ module Jekyll
     end
 
     def most_recent_posts
-      @most_recent_posts ||= (site.posts.docs.last(11).reverse - [post]).first(10)
+      @most_recent_posts ||= (site.posts.docs.last(11).reverse! - [post]).first(10)
     end
   end
 end

data/lib/jekyll/renderer.rb

@@ -36,7 +36,7 @@ module Jekyll
     #
     # Returns Array of Converter instances.
     def converters
-      @converters ||= site.converters.select { |c| c.matches(document.extname) }.sort
+      @converters ||= site.converters.select { |c| c.matches(document.extname) }.tap(&:sort!)
     end
 
     # Determine the extname the outputted file should have
@@ -66,7 +66,7 @@ module Jekyll
     # Render the document.
     #
     # Returns String rendered document output
-    # rubocop: disable AbcSize
+    # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
     def render_document
       info = {
         :registers        => { :site => site, :page => payload["page"] },
@@ -84,6 +84,10 @@ module Jekyll
       output = convert(output.to_s)
       document.content = output
 
+      Jekyll.logger.debug "Post-Convert Hooks:", document.relative_path
+      document.trigger_hooks(:post_convert)
+      output = document.content
+
       if document.place_in_layout?
         Jekyll.logger.debug "Rendering Layout:", document.relative_path
         output = place_in_layouts(output, payload, info)
@@ -91,7 +95,7 @@ module Jekyll
 
       output
     end
-    # rubocop: enable AbcSize
+    # rubocop: enable Metrics/AbcSize, Metrics/MethodLength
 
     # Convert the document using the converters which match this renderer's document.
     #
@@ -125,13 +129,13 @@ module Jekyll
                            LiquidRenderer.format_error(e, path || document.relative_path)
       end
       template.render!(payload, info)
-    # rubocop: disable RescueException
+    # rubocop: disable Lint/RescueException
     rescue Exception => e
       Jekyll.logger.error "Liquid Exception:",
                           LiquidRenderer.format_error(e, path || document.relative_path)
       raise e
     end
-    # rubocop: enable RescueException
+    # rubocop: enable Lint/RescueException
 
     # Checks if the layout specified in the document actually exists
     #
@@ -174,16 +178,10 @@ module Jekyll
     # layout - the layout to check
     # Returns nothing
     def validate_layout(layout)
-      if invalid_layout?(layout)
-        Jekyll.logger.warn(
-          "Build Warning:",
-          "Layout '#{document.data["layout"]}' requested "\
-          "in #{document.relative_path} does not exist."
-        )
-      elsif !layout.nil?
-        layout_source = layout.path.start_with?(site.source) ? :site : :theme
-        Jekyll.logger.debug "Layout source:", layout_source
-      end
+      return unless invalid_layout?(layout)
+
+      Jekyll.logger.warn "Build Warning:", "Layout '#{document.data["layout"]}' requested " \
+        "in #{document.relative_path} does not exist."
     end
 
     # Render layout content into document.output
@@ -197,7 +195,7 @@ module Jekyll
         layout.content,
         payload,
         info,
-        layout.relative_path
+        layout.path
       )
     end
 
@@ -257,7 +255,7 @@ module Jekyll
     def output_exts
       @output_exts ||= converters.map do |c|
         c.output_ext(document.extname)
-      end.compact
+      end.tap(&:compact!)
     end
 
     def liquid_options

data/lib/jekyll/site.rb

@@ -3,14 +3,14 @@
 module Jekyll
   class Site
     attr_reader   :source, :dest, :cache_dir, :config
-    attr_accessor :layouts, :pages, :static_files, :drafts,
+    attr_accessor :layouts, :pages, :static_files, :drafts, :inclusions,
                   :exclude, :include, :lsi, :highlighter, :permalink_style,
                   :time, :future, :unpublished, :safe, :plugins, :limit_posts,
                   :show_drafts, :keep_files, :baseurl, :data, :file_read_opts,
                   :gems, :plugin_manager, :theme
 
     attr_accessor :converters, :generators, :reader
-    attr_reader   :regenerator, :liquid_renderer, :includes_load_paths
+    attr_reader   :regenerator, :liquid_renderer, :includes_load_paths, :filter_cache, :profiler
 
     # Public: Initialize a new Site.
     #
@@ -23,8 +23,10 @@ module Jekyll
       self.config = config
 
       @cache_dir       = in_source_dir(config["cache_dir"])
+      @filter_cache    = {}
 
       @reader          = Reader.new(self)
+      @profiler        = Profiler.new(self)
       @regenerator     = Regenerator.new(self)
       @liquid_renderer = LiquidRenderer.new(self)
 
@@ -70,19 +72,21 @@ module Jekyll
     #
     # Returns nothing.
     def process
+      return profiler.profile_process if config["profile"]
+
       reset
       read
       generate
       render
       cleanup
       write
-      print_stats if config["profile"]
     end
 
     def print_stats
       Jekyll.logger.info @liquid_renderer.stats_table
     end
 
+    # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/MethodLength
     #
     # Reset Site details.
@@ -95,6 +99,7 @@ module Jekyll
                     Time.now
                   end
       self.layouts = {}
+      self.inclusions = {}
       self.pages = []
       self.static_files = []
       self.data = {}
@@ -112,8 +117,10 @@ module Jekyll
 
       Jekyll::Cache.clear_if_config_changed config
       Jekyll::Hooks.trigger :site, :after_reset, self
+      nil
     end
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     # Load necessary libraries, plugins, converters, and generators.
     #
@@ -145,9 +152,9 @@ module Jekyll
     #
     # Returns a Hash containing collection name-to-instance pairs.
     def collections
-      @collections ||= Hash[collection_names.map do |coll|
-        [coll, Jekyll::Collection.new(self, coll)]
-      end]
+      @collections ||= collection_names.each_with_object({}) do |name, hsh|
+        hsh[name] = Jekyll::Collection.new(self, name)
+      end
     end
 
     # The list of collection names.
@@ -174,6 +181,7 @@ module Jekyll
       reader.read
       limit_posts!
       Jekyll::Hooks.trigger :site, :post_read, self
+      nil
     end
 
     # Run each of the Generators.
@@ -186,6 +194,7 @@ module Jekyll
         Jekyll.logger.debug "Generating:",
                             "#{generator.class} finished in #{Time.now - start} seconds."
       end
+      nil
     end
 
     # Render the site to the destination.
@@ -202,6 +211,7 @@ module Jekyll
       render_pages(payload)
 
       Jekyll::Hooks.trigger :site, :post_render, self, payload
+      nil
     end
 
     # Remove orphaned files and empty directories in destination.
@@ -209,17 +219,20 @@ module Jekyll
     # Returns nothing.
     def cleanup
       site_cleaner.cleanup!
+      nil
     end
 
     # Write static files, pages, and posts.
     #
     # Returns nothing.
     def write
+      Jekyll::Commands::Doctor.conflicting_urls(self)
       each_site_file do |item|
         item.write(dest) if regenerator.regenerate?(item)
       end
       regenerator.write_metadata
       Jekyll::Hooks.trigger :site, :post_write, self
+      nil
     end
 
     def posts
@@ -303,8 +316,9 @@ module Jekyll
     # passed in as argument.
 
     def instantiate_subclasses(klass)
-      klass.descendants.select { |c| !safe || c.safe }.sort.map do |c|
-        c.new(config)
+      klass.descendants.select { |c| !safe || c.safe }.tap do |result|
+        result.sort!
+        result.map! { |c| c.new(config) }
       end
     end
 
@@ -428,9 +442,18 @@ module Jekyll
       @collections_path ||= dir_str.empty? ? source : in_source_dir(dir_str)
     end
 
+    # Public
+    #
+    # Returns the object as a debug String.
+    def inspect
+      "#<#{self.class} @source=#{@source}>"
+    end
+
     private
 
     def load_theme_configuration(config)
+      return config if config["ignore_theme_config"] == true
+
       theme_config_file = in_theme_dir("_config.yml")
       return config unless File.exist?(theme_config_file)
 
@@ -470,7 +493,7 @@ module Jekyll
     # Disable Marshaling cache to disk in Safe Mode
     def configure_cache
       Jekyll::Cache.cache_dir = in_source_dir(config["cache_dir"], "Jekyll/Cache")
-      Jekyll::Cache.disable_disk_cache! if safe
+      Jekyll::Cache.disable_disk_cache! if safe || config["disable_disk_cache"]
     end
 
     def configure_plugins
@@ -520,7 +543,8 @@ module Jekyll
     def render_regenerated(document, payload)
       return unless regenerator.regenerate?(document)
 
-      document.output = Jekyll::Renderer.new(self, document, payload).run
+      document.renderer.payload = payload
+      document.output = document.renderer.run
       document.trigger_hooks(:post_render)
     end
   end