jekyll 4.0.0.pre.alpha1 → 4.1.1

data/lib/jekyll/collection.rb

@@ -75,11 +75,13 @@ module Jekyll
     def entries
       return [] unless exists?
 
-      @entries ||=
+      @entries ||= begin
+        collection_dir_slash = "#{collection_dir}/"
         Utils.safe_glob(collection_dir, ["**", "*"], File::FNM_DOTMATCH).map do |entry|
-          entry["#{collection_dir}/"] = ""
+          entry[collection_dir_slash] = ""
           entry
         end
+      end
     end
 
     # Filtered version of the entries in this collection.
@@ -164,7 +166,7 @@ module Jekyll
     #
     # Returns a sanitized version of the label.
     def sanitize_label(label)
-      label.gsub(%r![^a-z0-9_\-\.]!i, "")
+      label.gsub(%r![^a-z0-9_\-.]!i, "")
     end
 
     # Produce a representation of this Collection for use in Liquid.
@@ -237,7 +239,7 @@ module Jekyll
 
         # Fall back to `Document#<=>` if the properties were equal or were non-sortable
         # Otherwise continue with current sort-order
-        if order.zero? || order.nil?
+        if order.nil? || order.zero?
           apples[-1] <=> olives[-1]
         else
           order

data/lib/jekyll/command.rb

@@ -67,6 +67,8 @@ module Jekyll
         cmd.option "show_drafts", "-D", "--drafts", "Render posts in the _drafts folder"
         cmd.option "unpublished", "--unpublished",
                    "Render posts that were marked as unpublished"
+        cmd.option "disable_disk_cache", "--disable-disk-cache",
+                   "Disable caching to disk in non-safe mode"
         cmd.option "quiet", "-q", "--quiet", "Silence output."
         cmd.option "verbose", "-V", "--verbose", "Print verbose output."
         cmd.option "incremental", "-I", "--incremental", "Enable incremental rebuild."
@@ -84,7 +86,7 @@ module Jekyll
       # klass   - an array of Jekyll::Command subclasses associated with the command
       #
       # Note that all exceptions are rescued..
-      # rubocop: disable RescueException
+      # rubocop: disable Lint/RescueException
       def process_with_graceful_fail(cmd, options, *klass)
         klass.each { |k| k.process(options) if k.respond_to?(:process) }
       rescue Exception => e
@@ -97,7 +99,7 @@ module Jekyll
         Jekyll.logger.error "", " for any additional information or backtrace. "
         Jekyll.logger.abort_with "", dashes
       end
-      # rubocop: enable RescueException
+      # rubocop: enable Lint/RescueException
     end
   end
 end

data/lib/jekyll/commands/new.rb

@@ -80,24 +80,24 @@ module Jekyll
             # Happy Jekylling!
             gem "jekyll", "~> #{Jekyll::VERSION}"
             # This is the default theme for new Jekyll sites. You may change this to anything you like.
-            gem "minima", "~> 2.0"
+            gem "minima", "~> 2.5"
             # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
             # uncomment the line below. To upgrade, run `bundle update github-pages`.
             # gem "github-pages", group: :jekyll_plugins
             # If you have any plugins, put them here!
             group :jekyll_plugins do
-              gem "jekyll-feed", "~> 0.6"
+              gem "jekyll-feed", "~> 0.12"
             end
 
             # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
             # and associated library.
-            install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
+            platforms :mingw, :x64_mingw, :mswin, :jruby do
               gem "tzinfo", "~> 1.2"
               gem "tzinfo-data"
             end
 
             # Performance-booster for watching directories on Windows
-            gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
+            gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
 
           RUBY
         end

data/lib/jekyll/commands/serve.rb

@@ -307,7 +307,15 @@ module Jekyll
           require "webrick/https"
 
           opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(read_file(src, cert))
-          opts[:SSLPrivateKey]  = OpenSSL::PKey::RSA.new(read_file(src, key))
+          begin
+            opts[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(read_file(src, key))
+          rescue StandardError
+            if defined?(OpenSSL::PKey::EC)
+              opts[:SSLPrivateKey] = OpenSSL::PKey::EC.new(read_file(src, key))
+            else
+              raise
+            end
+          end
           opts[:SSLEnable] = true
         end
 

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

@@ -29,15 +29,15 @@ module Jekyll
         end
 
         def inline?
-          @response["Content-Disposition"] =~ %r!^inline!
+          @response["Content-Disposition"].to_s.start_with?("inline")
         end
 
         def bad_browser?
-          BAD_USER_AGENTS.any? { |pattern| @request["User-Agent"] =~ pattern }
+          BAD_USER_AGENTS.any? { |pattern| pattern.match?(@request["User-Agent"]) }
         end
 
         def html?
-          @response["Content-Type"] =~ %r!text/html!
+          @response["Content-Type"].to_s.include?("text/html")
         end
       end
 
@@ -98,17 +98,16 @@ module Jekyll
           # Complicated JavaScript to ensure that livereload.js is loaded from the
           # same origin as the page.  Mostly useful for dealing with the browser's
           # distinction between 'localhost' and 127.0.0.1
-          template = <<-TEMPLATE
-          <script>
-            document.write(
-              '<script src="http://' +
-              (location.host || 'localhost').split(':')[0] +
-              ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
-              '></' +
-              'script>');
-          </script>
+          @template ||= ERB.new(<<~TEMPLATE)
+            <script>
+              document.write(
+                '<script src="http://' +
+                (location.host || 'localhost').split(':')[0] +
+                ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
+                '></' +
+                'script>');
+            </script>
           TEMPLATE
-          ERB.new(Jekyll::Utils.strip_heredoc(template))
         end
 
         def livereload_args
@@ -186,7 +185,7 @@ module Jekyll
           key = res.header.keys.grep(%r!content-type!i).first
           typ = res.header[key]
 
-          unless typ =~ %r!;\s*charset=!
+          unless %r!;\s*charset=!.match?(typ)
             res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
           end
         end

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,7 +4,7 @@ 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"),
@@ -66,7 +66,7 @@ module Jekyll
 
       "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",
@@ -75,19 +75,15 @@ module Jekyll
         "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_excludes
@@ -98,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)
@@ -132,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
 
@@ -169,7 +165,11 @@ module Jekyll
     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
@@ -177,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
@@ -199,13 +198,12 @@ module Jekyll
           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
@@ -217,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
 
@@ -254,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(
@@ -284,15 +267,6 @@ module Jekyll
       config
     end
 
-    def renamed_key(old, new, config)
-      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
-    end
-
     private
 
     def style_to_permalink(permalink_style)
@@ -305,82 +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
-    def check_config_is_hash!(extracted_config, file)
-      unless extracted_config.is_a?(Hash)
-        raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
-      end
-    end
-
-    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
-
-    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
-
-    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
-
     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)
-      end
-    end
+        next unless config.key?(option)
+        next if config[option].is_a?(Array)
 
-    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
-
-    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
 
@@ -389,17 +301,16 @@ module Jekyll
     # config - the config hash
     #
     # Raises a Jekyll::Errors::InvalidConfigurationError if the config `plugins`
-    # is a string
+    # 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