jekyll 3.8.7 → 4.1.0

data/lib/jekyll/drops/collection_drop.rb

@@ -7,9 +7,8 @@ module Jekyll
 
       mutable false
 
-      def_delegator :@obj, :write?, :output
-      def_delegators :@obj, :label, :docs, :files, :directory,
-                            :relative_directory
+      def_delegator  :@obj, :write?, :output
+      def_delegators :@obj, :label, :docs, :files, :directory, :relative_directory
 
       private def_delegator :@obj, :metadata, :fallback_data
 

data/lib/jekyll/drops/document_drop.rb

@@ -12,7 +12,7 @@ module Jekyll
       mutable false
 
       def_delegator :@obj, :relative_path, :path
-      def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url
+      def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url, :date
 
       private def_delegator :@obj, :data, :fallback_data
 
@@ -26,6 +26,7 @@ module Jekyll
 
       def <=>(other)
         return nil unless other.is_a? DocumentDrop
+
         cmp = self["date"] <=> other["date"]
         cmp = self["path"] <=> other["path"] if cmp.nil? || cmp.zero?
         cmp
@@ -63,6 +64,18 @@ module Jekyll
           result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
         end
       end
+
+      def title
+        @obj.data["title"]
+      end
+
+      def categories
+        @obj.data["categories"]
+      end
+
+      def tags
+        @obj.data["tags"]
+      end
     end
   end
 end

data/lib/jekyll/drops/drop.rb

@@ -15,11 +15,7 @@ module Jekyll
       #
       # Returns the mutability of the class
       def self.mutable(is_mutable = nil)
-        @is_mutable = if is_mutable
-                        is_mutable
-                      else
-                        false
-                      end
+        @is_mutable = is_mutable || false
       end
 
       def self.mutable?
@@ -34,7 +30,6 @@ module Jekyll
       # Returns nothing
       def initialize(obj)
         @obj = obj
-        @mutations = {} # only if mutable: true
       end
 
       # Access a method in the Drop or a field in the underlying hash data.
@@ -46,8 +41,8 @@ module Jekyll
       #
       # Returns the value for the given key, or nil if none exists
       def [](key)
-        if self.class.mutable? && @mutations.key?(key)
-          @mutations[key]
+        if self.class.mutable? && mutations.key?(key)
+          mutations[key]
         elsif self.class.invokable? key
           public_send key
         else
@@ -70,11 +65,12 @@ module Jekyll
       # and the key matches a method in which case it raises a
       # DropMutationException.
       def []=(key, val)
-        if respond_to?("#{key}=")
-          public_send("#{key}=", val)
+        setter = "#{key}="
+        if respond_to?(setter)
+          public_send(setter, val)
         elsif respond_to?(key.to_s)
           if self.class.mutable?
-            @mutations[key] = val
+            mutations[key] = val
           else
             raise Errors::DropMutationException, "Key #{key} cannot be set in the drop."
           end
@@ -104,7 +100,8 @@ module Jekyll
       # Returns true if the given key is present
       def key?(key)
         return false if key.nil?
-        return true if self.class.mutable? && @mutations.key?(key)
+        return true if self.class.mutable? && mutations.key?(key)
+
         respond_to?(key) || fallback_data.key?(key)
       end
 
@@ -116,7 +113,7 @@ module Jekyll
       # Returns an Array of unique keys for content for the Drop.
       def keys
         (content_methods |
-          @mutations.keys |
+          mutations.keys |
           fallback_data.keys).flatten
       end
 
@@ -173,7 +170,7 @@ module Jekyll
       end
 
       def merge(other, &block)
-        self.dup.tap do |me|
+        dup.tap do |me|
           if block.nil?
             me.merge!(other)
           else
@@ -207,6 +204,12 @@ module Jekyll
         return yield(key) unless block.nil?
         return default unless default.nil?
       end
+
+      private
+
+      def mutations
+        @mutations ||= {}
+      end
     end
   end
 end

data/lib/jekyll/drops/excerpt_drop.rb

@@ -7,6 +7,10 @@ module Jekyll
         @obj.doc.data["layout"]
       end
 
+      def date
+        @obj.doc.date
+      end
+
       def excerpt
         nil
       end

data/lib/jekyll/drops/page_drop.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    class PageDrop < Drop
+      extend Forwardable
+
+      mutable false
+
+      def_delegators :@obj, :content, :dir, :name, :path, :url, :excerpt
+      private def_delegator :@obj, :data, :fallback_data
+
+      def title
+        @obj.data["title"]
+      end
+    end
+  end
+end

data/lib/jekyll/drops/site_drop.rb

@@ -13,7 +13,7 @@ module Jekyll
       private def_delegator :@obj, :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/unified_payload_drop.rb

@@ -17,6 +17,7 @@ module Jekyll
       end
 
       private
+
       def fallback_data
         @fallback_data ||= {}
       end

data/lib/jekyll/drops/url_drop.rb

@@ -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
@@ -29,16 +28,30 @@ module Jekyll
       )
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     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
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def included?(entry)
       glob_include?(site.include, entry) ||
@@ -46,16 +59,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:",
@@ -85,40 +98,24 @@ module Jekyll
       )
     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

@@ -8,10 +8,11 @@ module Jekyll
     attr_accessor :content, :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 +49,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 +77,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 +89,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 +131,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_defintions(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_defintions(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,8 +185,7 @@ 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
 
@@ -180,11 +193,9 @@ module Jekyll
       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 "", "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