jekyll 3.8.7 → 4.1.0

data/lib/jekyll/commands/serve/websockets.rb

@@ -46,7 +46,7 @@ module Jekyll
           # WebSockets requests will have a Connection: Upgrade header
           if parser.http_method != "GET" || parser.upgrade?
             super
-          elsif parser.request_url =~ %r!^\/livereload.js!
+          elsif parser.request_url.start_with?("/livereload.js")
             headers = [
               "HTTP/1.1 200 OK",
               "Content-Type: application/javascript",

data/lib/jekyll/configuration.rb

@@ -4,11 +4,12 @@ module Jekyll
   class Configuration < Hash
     # Default options. Overridden by values in _config.yml.
     # Strings rather than symbols are used for compatibility with YAML.
-    DEFAULTS = Configuration[{
+    DEFAULTS = {
       # Where things are
       "source"              => Dir.pwd,
       "destination"         => File.join(Dir.pwd, "_site"),
       "collections_dir"     => "",
+      "cache_dir"           => ".jekyll-cache",
       "plugins_dir"         => "_plugins",
       "layouts_dir"         => "_layouts",
       "data_dir"            => "_data",
@@ -18,10 +19,7 @@ module Jekyll
       # Handling Reading
       "safe"                => false,
       "include"             => [".htaccess"],
-      "exclude"             => %w(
-        Gemfile Gemfile.lock node_modules vendor/bundle/ vendor/cache/ vendor/gems/
-        vendor/ruby/
-      ),
+      "exclude"             => [],
       "keep_files"          => [".git", ".svn"],
       "encoding"            => "utf-8",
       "markdown_ext"        => "markdown,mkdown,mkdn,mkd,md",
@@ -66,40 +64,29 @@ module Jekyll
         "strict_variables" => false,
       },
 
-      "rdiscount"           => {
-        "extensions" => [],
-      },
-
-      "redcarpet"           => {
-        "extensions" => [],
-      },
-
       "kramdown"            => {
         "auto_ids"      => true,
-        "toc_levels"    => "1..6",
+        "toc_levels"    => (1..6).to_a,
         "entity_output" => "as_char",
         "smart_quotes"  => "lsquo,rsquo,ldquo,rdquo",
         "input"         => "GFM",
         "hard_wrap"     => false,
+        "guess_lang"    => true,
         "footnote_nr"   => 1,
         "show_warnings" => false,
       },
-    }.map { |k, v| [k, v.freeze] }].freeze
+    }.each_with_object(Configuration.new) { |(k, v), hsh| hsh[k] = v.freeze }.freeze
 
     class << self
       # Static: Produce a Configuration ready for use in a Site.
-      # It takes the input, fills in the defaults where values do not
-      # exist, and patches common issues including migrating options for
-      # backwards compatiblity. Except where a key or value is being fixed,
-      # the user configuration will override the defaults.
+      # It takes the input, fills in the defaults where values do not exist.
       #
       # user_config - a Hash or Configuration of overrides.
       #
-      # Returns a Configuration filled with defaults and fixed for common
-      # problems and backwards-compatibility.
+      # Returns a Configuration filled with defaults.
       def from(user_config)
         Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
-          .add_default_collections
+          .add_default_collections.add_default_excludes
       end
     end
 
@@ -107,7 +94,7 @@ module Jekyll
     #
     # Return a copy of the hash where all its keys are strings
     def stringify_keys
-      reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) }
+      each_with_object({}) { |(k, v), hsh| hsh[k.to_s] = v }
     end
 
     def get_config_value_with_override(config_key, override)
@@ -141,8 +128,8 @@ module Jekyll
       when %r!\.ya?ml!i
         SafeYAML.load_file(filename) || {}
       else
-        raise ArgumentError, "No parser for '#{filename}' is available.
-          Use a .y(a)ml or .toml file instead."
+        raise ArgumentError,
+              "No parser for '#{filename}' is available. Use a .y(a)ml or .toml file instead."
       end
     end
 
@@ -161,7 +148,7 @@ module Jekyll
       # Get configuration from <source>/_config.yml or <source>/<config_file>
       config_files = override["config"]
       if config_files.to_s.empty?
-        default = %w(yml yaml).find(-> { "yml" }) do |ext|
+        default = %w(yml yaml toml).find(-> { "yml" }) do |ext|
           File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}"))
         end
         config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
@@ -176,8 +163,13 @@ module Jekyll
     #
     # Returns this configuration, overridden by the values in the file
     def read_config_file(file)
+      file = File.expand_path(file)
       next_config = safe_load_file(file)
-      check_config_is_hash!(next_config, file)
+
+      unless next_config.is_a?(Hash)
+        raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
+      end
+
       Jekyll.logger.info "Configuration file:", file
       next_config
     rescue SystemCallError
@@ -185,8 +177,7 @@ module Jekyll
         Jekyll.logger.warn "Configuration file:", "none"
         {}
       else
-        Jekyll.logger.error "Fatal:", "The configuration file '#{file}'
-          could not be found."
+        Jekyll.logger.error "Fatal:", "The configuration file '#{file}' could not be found."
         raise LoadError, "The Configuration file '#{file}' could not be found."
       end
     end
@@ -203,16 +194,16 @@ module Jekyll
       begin
         files.each do |config_file|
           next if config_file.nil? || config_file.empty?
+
           new_config = read_config_file(config_file)
           configuration = Utils.deep_merge_hashes(configuration, new_config)
         end
-      rescue ArgumentError => err
-        Jekyll.logger.warn "WARNING:", "Error reading configuration. " \
-                     "Using defaults (and options)."
-        warn err
+      rescue ArgumentError => e
+        Jekyll.logger.warn "WARNING:", "Error reading configuration. Using defaults (and options)."
+        warn e
       end
 
-      configuration.backwards_compatibilize.add_default_collections
+      configuration.validate.add_default_collections
     end
 
     # Public: Split a CSV string into an array containing its values
@@ -224,35 +215,18 @@ module Jekyll
       csv.split(",").map(&:strip)
     end
 
-    # Public: Ensure the proper options are set in the configuration to allow for
-    # backwards-compatibility with Jekyll pre-1.0
+    # Public: Ensure the proper options are set in the configuration
     #
-    # Returns the backwards-compatible configuration
-    def backwards_compatibilize
+    # Returns the configuration Hash
+    def validate
       config = clone
-      # Provide backwards-compatibility
-      check_auto(config)
-      check_server(config)
-      check_plugins(config)
-
-      renamed_key "server_port", "port", config
-      renamed_key "gems", "plugins", config
-      renamed_key "layouts", "layouts_dir", config
-      renamed_key "data_source", "data_dir", config
 
-      check_pygments(config)
+      check_plugins(config)
       check_include_exclude(config)
-      check_coderay(config)
-      check_maruku(config)
 
       config
     end
 
-    # DEPRECATED.
-    def fix_common_issues
-      self
-    end
-
     def add_default_collections
       config = clone
 
@@ -261,7 +235,9 @@ module Jekyll
 
       # Ensure we have a hash.
       if config["collections"].is_a?(Array)
-        config["collections"] = Hash[config["collections"].map { |c| [c, {}] }]
+        config["collections"] = config["collections"].each_with_object({}) do |collection, hash|
+          hash[collection] = {}
+        end
       end
 
       config["collections"] = Utils.deep_merge_hashes(
@@ -276,16 +252,23 @@ module Jekyll
       config
     end
 
-    def renamed_key(old, new, config, _ = nil)
-      if config.key?(old)
-        Jekyll::Deprecator.deprecation_message "The '#{old}' configuration" \
-          " option has been renamed to '#{new}'. Please update your config" \
-          " file accordingly."
-        config[new] = config.delete(old)
-      end
+    DEFAULT_EXCLUDES = %w(
+      .sass-cache .jekyll-cache
+      gemfiles Gemfile Gemfile.lock
+      node_modules
+      vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/
+    ).freeze
+
+    def add_default_excludes
+      config = clone
+      return config if config["exclude"].nil?
+
+      config["exclude"].concat(DEFAULT_EXCLUDES).uniq!
+      config
     end
 
     private
+
     def style_to_permalink(permalink_style)
       case permalink_style.to_sym
       when :pretty
@@ -296,89 +279,20 @@ module Jekyll
         "/:categories/:year/:month/:day/:title:output_ext"
       when :ordinal
         "/:categories/:year/:y_day/:title:output_ext"
+      when :weekdate
+        "/:categories/:year/W:week/:short_day/:title:output_ext"
       else
         permalink_style.to_s
       end
     end
 
-    # Private: Checks if a given config is a hash
-    #
-    # extracted_config - the value to check
-    # file - the file from which the config was extracted
-    #
-    # Raises an ArgumentError if given config is not a hash
-    private
-    def check_config_is_hash!(extracted_config, file)
-      unless extracted_config.is_a?(Hash)
-        raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
-      end
-    end
-
-    private
-    def check_auto(config)
-      if config.key?("auto") || config.key?("watch")
-        Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" \
-                            " be set from your configuration file(s). Use the" \
-                            " --[no-]watch/-w command-line option instead."
-        config.delete("auto")
-        config.delete("watch")
-      end
-    end
-
-    private
-    def check_server(config)
-      if config.key?("server")
-        Jekyll::Deprecator.deprecation_message "The 'server' configuration option" \
-                            " is no longer accepted. Use the 'jekyll serve'" \
-                            " subcommand to serve your site with WEBrick."
-        config.delete("server")
-      end
-    end
-
-    private
-    def check_pygments(config)
-      if config.key?("pygments")
-        Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option" \
-                            " has been renamed to 'highlighter'. Please update your" \
-                            " config file accordingly. The allowed values are 'rouge', " \
-                            "'pygments' or null."
-
-        config["highlighter"] = "pygments" if config["pygments"]
-        config.delete("pygments")
-      end
-    end
-
-    private
     def check_include_exclude(config)
       %w(include exclude).each do |option|
-        if config[option].is_a?(String)
-          Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option" \
-            " must now be specified as an array, but you specified" \
-            " a string. For now, we've treated the string you provided" \
-            " as a list of comma-separated values."
-          config[option] = csv_to_array(config[option])
-        end
-        config[option].map!(&:to_s) if config[option]
-      end
-    end
+        next unless config.key?(option)
+        next if config[option].is_a?(Array)
 
-    private
-    def check_coderay(config)
-      if (config["kramdown"] || {}).key?("use_coderay")
-        Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" \
-          " to 'enable_coderay' in your configuration file."
-        config["kramdown"]["use_coderay"] = config["kramdown"].delete("enable_coderay")
-      end
-    end
-
-    private
-    def check_maruku(config)
-      if config.fetch("markdown", "kramdown").to_s.casecmp("maruku").zero?
-        Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " \
-          "Markdown processor, which has been removed as of 3.0.0. " \
-          "We recommend you switch to Kramdown. To do this, replace " \
-          "`markdown: maruku` with `markdown: kramdown` in your " \
-          "`_config.yml` file."
+        raise Jekyll::Errors::InvalidConfigurationError,
+              "'#{option}' should be set as an array, but was: #{config[option].inspect}."
       end
     end
 
@@ -387,18 +301,16 @@ module Jekyll
     # config - the config hash
     #
     # Raises a Jekyll::Errors::InvalidConfigurationError if the config `plugins`
-    # is a string
-    private
+    # is not an Array.
     def check_plugins(config)
-      if config.key?("plugins") && config["plugins"].is_a?(String)
-        Jekyll.logger.error "Configuration Error:", "You specified the" \
-          " `plugins` config in your configuration file as a string, please" \
-          " use an array instead. If you wanted to set the directory of your" \
-          " plugins, use the config key `plugins_dir` instead."
-        raise Jekyll::Errors::InvalidConfigurationError,
-          "'plugins' should not be a string, but was: " \
-          "#{config["plugins"].inspect}. Use 'plugins_dir' instead."
-      end
+      return unless config.key?("plugins")
+      return if config["plugins"].is_a?(Array)
+
+      Jekyll.logger.error "'plugins' should be set as an array of gem-names, but was: " \
+        "#{config["plugins"].inspect}. Use 'plugins_dir' instead to set the directory " \
+        "for your non-gemified Ruby plugins."
+      raise Jekyll::Errors::InvalidConfigurationError,
+            "'plugins' should be set as an array, but was: #{config["plugins"].inspect}."
     end
   end
 end

data/lib/jekyll/converters/identity.rb

@@ -2,19 +2,37 @@
 
 module Jekyll
   module Converters
+    # Identity converter. Returns same content as given.
+    # For more info on converters see https://jekyllrb.com/docs/plugins/converters/
     class Identity < Converter
       safe true
 
       priority :lowest
 
+      # Public: Does the given extension match this converter's list of acceptable extensions?
+      # Takes one argument: the file's extension (including the dot).
+      #
+      # _ext - The String extension to check (not relevant here)
+      #
+      # Returns true since it always matches.
       def matches(_ext)
         true
       end
 
+      # Public: The extension to be given to the output file (including the dot).
+      #
+      # ext - The String extension or original file.
+      #
+      # Returns The String output file extension.
       def output_ext(ext)
         ext
       end
 
+      # Logic to do the content conversion.
+      #
+      # content - String content of file (without front matter).
+      #
+      # Returns a String of the converted content.
       def convert(content)
         content
       end

data/lib/jekyll/converters/markdown.rb

@@ -2,6 +2,8 @@
 
 module Jekyll
   module Converters
+    # Markdown converter.
+    # For more info on converters see https://jekyllrb.com/docs/plugins/converters/
     class Markdown < Converter
       highlighter_prefix "\n"
       highlighter_suffix "\n"
@@ -9,80 +11,91 @@ module Jekyll
 
       def setup
         return if @setup ||= false
+
         unless (@parser = get_processor)
-          Jekyll.logger.error "Invalid Markdown processor given:", @config["markdown"]
           if @config["safe"]
-            Jekyll.logger.info "", "Custom processors are not loaded in safe mode"
+            Jekyll.logger.warn "Build Warning:", "Custom processors are not loaded in safe mode"
           end
-          Jekyll.logger.error(
-            "",
-            "Available processors are: #{valid_processors.join(", ")}"
-          )
-          raise Errors::FatalException, "Bailing out; invalid Markdown processor."
+
+          Jekyll.logger.error "Markdown processor:",
+                              "#{@config["markdown"].inspect} is not a valid Markdown processor."
+          Jekyll.logger.error "", "Available processors are: #{valid_processors.join(", ")}"
+          Jekyll.logger.error ""
+          raise Errors::FatalException, "Invalid Markdown processor given: #{@config["markdown"]}"
         end
 
+        @cache = Jekyll::Cache.new("Jekyll::Converters::Markdown")
         @setup = true
       end
 
-      # Rubocop does not allow reader methods to have names starting with `get_`
+      # RuboCop does not allow reader methods to have names starting with `get_`
       # To ensure compatibility, this check has been disabled on this method
       #
       # rubocop:disable Naming/AccessorMethodName
       def get_processor
         case @config["markdown"].downcase
-        when "redcarpet" then return RedcarpetParser.new(@config)
-        when "kramdown"  then return KramdownParser.new(@config)
-        when "rdiscount" then return RDiscountParser.new(@config)
+        when "kramdown" then KramdownParser.new(@config)
         else
           custom_processor
         end
       end
       # rubocop:enable Naming/AccessorMethodName
 
-      # Public: Provides you with a list of processors, the ones we
-      # support internally and the ones that you have provided to us (if you
-      # are not in safe mode.)
-
+      # Public: Provides you with a list of processors comprised of the ones we support internally
+      # and the ones that you have provided to us (if they're whitelisted for use in safe mode).
+      #
+      # Returns an array of symbols.
       def valid_processors
-        %w(rdiscount kramdown redcarpet) + third_party_processors
+        [:kramdown] + third_party_processors
       end
 
       # Public: A list of processors that you provide via plugins.
-      # This is really only available if you are not in safe mode, if you are
-      # in safe mode (re: GitHub) then there will be none.
-
+      #
+      # Returns an array of symbols
       def third_party_processors
-        self.class.constants - \
-          %w(KramdownParser RDiscountParser RedcarpetParser PRIORITIES).map(
-            &:to_sym
-          )
-      end
-
-      def extname_list
-        @extname_list ||= @config["markdown_ext"].split(",").map do |e|
-          ".#{e.downcase}"
-        end
+        self.class.constants - [:KramdownParser, :PRIORITIES]
       end
 
+      # Does the given extension match this converter's list of acceptable extensions?
+      # Takes one argument: the file's extension (including the dot).
+      #
+      # ext - The String extension to check.
+      #
+      # Returns true if it matches, false otherwise.
       def matches(ext)
         extname_list.include?(ext.downcase)
       end
 
+      # Public: The extension to be given to the output file (including the dot).
+      #
+      # ext - The String extension or original file.
+      #
+      # Returns The String output file extension.
       def output_ext(_ext)
         ".html"
       end
 
+      # Logic to do the content conversion.
+      #
+      # content - String content of file (without front matter).
+      #
+      # Returns a String of the converted content.
       def convert(content)
         setup
-        @parser.convert(content)
+        @cache.getset(content) do
+          @parser.convert(content)
+        end
+      end
+
+      def extname_list
+        @extname_list ||= @config["markdown_ext"].split(",").map! { |e| ".#{e.downcase}" }
       end
 
       private
+
       def custom_processor
         converter_name = @config["markdown"]
-        if custom_class_allowed?(converter_name)
-          self.class.const_get(converter_name).new(@config)
-        end
+        self.class.const_get(converter_name).new(@config) if custom_class_allowed?(converter_name)
       end
 
       # Private: Determine whether a class name is an allowed custom
@@ -90,14 +103,10 @@ module Jekyll
       #
       # parser_name - the name of the parser class
       #
-      # Returns true if the parser name contains only alphanumeric
-      # characters and is defined within Jekyll::Converters::Markdown
-
-      private
+      # Returns true if the parser name contains only alphanumeric characters and is defined
+      # within Jekyll::Converters::Markdown
       def custom_class_allowed?(parser_name)
-        parser_name !~ %r![^A-Za-z0-9_]! && self.class.constants.include?(
-          parser_name.to_sym
-        )
+        parser_name !~ %r![^A-Za-z0-9_]! && self.class.constants.include?(parser_name.to_sym)
       end
     end
   end