jekyll 3.9.3 → 4.4.1

data/lib/jekyll/drops/site_drop.rb

@@ -7,13 +7,13 @@ module Jekyll
 
       mutable false
 
-      def_delegator  :@obj, :site_data, :data
-      def_delegators :@obj, :time, :pages, :static_files, :tags, :categories
+      delegate_method_as :site_data, :data
+      delegate_methods :time, :pages, :static_files, :tags, :categories
 
-      private def_delegator :@obj, :config, :fallback_data
+      private delegate_method_as :config, :fallback_data
 
       def [](key)
-        if @obj.collections.key?(key) && key != "posts"
+        if key != "posts" && @obj.collections.key?(key)
           @obj.collections[key].docs
         else
           super(key)
@@ -21,7 +21,7 @@ module Jekyll
       end
 
       def key?(key)
-        (@obj.collections.key?(key) && key != "posts") || super
+        (key != "posts" && @obj.collections.key?(key)) || super
       end
 
       def posts
@@ -41,9 +41,9 @@ module Jekyll
       # `Site#documents` cannot be memoized so that `Site#docs_to_write` can access the
       # latest state of the attribute.
       #
-      # Since this method will be called after `Site#pre_render` hook,
-      # the `Site#documents` array shouldn't thereafter change and can therefore be
-      # safely memoized to prevent additional computation of `Site#documents`.
+      # Since this method will be called after `Site#pre_render` hook, the `Site#documents`
+      # array shouldn't thereafter change and can therefore be safely memoized to prevent
+      # additional computation of `Site#documents`.
       def documents
         @documents ||= @obj.documents
       end
@@ -54,6 +54,7 @@ module Jekyll
       # We should remove this in 4.0 and switch to `{{ post.related_posts }}`.
       def related_posts
         return nil unless @current_document.is_a?(Jekyll::Document)
+
         @current_document.related_posts
       end
       attr_writer :current_document

data/lib/jekyll/drops/static_file_drop.rb

@@ -4,11 +4,11 @@ module Jekyll
   module Drops
     class StaticFileDrop < Drop
       extend Forwardable
-      def_delegators :@obj, :name, :extname, :modified_time, :basename
-      def_delegator :@obj, :relative_path, :path
-      def_delegator :@obj, :type, :collection
+      delegate_methods   :name, :extname, :modified_time, :basename
+      delegate_method_as :relative_path, :path
+      delegate_method_as :type, :collection
 
-      private def_delegator :@obj, :data, :fallback_data
+      private delegate_method_as :data, :fallback_data
     end
   end
 end

data/lib/jekyll/drops/theme_drop.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    class ThemeDrop < Drop
+      delegate_method_as :runtime_dependencies, :dependencies
+
+      def root
+        @root ||= ENV["JEKYLL_ENV"] == "development" ? @obj.root : ""
+      end
+
+      def authors
+        @authors ||= gemspec.authors.join(", ")
+      end
+
+      def version
+        @version ||= gemspec.version.to_s
+      end
+
+      def description
+        @description ||= gemspec.description || gemspec.summary
+      end
+
+      def metadata
+        @metadata ||= gemspec.metadata
+      end
+
+      private
+
+      def gemspec
+        @gemspec ||= @obj.send(:gemspec)
+      end
+
+      def fallback_data
+        @fallback_data ||= {}
+      end
+    end
+  end
+end

data/lib/jekyll/drops/unified_payload_drop.rb

@@ -5,8 +5,8 @@ module Jekyll
     class UnifiedPayloadDrop < Drop
       mutable true
 
-      attr_accessor :page, :layout, :content, :paginator
-      attr_accessor :highlighter_prefix, :highlighter_suffix
+      attr_accessor :content, :page, :layout, :paginator,
+                    :highlighter_prefix, :highlighter_suffix
 
       def jekyll
         JekyllDrop.global
@@ -16,7 +16,12 @@ module Jekyll
         @site_drop ||= SiteDrop.new(@obj)
       end
 
+      def theme
+        @theme_drop ||= ThemeDrop.new(@obj.theme) if @obj.theme
+      end
+
       private
+
       def fallback_data
         @fallback_data ||= {}
       end

data/lib/jekyll/drops/url_drop.rb

@@ -7,8 +7,8 @@ module Jekyll
 
       mutable false
 
-      def_delegator :@obj, :cleaned_relative_path, :path
-      def_delegator :@obj, :output_ext, :output_ext
+      delegate_method :output_ext
+      delegate_method_as :cleaned_relative_path, :path
 
       def collection
         @obj.collection.label
@@ -35,53 +35,105 @@ module Jekyll
         category_set.to_a.join("/")
       end
 
+      # Similar to output from #categories, but each category will be downcased and
+      # all non-alphanumeric characters of the category replaced with a hyphen.
+      def slugified_categories
+        Array(@obj.data["categories"]).each_with_object(Set.new) do |category, set|
+          set << Utils.slugify(category.to_s)
+        end.to_a.join("/")
+      end
+
+      # CCYY
       def year
         @obj.date.strftime("%Y")
       end
 
+      # MM: 01..12
       def month
         @obj.date.strftime("%m")
       end
 
+      # DD: 01..31
       def day
         @obj.date.strftime("%d")
       end
 
+      # hh: 00..23
       def hour
         @obj.date.strftime("%H")
       end
 
+      # mm: 00..59
       def minute
         @obj.date.strftime("%M")
       end
 
+      # ss: 00..59
       def second
         @obj.date.strftime("%S")
       end
 
+      # D: 1..31
       def i_day
         @obj.date.strftime("%-d")
       end
 
+      # M: 1..12
       def i_month
         @obj.date.strftime("%-m")
       end
 
+      # MMM: Jan..Dec
       def short_month
         @obj.date.strftime("%b")
       end
 
+      # MMMM: January..December
+      def long_month
+        @obj.date.strftime("%B")
+      end
+
+      # YY: 00..99
       def short_year
         @obj.date.strftime("%y")
       end
 
+      # CCYYw, ISO week year
+      # may differ from CCYY for the first days of January and last days of December
+      def w_year
+        @obj.date.strftime("%G")
+      end
+
+      # WW: 01..53
+      # %W and %U do not comply with ISO 8601-1
+      def week
+        @obj.date.strftime("%V")
+      end
+
+      # d: 1..7 (Monday..Sunday)
+      def w_day
+        @obj.date.strftime("%u")
+      end
+
+      # dd: Mon..Sun
+      def short_day
+        @obj.date.strftime("%a")
+      end
+
+      # ddd: Monday..Sunday
+      def long_day
+        @obj.date.strftime("%A")
+      end
+
+      # DDD: 001..366
       def y_day
         @obj.date.strftime("%j")
       end
 
       private
+
       def fallback_data
-        {}
+        @fallback_data ||= {}
       end
     end
   end

data/lib/jekyll/entry_filter.rb

@@ -3,9 +3,8 @@
 module Jekyll
   class EntryFilter
     attr_reader :site
-    SPECIAL_LEADING_CHARACTERS = [
-      ".", "_", "#", "~",
-    ].freeze
+
+    SPECIAL_LEADING_CHAR_REGEX = %r!\A#{Regexp.union([".", "_", "#", "~"])}!o.freeze
 
     def initialize(site, base_directory = nil)
       @site = site
@@ -31,12 +30,24 @@ module Jekyll
 
     def filter(entries)
       entries.reject do |e|
-        # Reject this entry if it is a symlink.
+        # Reject this entry if it is just a "dot" representation.
+        #   e.g.: '.', '..', '_movies/.', 'music/..', etc
+        next true if e.end_with?(".")
+
+        # Check if the current entry is explicitly included and cache the result
+        included = included?(e)
+
+        # Reject current entry if it is excluded but not explicitly included as well.
+        next true if excluded?(e) && !included
+
+        # Reject current entry if it is a symlink.
         next true if symlink?(e)
-        # Do not reject this entry if it is included.
-        next false if included?(e)
-        # Reject this entry if it is special, a backup file, or excluded.
-        special?(e) || backup?(e) || excluded?(e)
+
+        # Do not reject current entry if it is explicitly included.
+        next false if included
+
+        # Reject current entry if it is special or a backup file.
+        special?(e) || backup?(e)
       end
     end
 
@@ -46,16 +57,16 @@ module Jekyll
     end
 
     def special?(entry)
-      SPECIAL_LEADING_CHARACTERS.include?(entry[0..0]) ||
-        SPECIAL_LEADING_CHARACTERS.include?(File.basename(entry)[0..0])
+      SPECIAL_LEADING_CHAR_REGEX.match?(entry) ||
+        SPECIAL_LEADING_CHAR_REGEX.match?(File.basename(entry))
     end
 
     def backup?(entry)
-      entry[-1..-1] == "~"
+      entry.end_with?("~")
     end
 
     def excluded?(entry)
-      glob_include?(site.exclude, relative_to_source(entry)).tap do |excluded|
+      glob_include?(site.exclude - site.include, relative_to_source(entry)).tap do |excluded|
         if excluded
           Jekyll.logger.debug(
             "EntryFilter:",
@@ -75,50 +86,30 @@ module Jekyll
     end
 
     # --
-    # NOTE: Pathutil#in_path? gets the realpath.
-    # @param [<Anything>] entry the entry you want to validate.
-    # Check if a path is outside of our given root.
+    # Check if given path is outside of current site's configured source directory.
     # --
     def symlink_outside_site_source?(entry)
-      !Pathutil.new(entry).in_path?(
-        site.in_source_dir
-      )
+      !File.realpath(entry).start_with?(site.in_source_dir)
     end
 
-    # --
-    # Check if an entry matches a specific pattern and return true,false.
-    # Returns true if path matches against any glob pattern.
-    # --
-    def glob_include?(enum, entry)
-      entry_path = Pathutil.new(site.in_source_dir).join(entry)
-      enum.any? do |exp|
-        # Users who send a Regexp knows what they want to
-        # exclude, so let them send a Regexp to exclude files,
-        # we will not bother caring if it works or not, it's
-        # on them at this point.
-
-        if exp.is_a?(Regexp)
-          entry_path =~ exp
-
+    # Check if an entry matches a specific pattern.
+    # Returns true if path matches against any glob pattern, else false.
+    def glob_include?(enumerator, entry)
+      entry_with_source = PathManager.join(site.source, entry)
+      entry_is_directory = File.directory?(entry_with_source)
+
+      enumerator.any? do |pattern|
+        case pattern
+        when String
+          pattern_with_source = PathManager.join(site.source, pattern)
+
+          File.fnmatch?(pattern_with_source, entry_with_source) ||
+            entry_with_source.start_with?(pattern_with_source) ||
+            (pattern_with_source == "#{entry_with_source}/" if entry_is_directory)
+        when Regexp
+          pattern.match?(entry_with_source)
         else
-          item = Pathutil.new(site.in_source_dir).join(exp)
-
-          # If it's a directory they want to exclude, AKA
-          # ends with a "/" then we will go on to check and
-          # see if the entry falls within that path and
-          # exclude it if that's the case.
-
-          if entry.end_with?("/")
-            entry_path.in_path?(
-              item
-            )
-
-          else
-            File.fnmatch?(item, entry_path) ||
-              entry_path.to_path.start_with?(
-                item
-              )
-          end
+          false
         end
       end
     end

data/lib/jekyll/excerpt.rb

@@ -4,14 +4,14 @@ module Jekyll
   class Excerpt
     extend Forwardable
 
-    attr_accessor :doc
-    attr_accessor :content, :ext
+    attr_accessor :content, :doc, :ext
     attr_writer   :output
 
-    def_delegators :@doc, :site, :name, :ext, :extname,
-                          :collection, :related_posts,
-                          :coffeescript_file?, :yaml_file?,
-                          :url, :next_doc, :previous_doc
+    def_delegators :@doc,
+                   :site, :name, :ext, :extname,
+                   :collection, :related_posts, :type,
+                   :coffeescript_file?, :yaml_file?,
+                   :url, :next_doc, :previous_doc
 
     private :coffeescript_file?, :yaml_file?
 
@@ -48,14 +48,14 @@ module Jekyll
     #
     # Returns the relative_path for the doc this excerpt belongs to with #excerpt appended
     def relative_path
-      File.join(doc.relative_path, "#excerpt")
+      @relative_path ||= File.join(doc.relative_path, "#excerpt")
     end
 
     # Check if excerpt includes a string
     #
     # Returns true if the string passed in
     def include?(something)
-      (output && output.include?(something)) || content.include?(something)
+      output&.include?(something) || content.include?(something)
     end
 
     # The UID for this doc (useful in feeds).
@@ -76,7 +76,7 @@ module Jekyll
 
     # Returns the shorthand String identifier of this doc.
     def inspect
-      "<Excerpt: #{self.id}>"
+      "<#{self.class} id=#{id}>"
     end
 
     def output
@@ -88,6 +88,8 @@ module Jekyll
     end
 
     def render_with_liquid?
+      return false if data["render_with_liquid"] == false
+
       !(coffeescript_file? || yaml_file? || !Utils.has_liquid_construct?(content))
     end
 
@@ -128,36 +130,47 @@ module Jekyll
     #
     # Returns excerpt String
 
-    LIQUID_TAG_REGEX = %r!{%-?\s*(\w+)\s*.*?-?%}!m
-    MKDWN_LINK_REF_REGEX = %r!^ {0,3}\[[^\]]+\]:.+$!
+    LIQUID_TAG_REGEX = %r!{%-?\s*(\w+)\s*.*?-?%}!m.freeze
+    MKDWN_LINK_REF_REGEX = %r!^ {0,3}(?:(\[[^\]]+\])(:.+))$!.freeze
 
     def extract_excerpt(doc_content)
       head, _, tail = doc_content.to_s.partition(doc.excerpt_separator)
+      return head if tail.empty?
 
-      # append appropriate closing tag(s) (for each Liquid block), to the `head`
-      # if the partitioning resulted in leaving the closing tag somewhere
-      # in the `tail` partition.
+      head = sanctify_liquid_tags(head) if head.include?("{%")
+      definitions = extract_markdown_link_reference_definitions(head, tail)
+      return head if definitions.empty?
 
-      if head.include?("{%")
-        modified  = false
-        tag_names = head.scan(LIQUID_TAG_REGEX)
-        tag_names.flatten!
-        tag_names.reverse_each do |tag_name|
-          next unless liquid_block?(tag_name)
-          next if head =~ endtag_regex_stash(tag_name)
+      head << "\n\n" << definitions.join("\n")
+    end
 
-          modified = true
-          head << "\n{% end#{tag_name} %}"
-        end
-        print_build_warning if modified
-      end
+    private
 
-      return head if tail.empty?
+    # append appropriate closing tag(s) (for each Liquid block), to the `head` if the
+    # partitioning resulted in leaving the closing tag somewhere in the `tail` partition.
+    def sanctify_liquid_tags(head)
+      modified  = false
+      tag_names = head.scan(LIQUID_TAG_REGEX)
+      tag_names.flatten!
+      tag_names.reverse_each do |tag_name|
+        next unless liquid_block?(tag_name)
+        next if endtag_regex_stash(tag_name).match?(head)
+
+        modified = true
+        head << "\n{% end#{tag_name} %}"
+      end
 
-      head << "\n\n" << tail.scan(MKDWN_LINK_REF_REGEX).join("\n")
+      print_build_warning if modified
+      head
     end
 
-    private
+    def extract_markdown_link_reference_definitions(head, tail)
+      [].tap do |definitions|
+        tail.scan(MKDWN_LINK_REF_REGEX).each do |segments|
+          definitions << segments.join if head.include?(segments[0])
+        end
+      end
+    end
 
     def endtag_regex_stash(tag_name)
       @endtag_regex_stash ||= {}
@@ -171,20 +184,17 @@ module Jekyll
       Liquid::Template.tags[tag_name].ancestors.include?(Liquid::Block)
     rescue NoMethodError
       Jekyll.logger.error "Error:",
-        "A Liquid tag in the excerpt of #{doc.relative_path} couldn't be " \
-        "parsed."
+                          "A Liquid tag in the excerpt of #{doc.relative_path} couldn't be parsed."
       raise
     end
 
     def print_build_warning
       Jekyll.logger.warn "Warning:", "Excerpt modified in #{doc.relative_path}!"
-      Jekyll.logger.warn "", "Found a Liquid block containing the excerpt separator" \
-                         " #{doc.excerpt_separator.inspect}. "
-      Jekyll.logger.warn "", "The block has been modified with the appropriate" \
-                         " closing tag."
-      Jekyll.logger.warn "", "Feel free to define a custom excerpt or" \
-                         " excerpt_separator in the document's front matter" \
-                         " if the generated excerpt is unsatisfactory."
+      Jekyll.logger.warn "", "Found a Liquid block containing the excerpt separator " \
+                             "#{doc.excerpt_separator.inspect}."
+      Jekyll.logger.warn "", "The block has been modified with the appropriate closing tag."
+      Jekyll.logger.warn "", "Feel free to define a custom excerpt or excerpt_separator in the"
+      Jekyll.logger.warn "", "document's Front Matter if the generated excerpt is unsatisfactory."
     end
   end
 end

data/lib/jekyll/external.rb

@@ -9,6 +9,7 @@ module Jekyll
       #
       def blessed_gems
         %w(
+          jekyll-compose
           jekyll-docs
           jekyll-import
         )
@@ -21,13 +22,11 @@ module Jekyll
       #
       def require_if_present(names)
         Array(names).each do |name|
-          begin
-            require name
-          rescue LoadError
-            Jekyll.logger.debug "Couldn't load #{name}. Skipping."
-            yield(name, version_constraint(name)) if block_given?
-            false
-          end
+          require name
+        rescue LoadError
+          Jekyll.logger.debug "Couldn't load #{name}. Skipping."
+          yield(name, version_constraint(name)) if block_given?
+          false
         end
       end
 
@@ -41,6 +40,7 @@ module Jekyll
       # RubyGems.
       def version_constraint(gem_name)
         return "= #{Jekyll::VERSION}" if gem_name.to_s.eql?("jekyll-docs")
+
         "> 0"
       end
 
@@ -53,20 +53,21 @@ module Jekyll
       #
       def require_with_graceful_fail(names)
         Array(names).each do |name|
-          begin
-            Jekyll.logger.debug "Requiring:", name.to_s
-            require name
-          rescue LoadError => e
-            Jekyll.logger.error "Dependency Error:", <<-MSG
-Yikes! It looks like you don't have #{name} or one of its dependencies installed.
-In order to use Jekyll as currently configured, you'll need to install this gem.
+          Jekyll.logger.debug "Requiring:", name.to_s
+          require name
+        rescue LoadError => e
+          Jekyll.logger.error "Dependency Error:", <<~MSG
+            Yikes! It looks like you don't have #{name} or one of its dependencies installed.
+            In order to use Jekyll as currently configured, you'll need to install this gem.
+
+            If you've run Jekyll with `bundle exec`, ensure that you have included the #{name}
+            gem in your Gemfile as well.
 
-The full error message from Ruby is: '#{e.message}'
+            The full error message from Ruby is: '#{e.message}'
 
-If you run into trouble, you can find helpful resources at https://jekyllrb.com/help/!
-            MSG
-            raise Jekyll::Errors::MissingDependencyException, name
-          end
+            If you run into trouble, you can find helpful resources at https://jekyllrb.com/help/!
+          MSG
+          raise Jekyll::Errors::MissingDependencyException, name
         end
       end
     end

data/lib/jekyll/filters/date_filters.rb

@@ -45,6 +45,7 @@ module Jekyll
       # Returns the formatted String.
       def date_to_xmlschema(date)
         return date if date.to_s.empty?
+
         time(date).xmlschema
       end
 
@@ -60,10 +61,12 @@ module Jekyll
       # Returns the formatted String.
       def date_to_rfc822(date)
         return date if date.to_s.empty?
+
         time(date).rfc822
       end
 
       private
+
       # month_type: Notations that evaluate to 'Month' via `Time#strftime` ("%b", "%B")
       # type: nil (default) or "ordinal"
       # style: nil (default) or "US"
@@ -71,17 +74,18 @@ module Jekyll
       # Returns a stringified date or the empty input.
       def stringify_date(date, month_type, type = nil, style = nil)
         return date if date.to_s.empty?
+
         time = time(date)
         if type == "ordinal"
           day = time.day
           ordinal_day = "#{day}#{ordinal(day)}"
           return time.strftime("#{month_type} #{ordinal_day}, %Y") if style == "US"
+
           return time.strftime("#{ordinal_day} #{month_type} %Y")
         end
         time.strftime("%d #{month_type} %Y")
       end
 
-      private
       def ordinal(number)
         return "th" if (11..13).cover?(number)
 
@@ -93,12 +97,11 @@ module Jekyll
         end
       end
 
-      private
       def time(input)
         date = Liquid::Utils.to_date(input)
         unless date.respond_to?(:to_time)
           raise Errors::InvalidDateError,
-            "Invalid Date: '#{input.inspect}' is not a valid datetime."
+                "Invalid Date: '#{input.inspect}' is not a valid datetime."
         end
         date.to_time.dup.localtime
       end

data/lib/jekyll/filters/grouping_filters.rb

@@ -41,16 +41,15 @@ module Jekyll
       end
 
       private
+
       def parse_expression(str)
         Liquid::Variable.new(str, Liquid::ParseContext.new)
       end
 
-      private
       def groupable?(element)
         element.respond_to?(:group_by)
       end
 
-      private
       def grouped_array(groups)
         groups.each_with_object([]) do |item, array|
           array << {