jekyll 3.9.5 → 4.0.0.pre.alpha1

data/lib/jekyll/page.rb

@@ -11,8 +11,6 @@ module Jekyll
 
     alias_method :extname, :ext
 
-    FORWARD_SLASH = "/".freeze
-
     # Attributes for Liquid templates
     ATTRIBUTES_FOR_LIQUID = %w(
       content
@@ -52,7 +50,7 @@ module Jekyll
       read_yaml(File.join(base, dir), name)
 
       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,11 +62,11 @@ module Jekyll
     #
     # Returns the String destination directory.
     def dir
-      if url.end_with?(FORWARD_SLASH)
+      if url.end_with?("/")
         url
       else
         url_dir = File.dirname(url)
-        url_dir.end_with?(FORWARD_SLASH) ? url_dir : "#{url_dir}/"
+        url_dir.end_with?("/") ? url_dir : "#{url_dir}/"
       end
     end
 
@@ -97,11 +95,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 +116,11 @@ 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)
       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 +145,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 ||= File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).sub(%r!\A\/!, "")
     end
 
     # Obtain destination path.
@@ -163,7 +162,7 @@ module Jekyll
 
     # 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,20 +182,5 @@ module Jekyll
     def write?
       true
     end
-
-    # The Page excerpt_separator, from the YAML Front-Matter or site
-    # default excerpt_separator value
-    #
-    # Returns the document excerpt_separator
-    def excerpt_separator
-      (data["excerpt_separator"] || site.config["excerpt_separator"]).to_s
-    end
-
-    # Whether to generate an excerpt
-    #
-    # Returns true if the excerpt separator is configured.
-    def generate_excerpt?
-      !excerpt_separator.empty?
-    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/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/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
@@ -76,9 +86,7 @@ module Jekyll
       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
+        @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,26 @@ module Jekyll
     def post_reader
       @post_reader ||= PostReader.new(site)
     end
+
+    def read_included_excludes
+      site.include.each do |entry|
+        next if entry == ".htaccess"
+
+        entry_path = site.in_source_dir(entry)
+        next if File.directory?(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/data_reader.rb

@@ -55,13 +55,13 @@ module Jekyll
       case File.extname(path).downcase
       when ".csv"
         CSV.read(path,
-          :headers  => true,
-          :encoding => site.config["encoding"]).map(&:to_hash)
+                 :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)
+                 :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

@@ -23,7 +23,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 +54,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/post_reader.rb

@@ -34,19 +34,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
@@ -61,12 +51,34 @@ module Jekyll
     def read_content(dir, magic_dir, matcher)
       @site.reader.get_entries(dir, magic_dir).map do |entry|
         next unless entry =~ matcher
+
         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

data/lib/jekyll/readers/static_file_reader.rb

@@ -16,7 +16,7 @@ module Jekyll
     #
     # Returns an array of static files.
     def read(files)
-      files.map do |file|
+      files.each do |file|
         @unfiltered_content << StaticFile.new(@site, @site.source, @dir, file)
       end
       @unfiltered_content

data/lib/jekyll/readers/theme_assets_reader.rb

@@ -8,10 +8,11 @@ module Jekyll
     end
 
     def read
-      return unless site.theme && site.theme.assets_path
+      return unless site.theme&.assets_path
 
       Find.find(site.theme.assets_path) do |path|
         next if File.directory?(path)
+
         if File.symlink?(path)
           Jekyll.logger.warn "Theme reader:", "Ignored symlinked asset: #{path}"
         else
@@ -21,6 +22,7 @@ module Jekyll
     end
 
     private
+
     def read_theme_asset(path)
       base = site.theme.root
       dir = File.dirname(path.sub("#{site.theme.root}/", ""))
@@ -28,18 +30,18 @@ module Jekyll
 
       if Utils.has_yaml_header?(path)
         append_unless_exists site.pages,
-          Jekyll::Page.new(site, base, dir, name)
+                             Jekyll::Page.new(site, base, dir, name)
       else
         append_unless_exists site.static_files,
-          Jekyll::StaticFile.new(site, base, "/#{dir}", name)
+                             Jekyll::StaticFile.new(site, base, "/#{dir}", name)
       end
     end
 
     def append_unless_exists(haystack, new_item)
       if haystack.any? { |file| file.relative_path == new_item.relative_path }
         Jekyll.logger.debug "Theme:",
-          "Ignoring #{new_item.relative_path} in theme due to existing file " \
-          "with that path in site."
+                            "Ignoring #{new_item.relative_path} in theme due to existing file " \
+                            "with that path in site."
         return
       end
 

data/lib/jekyll/regenerator.rb

@@ -21,6 +21,7 @@ module Jekyll
     # Returns a boolean.
     def regenerate?(document)
       return true if disabled
+
       case document
       when Page
         regenerate_page?(document)
@@ -28,9 +29,7 @@ module Jekyll
         regenerate_document?(document)
       else
         source_path = document.respond_to?(:path) ? document.path : nil
-        dest_path = if document.respond_to?(:destination)
-                      document.destination(@site.dest)
-                    end
+        dest_path = document.destination(@site.dest) if document.respond_to?(:destination)
         source_modified_or_dest_missing?(source_path, dest_path)
       end
     end
@@ -89,9 +88,7 @@ module Jekyll
       return true if path.nil?
 
       # Check for path in cache
-      if cache.key? path
-        return cache[path]
-      end
+      return cache[path] if cache.key? path
 
       if metadata[path]
         # If we have seen this file before,
@@ -165,7 +162,6 @@ module Jekyll
         end
     end
 
-    private
     def regenerate_page?(document)
       document.asset_file? || document.data["regenerate"] ||
         source_modified_or_dest_missing?(
@@ -173,7 +169,6 @@ module Jekyll
         )
     end
 
-    private
     def regenerate_document?(document)
       !document.write? || document.data["regenerate"] ||
         source_modified_or_dest_missing?(
@@ -181,14 +176,11 @@ module Jekyll
         )
     end
 
-    private
     def existing_file_modified?(path)
       # If one of this file dependencies have been modified,
       # set the regeneration bit for both the dependency and the file to true
       metadata[path]["deps"].each do |dependency|
-        if modified?(dependency)
-          return cache[dependency] = cache[path] = true
-        end
+        return cache[dependency] = cache[path] = true if modified?(dependency)
       end
 
       if File.exist?(path) && metadata[path]["mtime"].eql?(File.mtime(path))

data/lib/jekyll/renderer.rb

@@ -9,6 +9,7 @@ module Jekyll
       @site     = site
       @document = document
       @payload  = site_payload
+      @layouts  = nil
     end
 
     # Fetches the payload used in Liquid rendering.
@@ -101,8 +102,8 @@ module Jekyll
           converter.convert output
         rescue StandardError => e
           Jekyll.logger.error "Conversion error:",
-            "#{converter.class} encountered an error while "\
-            "converting '#{document.relative_path}':"
+                              "#{converter.class} encountered an error while "\
+                              "converting '#{document.relative_path}':"
           Jekyll.logger.error("", e.to_s)
           raise e
         end
@@ -121,13 +122,13 @@ module Jekyll
       template = site.liquid_renderer.file(path).parse(content)
       template.warnings.each do |e|
         Jekyll.logger.warn "Liquid Warning:",
-          LiquidRenderer.format_error(e, path || document.relative_path)
+                           LiquidRenderer.format_error(e, path || document.relative_path)
       end
       template.render!(payload, info)
     # rubocop: disable RescueException
     rescue Exception => e
       Jekyll.logger.error "Liquid Exception:",
-        LiquidRenderer.format_error(e, path || document.relative_path)
+                          LiquidRenderer.format_error(e, path || document.relative_path)
       raise e
     end
     # rubocop: enable RescueException
@@ -158,19 +159,20 @@ module Jekyll
         output = render_layout(output, layout, info)
         add_regenerator_dependencies(layout)
 
-        if (layout = site.layouts[layout.data["layout"]])
-          break if used.include?(layout)
-          used << layout
-        end
+        next unless (layout = site.layouts[layout.data["layout"]])
+        break if used.include?(layout)
+
+        used << layout
       end
       output
     end
 
+    private
+
     # Checks if the layout specified in the document actually exists
     #
     # layout - the layout to check
     # Returns nothing
-    private
     def validate_layout(layout)
       if invalid_layout?(layout)
         Jekyll.logger.warn(
@@ -187,7 +189,6 @@ module Jekyll
     # Render layout content into document.output
     #
     # Returns String rendered content
-    private
     def render_layout(output, layout, info)
       payload["content"] = output
       payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
@@ -200,9 +201,9 @@ module Jekyll
       )
     end
 
-    private
     def add_regenerator_dependencies(layout)
       return unless document.write?
+
       site.regenerator.add_dependency(
         site.in_source_dir(document.path),
         layout.path
@@ -212,18 +213,14 @@ module Jekyll
     # Set page content to payload and assign pager if document has one.
     #
     # Returns nothing
-    private
     def assign_pages!
       payload["page"] = document.to_liquid
-      payload["paginator"] = if document.respond_to?(:pager)
-                               document.pager.to_liquid
-                             end
+      payload["paginator"] = (document.pager.to_liquid if document.respond_to?(:pager))
     end
 
     # Set related posts to payload if document is a post.
     #
     # Returns nothing
-    private
     def assign_current_document!
       payload["site"].current_document = document
     end
@@ -231,21 +228,16 @@ module Jekyll
     # Set highlighter prefix and suffix
     #
     # Returns nothing
-    private
     def assign_highlighter_options!
       payload["highlighter_prefix"] = converters.first.highlighter_prefix
       payload["highlighter_suffix"] = converters.first.highlighter_suffix
     end
 
-    private
     def assign_layout_data!
       layout = layouts[document.data["layout"]]
-      if layout
-        payload["layout"] = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
-      end
+      payload["layout"] = Utils.deep_merge_hashes(layout.data, payload["layout"] || {}) if layout
     end
 
-    private
     def permalink_ext
       document_permalink = document.permalink
       if document_permalink && !document_permalink.end_with?("/")
@@ -254,7 +246,6 @@ module Jekyll
       end
     end
 
-    private
     def converter_output_ext
       if output_exts.size == 1
         output_exts.last
@@ -263,14 +254,12 @@ module Jekyll
       end
     end
 
-    private
     def output_exts
       @output_exts ||= converters.map do |c|
         c.output_ext(document.extname)
       end.compact
     end
 
-    private
     def liquid_options
       @liquid_options ||= site.config["liquid"]
     end