jekyll 3.4.5 → 3.5.0

data/lib/jekyll/document.rb

@@ -3,10 +3,13 @@
 module Jekyll
   class Document
     include Comparable
+    extend Forwardable
 
     attr_reader :path, :site, :extname, :collection
     attr_accessor :content, :output
 
+    def_delegator :self, :read_post_data, :post_read
+
     YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m
     DATELESS_FILENAME_MATCHER = %r!^(?:.+/)*(.*)(\.[^.]+)$!
     DATE_FILENAME_MATCHER = %r!^(?:.+/)*(\d{2,4}-\d{1,2}-\d{1,2})-(.*)(\.[^.]+)$!
@@ -147,7 +150,7 @@ module Jekyll
     #
     # Returns true if extname == .coffee, false otherwise.
     def coffeescript_file?
-      ".coffee" == extname
+      extname == ".coffee"
     end
 
     # Determine whether the file should be rendered with Liquid.
@@ -158,12 +161,19 @@ module Jekyll
       !(coffeescript_file? || yaml_file?)
     end
 
+    # Determine whether the file should be rendered with a layout.
+    #
+    # Returns true if the Front Matter specifies that `layout` is set to `none`.
+    def no_layout?
+      data["layout"] == "none"
+    end
+
     # Determine whether the file should be placed into layouts.
     #
-    # Returns false if the document is either an asset file or a yaml file,
-    #   true otherwise.
+    # Returns false if the document is set to `layouts: none`, or is either an
+    #   asset file or a yaml file. Returns true otherwise.
     def place_in_layout?
-      !(asset_file? || yaml_file?)
+      !(asset_file? || yaml_file? || no_layout?)
     end
 
     # The URL template where the document would be accessible.
@@ -256,11 +266,8 @@ module Jekyll
           merge_defaults
           read_content(opts)
           read_post_data
-        rescue SyntaxError => e
-          Jekyll.logger.error "Error:", "YAML Exception reading #{path}: #{e.message}"
         rescue => e
-          raise e if e.is_a? Jekyll::Errors::FatalException
-          Jekyll.logger.error "Error:", "could not read file #{path}: #{e.message}"
+          handle_read_error(e)
         end
       end
     end
@@ -364,7 +371,7 @@ module Jekyll
       if data.key?(method.to_s)
         Jekyll::Deprecator.deprecation_message "Document##{method} is now a key "\
                            "in the #data hash."
-        Jekyll::Deprecator.deprecation_message "Called by #{caller.first}."
+        Jekyll::Deprecator.deprecation_message "Called by #{caller(0..0)}."
         data[method.to_s]
       else
         super
@@ -375,6 +382,38 @@ module Jekyll
       data.key?(method.to_s) || super
     end
 
+    # Add superdirectories of the special_dir to categories.
+    # In the case of es/_posts, 'es' is added as a category.
+    # In the case of _posts/es, 'es' is NOT added as a category.
+    #
+    # Returns nothing.
+    def categories_from_path(special_dir)
+      superdirs = relative_path.sub(%r!#{special_dir}(.*)!, "")
+        .split(File::SEPARATOR)
+        .reject do |c|
+        c.empty? || c == special_dir || c == basename
+      end
+      merge_data!({ "categories" => superdirs }, :source => "file path")
+    end
+
+    def populate_categories
+      merge_data!({
+        "categories" => (
+        Array(data["categories"]) + Utils.pluralized_array_from_hash(
+          data,
+          "category",
+          "categories"
+        )
+        ).map(&:to_s).flatten.uniq,
+      })
+    end
+
+    def populate_tags
+      merge_data!({
+        "tags" => Utils.pluralized_array_from_hash(data, "tag", "tags").flatten,
+      })
+    end
+
     private
     def merge_categories!(other)
       if other.key?("categories") && !other["categories"].nil?
@@ -422,6 +461,19 @@ module Jekyll
       generate_excerpt
     end
 
+    private
+    def handle_read_error(error)
+      if error.is_a? SyntaxError
+        Jekyll.logger.error "Error:", "YAML Exception reading #{path}: #{error.message}"
+      else
+        Jekyll.logger.error "Error:", "could not read file #{path}: #{error.message}"
+      end
+
+      if site.config["strict_front_matter"] || error.is_a?(Jekyll::Errors::FatalException)
+        raise error
+      end
+    end
+
     private
     def populate_title
       if relative_path =~ DATE_FILENAME_MATCHER
@@ -445,41 +497,6 @@ module Jekyll
       end
     end
 
-    # Add superdirectories of the special_dir to categories.
-    # In the case of es/_posts, 'es' is added as a category.
-    # In the case of _posts/es, 'es' is NOT added as a category.
-    #
-    # Returns nothing.
-    private
-    def categories_from_path(special_dir)
-      superdirs = relative_path.sub(%r!#{special_dir}(.*)!, "")
-        .split(File::SEPARATOR)
-        .reject do |c|
-        c.empty? || c == special_dir || c == basename
-      end
-      merge_data!({ "categories" => superdirs }, :source => "file path")
-    end
-
-    private
-    def populate_categories
-      merge_data!({
-        "categories" => (
-        Array(data["categories"]) + Utils.pluralized_array_from_hash(
-          data,
-          "category",
-          "categories"
-        )
-        ).map(&:to_s).flatten.uniq,
-      })
-    end
-
-    private
-    def populate_tags
-      merge_data!({
-        "tags" => Utils.pluralized_array_from_hash(data, "tag", "tags").flatten,
-      })
-    end
-
     private
     def generate_excerpt
       if generate_excerpt?

data/lib/jekyll/drops/site_drop.rb

@@ -19,6 +19,10 @@ module Jekyll
         end
       end
 
+      def key?(key)
+        (@obj.collections.key?(key) && key != "posts") || super
+      end
+
       def posts
         @site_posts ||= @obj.posts.docs.sort { |a, b| b <=> a }
       end

data/lib/jekyll/entry_filter.rb

@@ -36,7 +36,8 @@ module Jekyll
     end
 
     def included?(entry)
-      glob_include?(site.include, entry)
+      glob_include?(site.include, entry) ||
+        glob_include?(site.include, File.basename(entry))
     end
 
     def special?(entry)

data/lib/jekyll/errors.rb

@@ -9,9 +9,10 @@ module Jekyll
     InvalidYAMLFrontMatterError = Class.new(FatalException)
     MissingDependencyException  = Class.new(FatalException)
 
-    InvalidDateError      = Class.new(FatalException)
-    InvalidPostNameError  = Class.new(FatalException)
-    PostURLError          = Class.new(FatalException)
-    InvalidURLError       = Class.new(FatalException)
+    InvalidDateError            = Class.new(FatalException)
+    InvalidPostNameError        = Class.new(FatalException)
+    PostURLError                = Class.new(FatalException)
+    InvalidURLError             = Class.new(FatalException)
+    InvalidConfigurationError   = Class.new(FatalException)
   end
 end

data/lib/jekyll/external.rb

@@ -23,12 +23,25 @@ module Jekyll
             require name
           rescue LoadError
             Jekyll.logger.debug "Couldn't load #{name}. Skipping."
-            yield(name) if block_given?
+            yield(name, version_constraint(name)) if block_given?
             false
           end
         end
       end
 
+      #
+      # The version constraint required to activate a given gem.
+      # Usually the gem version requirement is "> 0," because any version
+      # will do. In the case of jekyll-docs, however, we require the exact
+      # same version as Jekyll.
+      #
+      # Returns a String version constraint in a parseable form for
+      # RubyGems.
+      def version_constraint(gem_name)
+        return "= #{Jekyll::VERSION}" if gem_name.to_s.eql?("jekyll-docs")
+        "> 0"
+      end
+
       #
       # Require a gem or gems. If it's not present, show a very nice error
       # message that explains everything and is much more helpful than the

data/lib/jekyll/filters.rb

@@ -80,6 +80,7 @@ module Jekyll
     #
     # Returns the formatted String.
     def date_to_long_string(date)
+      return date if date.to_s.empty?
       time(date).strftime("%d %B %Y")
     end
 
@@ -94,6 +95,7 @@ module Jekyll
     #
     # Returns the formatted String.
     def date_to_xmlschema(date)
+      return date if date.to_s.empty?
       time(date).xmlschema
     end
 
@@ -108,6 +110,7 @@ module Jekyll
     #
     # Returns the formatted String.
     def date_to_rfc822(date)
+      return date if date.to_s.empty?
       time(date).rfc822
     end
 
@@ -280,10 +283,11 @@ module Jekyll
       end
     end
 
-    def pop(array, input = 1)
+    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(input.to_i || 1)
+      new_ary.pop(num)
       new_ary
     end
 
@@ -294,10 +298,11 @@ module Jekyll
       new_ary
     end
 
-    def shift(array, input = 1)
+    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(input.to_i || 1)
+      new_ary.shift(num)
       new_ary
     end
 
@@ -310,11 +315,11 @@ module Jekyll
 
     def sample(input, num = 1)
       return input unless input.respond_to?(:sample)
-      n = num.to_i rescue 1
-      if n == 1
+      num = Liquid::Utils.to_integer(num) rescue 1
+      if num == 1
         input.sample
       else
-        input.sample(n)
+        input.sample(num)
       end
     end
 
@@ -345,25 +350,20 @@ module Jekyll
 
     private
     def time(input)
-      case input
-      when Time
-        input.clone
-      when Date
-        input.to_time
-      when String
-        Time.parse(input) rescue Time.at(input.to_i)
-      when Numeric
-        Time.at(input)
-      else
+      date = Liquid::Utils.to_date(input)
+      unless date.respond_to?(:to_time)
         raise Errors::InvalidDateError,
           "Invalid Date: '#{input.inspect}' is not a valid datetime."
-      end.localtime
+      end
+      date.to_time.dup.localtime
     end
 
     private
     def item_property(item, property)
       if item.respond_to?(:to_liquid)
-        item.to_liquid[property.to_s]
+        property.to_s.split(".").reduce(item.to_liquid) do |subvalue, attribute|
+          subvalue[attribute]
+        end
       elsif item.respond_to?(:data)
         item.data[property.to_s]
       else
@@ -402,9 +402,11 @@ module Jekyll
       operator = parser.consume?(:comparison)
       condition =
         if operator
-          Liquid::Condition.new(left_expr, operator, parser.expression)
+          Liquid::Condition.new(Liquid::Expression.parse(left_expr),
+                                operator,
+                                Liquid::Expression.parse(parser.expression))
         else
-          Liquid::Condition.new(left_expr)
+          Liquid::Condition.new(Liquid::Expression.parse(left_expr))
         end
       parser.consume(:end_of_string)
 

data/lib/jekyll/filters/grouping_filters.rb

@@ -40,7 +40,7 @@ module Jekyll
 
       private
       def parse_expression(str)
-        Liquid::Variable.new(str, {})
+        Liquid::Variable.new(str, Liquid::ParseContext.new)
       end
 
       private

data/lib/jekyll/filters/url_filters.rb

@@ -10,7 +10,7 @@ module Jekyll
       # Returns the absolute URL as a String.
       def absolute_url(input)
         return if input.nil?
-        site = @context.registers[:site]
+        return input if Addressable::URI.parse(input).absolute?
         return relative_url(input).to_s if site.config["url"].nil?
         Addressable::URI.parse(site.config["url"] + relative_url(input)).normalize.to_s
       end
@@ -22,14 +22,32 @@ module Jekyll
       # Returns a URL relative to the domain root as a String.
       def relative_url(input)
         return if input.nil?
-        site = @context.registers[:site]
-        parts = [site.config["baseurl"], input]
+        return ensure_leading_slash(input.to_s) if sanitized_baseurl.nil?
         Addressable::URI.parse(
-          parts.compact.map { |part| ensure_leading_slash(part.to_s) }.join
+          ensure_leading_slash(sanitized_baseurl) + ensure_leading_slash(input.to_s)
         ).normalize.to_s
       end
 
+      # Strips trailing `/index.html` from URLs to create pretty permalinks
+      #
+      # input - the URL with a possible `/index.html`
+      #
+      # 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
+
       private
+
+      def site
+        @context.registers[:site]
+      end
+
+      def sanitized_baseurl
+        site.config["baseurl"].to_s.chomp("/")
+      end
+
       def ensure_leading_slash(input)
         return input if input.nil? || input.empty? || input.start_with?("/")
         "/#{input}"

data/lib/jekyll/hooks.rb

@@ -60,7 +60,7 @@ module Jekyll
 
     # register a single hook to be called later, internal API
     def self.register_one(owner, event, priority, &block)
-      @registry[owner] ||={
+      @registry[owner] ||= {
         :post_init   => [],
         :pre_render  => [],
         :post_render => [],

data/lib/jekyll/liquid_renderer/table.rb

@@ -32,7 +32,7 @@ module Jekyll
 
       row_data.each_index do |cell_index|
         str << "-" * widths[cell_index]
-        str << "-+-" unless cell_index == row_data.length-1
+        str << "-+-" unless cell_index == row_data.length - 1
       end
 
       str << "\n"
@@ -49,7 +49,7 @@ module Jekyll
                  cell_data.rjust(widths[cell_index], " ")
                end
 
-        str << " | " unless cell_index == row_data.length-1
+        str << " | " unless cell_index == row_data.length - 1
       end
 
       str << "\n"

data/lib/jekyll/page.rb

@@ -127,7 +127,7 @@ module Jekyll
     # layouts      - The Hash of {"name" => "layout"}.
     # site_payload - The site payload Hash.
     #
-    # Returns nothing.
+    # Returns String rendered page.
     def render(layouts, site_payload)
       site_payload["page"] = to_liquid
       site_payload["paginator"] = pager.to_liquid

data/lib/jekyll/plugin.rb

@@ -60,7 +60,7 @@ module Jekyll
     #
     # Returns the safety Boolean.
     def self.safe(safe = nil)
-      if !defined?(@safe) || !safe.nil?
+      unless defined?(@safe) && safe.nil?
         @safe = safe
       end
       @safe || false

data/lib/jekyll/plugin_manager.rb

@@ -15,6 +15,7 @@ module Jekyll
     #
     # Returns nothing
     def conscientious_require
+      require_theme_deps if site.theme
       require_plugin_files
       require_gems
       deprecation_checks
@@ -25,10 +26,21 @@ module Jekyll
     # Returns nothing.
     def require_gems
       Jekyll::External.require_with_graceful_fail(
-        site.gems.select { |gem| plugin_allowed?(gem) }
+        site.gems.select { |plugin| plugin_allowed?(plugin) }
       )
     end
 
+    # Require each of the runtime_dependencies specified by the theme's gemspec.
+    #
+    # 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
+
     def self.require_from_bundler
       if !ENV["JEKYLL_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
         require "bundler"
@@ -47,12 +59,12 @@ module Jekyll
 
     # Check whether a gem plugin is allowed to be used during this build.
     #
-    # gem_name - the name of the gem
+    # plugin_name - the name of the plugin
     #
-    # Returns true if the gem name is in the whitelist or if the site is not
+    # Returns true if the plugin name is in the whitelist or if the site is not
     #   in safe mode.
-    def plugin_allowed?(gem_name)
-      !site.safe || whitelist.include?(gem_name)
+    def plugin_allowed?(plugin_name)
+      !site.safe || whitelist.include?(plugin_name)
     end
 
     # Build an array of allowed plugin gem names.
@@ -87,12 +99,12 @@ module Jekyll
     end
 
     def deprecation_checks
-      pagination_included = (site.config["gems"] || []).include?("jekyll-paginate") ||
+      pagination_included = (site.config["plugins"] || []).include?("jekyll-paginate") ||
         defined?(Jekyll::Paginate)
       if site.config["paginate"] && !pagination_included
         Jekyll::Deprecator.deprecation_message "You appear to have pagination " \
           "turned on, but you haven't included the `jekyll-paginate` gem. " \
-          "Ensure you have `gems: [jekyll-paginate]` in your configuration file."
+          "Ensure you have `plugins: [jekyll-paginate]` in your configuration file."
       end
     end
   end