jekyll 3.9.5 → 4.0.0.pre.alpha1

data/lib/jekyll/drops/site_drop.rb

@@ -8,12 +8,12 @@ module Jekyll
       mutable false
 
       def_delegator  :@obj, :site_data, :data
-      def_delegators :@obj, :time, :pages, :static_files, :tags, :categories
+      def_delegators :@obj, :time, :pages, :static_files, :documents, :tags, :categories
 
       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
@@ -38,22 +38,13 @@ module Jekyll
         @site_collections ||= @obj.collections.values.sort_by(&:label).map(&:to_liquid)
       end
 
-      # `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`.
-      def documents
-        @documents ||= @obj.documents
-      end
-
       # `{{ site.related_posts }}` is how posts can get posts related to
       # them, either through LSI if it's enabled, or through the most
       # recent posts.
       # 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

@@ -80,6 +80,7 @@ module Jekyll
       end
 
       private
+
       def fallback_data
         {}
       end

data/lib/jekyll/entry_filter.rb

@@ -35,6 +35,7 @@ module Jekyll
         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)
       end
@@ -55,7 +56,7 @@ module Jekyll
     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:",

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,
+                   :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 head =~ endtag_regex_stash(tag_name)
+
+        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

data/lib/jekyll/external.rb

@@ -9,6 +9,7 @@ module Jekyll
       #
       def blessed_gems
         %w(
+          jekyll-compose
           jekyll-docs
           jekyll-import
         )
@@ -41,6 +42,7 @@ module Jekyll
       # RubyGems.
       def version_constraint(gem_name)
         return "= #{Jekyll::VERSION}" if gem_name.to_s.eql?("jekyll-docs")
+
         "> 0"
       end
 
@@ -57,13 +59,16 @@ module Jekyll
             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.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/!
+              If you run into trouble, you can find helpful resources at https://jekyllrb.com/help/!
             MSG
             raise Jekyll::Errors::MissingDependencyException, name
           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 << {

data/lib/jekyll/filters/url_filters.rb

@@ -10,10 +10,13 @@ module Jekyll
       # Returns the absolute URL as a String.
       def absolute_url(input)
         return if input.nil?
+
         input = input.url if input.respond_to?(:url)
         return input if Addressable::URI.parse(input.to_s).absolute?
+
         site = @context.registers[:site]
         return relative_url(input) if site.config["url"].nil?
+
         Addressable::URI.parse(
           site.config["url"].to_s + relative_url(input)
         ).normalize.to_s
@@ -27,6 +30,7 @@ module Jekyll
       # Returns a URL relative to the domain root as a String.
       def relative_url(input)
         return if input.nil?
+
         input = input.url if input.respond_to?(:url)
         return input if Addressable::URI.parse(input.to_s).absolute?
 
@@ -43,6 +47,7 @@ module Jekyll
       # Returns a URL with the trailing `/index.html` removed
       def strip_index(input)
         return if input.nil? || input.to_s.empty?
+
         input.sub(%r!/index\.html?$!, "/")
       end
 
@@ -55,9 +60,9 @@ module Jekyll
 
       def ensure_leading_slash(input)
         return input if input.nil? || input.empty? || input.start_with?("/")
+
         "/#{input}"
       end
-
     end
   end
 end

data/lib/jekyll/filters.rb

@@ -169,6 +169,7 @@ module Jekyll
     def where(input, property, value)
       return input if property.nil? || value.nil?
       return input unless input.respond_to?(:select)
+
       input    = input.values if input.is_a?(Hash)
       input_id = input.hash
 
@@ -195,6 +196,7 @@ module Jekyll
     # Returns the filtered array of objects
     def where_exp(input, variable, expression)
       return input unless input.respond_to?(:select)
+
       input = input.values if input.is_a?(Hash) # FIXME
 
       condition = parse_condition(expression)
@@ -214,6 +216,7 @@ module Jekyll
     def to_integer(input)
       return 1 if input == true
       return 0 if input == false
+
       input.to_i
     end
 
@@ -225,9 +228,8 @@ module Jekyll
     #
     # Returns the filtered array of objects
     def sort(input, property = nil, nils = "first")
-      if input.nil?
-        raise ArgumentError, "Cannot sort a null object."
-      end
+      raise ArgumentError, "Cannot sort a null object." if input.nil?
+
       if property.nil?
         input.sort
       else
@@ -246,6 +248,7 @@ module Jekyll
 
     def pop(array, num = 1)
       return array unless array.is_a?(Array)
+
       num = Liquid::Utils.to_integer(num)
       new_ary = array.dup
       new_ary.pop(num)
@@ -254,6 +257,7 @@ module Jekyll
 
     def push(array, input)
       return array unless array.is_a?(Array)
+
       new_ary = array.dup
       new_ary.push(input)
       new_ary
@@ -261,6 +265,7 @@ module Jekyll
 
     def shift(array, num = 1)
       return array unless array.is_a?(Array)
+
       num = Liquid::Utils.to_integer(num)
       new_ary = array.dup
       new_ary.shift(num)
@@ -269,6 +274,7 @@ module Jekyll
 
     def unshift(array, input)
       return array unless array.is_a?(Array)
+
       new_ary = array.dup
       new_ary.unshift(input)
       new_ary
@@ -276,6 +282,7 @@ module Jekyll
 
     def sample(input, num = 1)
       return input unless input.respond_to?(:sample)
+
       num = Liquid::Utils.to_integer(num) rescue 1
       if num == 1
         input.sample
@@ -301,35 +308,45 @@ module Jekyll
     # We also utilize the Schwartzian transform to make this more efficient.
     def sort_input(input, property, order)
       input.map { |item| [item_property(item, property), item] }
-        .sort! do |apple_info, orange_info|
-          apple_property = apple_info.first
-          orange_property = orange_info.first
+        .sort! do |a_info, b_info|
+          a_property = a_info.first
+          b_property = b_info.first
 
-          if !apple_property.nil? && orange_property.nil?
+          if !a_property.nil? && b_property.nil?
             - order
-          elsif apple_property.nil? && !orange_property.nil?
+          elsif a_property.nil? && !b_property.nil?
             + order
           else
-            apple_property <=> orange_property
+            a_property <=> b_property || a_property.to_s <=> b_property.to_s
           end
         end
         .map!(&:last)
     end
 
-    private
     def item_property(item, property)
-      if item.respond_to?(:to_liquid)
-        property.to_s.split(".").reduce(item.to_liquid) do |subvalue, attribute|
-          subvalue[attribute]
+      @item_property_cache ||= {}
+      @item_property_cache[property] ||= {}
+      @item_property_cache[property][item] ||= begin
+        if item.respond_to?(:to_liquid)
+          property.to_s.split(".").reduce(item.to_liquid) do |subvalue, attribute|
+            parse_sort_input(subvalue[attribute])
+          end
+        elsif item.respond_to?(:data)
+          parse_sort_input(item.data[property.to_s])
+        else
+          parse_sort_input(item[property.to_s])
         end
-      elsif item.respond_to?(:data)
-        item.data[property.to_s]
-      else
-        item[property.to_s]
       end
     end
 
-    private
+    # return numeric values as numbers for proper sorting
+    def parse_sort_input(property)
+      number_like = %r!\A\s*-?(?:\d+\.?\d*|\.\d+)\s*\Z!
+      return property.to_f if property =~ number_like
+
+      property
+    end
+
     def as_liquid(item)
       case item
       when Hash
@@ -352,25 +369,49 @@ module Jekyll
       end
     end
 
+    # -----------   The following set of code was *adapted* from Liquid::If
+    # -----------   ref: https://git.io/vp6K6
+
     # Parse a string to a Liquid Condition
-    private
     def parse_condition(exp)
-      parser = Liquid::Parser.new(exp)
-      left_expr = parser.expression
-      operator = parser.consume?(:comparison)
-      condition =
-        if operator
-          Liquid::Condition.new(Liquid::Expression.parse(left_expr),
-                                operator,
-                                Liquid::Expression.parse(parser.expression))
-        else
-          Liquid::Condition.new(Liquid::Expression.parse(left_expr))
-        end
-      parser.consume(:end_of_string)
+      parser    = Liquid::Parser.new(exp)
+      condition = parse_binary_comparison(parser)
 
+      parser.consume(:end_of_string)
       condition
     end
 
+    # Generate a Liquid::Condition object from a Liquid::Parser object additionally processing
+    # the parsed expression based on whether the expression consists of binary operations with
+    # Liquid operators `and` or `or`
+    #
+    #  - parser: an instance of Liquid::Parser
+    #
+    # Returns an instance of Liquid::Condition
+    def parse_binary_comparison(parser)
+      parse_comparison(parser).tap do |condition|
+        binary_operator = parser.id?("and") || parser.id?("or")
+        condition.send(binary_operator, parse_comparison(parser)) if binary_operator
+      end
+    end
+
+    # Generates a Liquid::Condition object from a Liquid::Parser object based on whether the parsed
+    # expression involves a "comparison" operator (e.g. <, ==, >, !=, etc)
+    #
+    #  - parser: an instance of Liquid::Parser
+    #
+    # Returns an instance of Liquid::Condition
+    def parse_comparison(parser)
+      left_operand = Liquid::Expression.parse(parser.expression)
+      operator     = parser.consume?(:comparison)
+
+      # No comparison-operator detected. Initialize a Liquid::Condition using only left operand
+      return Liquid::Condition.new(left_operand) unless operator
+
+      # Parse what remained after extracting the left operand and the `:comparison` operator
+      # and initialize a Liquid::Condition object using the operands and the comparison-operator
+      Liquid::Condition.new(left_operand, operator, Liquid::Expression.parse(parser.expression))
+    end
   end
 end
 

data/lib/jekyll/frontmatter_defaults.rb

@@ -10,6 +10,11 @@ module Jekyll
     # Initializes a new instance.
     def initialize(site)
       @site = site
+      reset
+    end
+
+    def reset
+      @glob_cache = {}
     end
 
     def update_deprecated_types(set)
@@ -36,6 +41,7 @@ module Jekyll
     def ensure_time!(set)
       return set unless set.key?("values") && set["values"].key?("date")
       return set if set["values"]["date"].is_a?(Time)
+
       set["values"]["date"] = Utils.parse_date(
         set["values"]["date"],
         "An invalid date format was found in a front-matter default set: #{set}"
@@ -92,39 +98,44 @@ module Jekyll
     # path - the path to check for
     # type - the type (:post, :page or :draft) to check for
     #
-    # Returns true if the scope applies to the given path and type
+    # Returns true if the scope applies to the given type and path
     def applies?(scope, path, type)
-      applies_path?(scope, path) && applies_type?(scope, type)
+      applies_type?(scope, type) && applies_path?(scope, path)
     end
 
-    # rubocop:disable Metrics/AbcSize
     def applies_path?(scope, path)
       return true if !scope.key?("path") || scope["path"].empty?
 
       sanitized_path = Pathname.new(sanitize_path(path))
-      site_path      = Pathname.new(@site.source)
       rel_scope_path = Pathname.new(scope["path"])
-      abs_scope_path = File.join(@site.source, rel_scope_path)
 
       if scope["path"].to_s.include?("*")
-        Dir.glob(abs_scope_path).each do |scope_path|
-          scope_path = Pathname.new(scope_path).relative_path_from(site_path)
-          scope_path = strip_collections_dir(scope_path)
-          Jekyll.logger.debug "Globbed Scope Path:", scope_path
-          return true if path_is_subpath?(sanitized_path, scope_path)
-        end
-        false
+        glob_scope(sanitized_path, rel_scope_path)
       else
         path_is_subpath?(sanitized_path, strip_collections_dir(rel_scope_path))
       end
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def glob_scope(sanitized_path, rel_scope_path)
+      site_source    = Pathname.new(@site.source)
+      abs_scope_path = site_source.join(rel_scope_path).to_s
+
+      glob_cache(abs_scope_path).each do |scope_path|
+        scope_path = Pathname.new(scope_path).relative_path_from(site_source)
+        scope_path = strip_collections_dir(scope_path)
+        Jekyll.logger.debug "Globbed Scope Path:", scope_path
+        return true if path_is_subpath?(sanitized_path, scope_path)
+      end
+      false
+    end
+
+    def glob_cache(path)
+      @glob_cache[path] ||= Dir.glob(path)
+    end
 
     def path_is_subpath?(path, parent_path)
       path.ascend do |ascended_path|
-        if ascended_path.to_s == parent_path.to_s
-          return true
-        end
+        return true if ascended_path.to_s == parent_path.to_s
       end
 
       false
@@ -134,6 +145,7 @@ module Jekyll
       collections_dir  = @site.config["collections_dir"]
       slashed_coll_dir = "#{collections_dir}/"
       return path if collections_dir.empty? || !path.to_s.start_with?(slashed_coll_dir)
+
       path.sub(slashed_coll_dir, "")
     end
 
@@ -188,8 +200,12 @@ module Jekyll
     #
     # Returns an array of hashes
     def matching_sets(path, type)
-      valid_sets.select do |set|
-        !set.key?("scope") || applies?(set["scope"], path, type)
+      @matched_set_cache ||= {}
+      @matched_set_cache[path] ||= {}
+      @matched_set_cache[path][type] ||= begin
+        valid_sets.select do |set|
+          !set.key?("scope") || applies?(set["scope"], path, type)
+        end
       end
     end
 
@@ -216,7 +232,7 @@ module Jekyll
 
     # Sanitizes the given path by removing a leading and adding a trailing slash
 
-    SANITIZATION_REGEX = %r!\A/|(?<=[^/])\z!
+    SANITIZATION_REGEX = %r!\A/|(?<=[^/])\z!.freeze
 
     def sanitize_path(path)
       if path.nil? || path.empty?