jekyll 4.0.0.pre.alpha1 → 4.0.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1510de5e88a3e6d48fa5eb7686dfafc1cf94b820cd9b44fdd635bff9c306d98b
-  data.tar.gz: e4f444b21baf087d33f3dd7040c17b2fa00f5ed4a32f3602ee26722d4270ebc3
+  metadata.gz: 557bf944b97df515f8ac16b41b21317a4361fa27e45c44d63ea8579e14a8188e
+  data.tar.gz: 436685ee32413cf98111372ca82f1f39d38f549cc2cf482c86a1aba53e627b93
 SHA512:
-  metadata.gz: 854691fcc3090fe0292767b7aaa5c20504d5d11c08c9f301398cc5af70d387c002ad804fdf20a1583ab4a93d326425aff205b89554860c6babb84f6154923b85
-  data.tar.gz: ef22dd4eea32776ef7f25748241f1236431b8fd566bb377d8d66a657ade71e5de836ea149f7c7e0ff3483f471e8da801915261c6e0a110e97a43970707b3b05c
+  metadata.gz: 76c7cfa113e1a0741584a34be45ed4380e57250d1829d905d4aa1bba33ec06d6e1debf02a474ab36aca8f65ff1f4fca9cb97ce06c52e74715327267bb2bb5345
+  data.tar.gz: 4f25d89074b8aae2dfdcad4a56246b7541137e5a226040898e13b0f610acce79e8d8aaee0c63ea7aae185d09156b85643269440d6a02bc59dac8e2d26033e4af

data/.rubocop.yml

@@ -1,6 +1,7 @@
 ---
 
 require:
+  - rubocop-performance
   - ./rubocop/jekyll
 
 Jekyll/NoPutsAllowed:
@@ -8,7 +9,7 @@ Jekyll/NoPutsAllowed:
     - rake/*.rake
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Include:
     - lib/**/*.rb
     - test/**/*.rb
@@ -23,9 +24,9 @@ Layout/AlignHash:
   EnforcedHashRocketStyle: table
 Layout/IndentationWidth:
   Severity: error
-Layout/IndentArray:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented

data/lib/jekyll.rb

@@ -65,6 +65,7 @@ module Jekyll
   autoload :LogAdapter,          "jekyll/log_adapter"
   autoload :Page,                "jekyll/page"
   autoload :PageWithoutAFile,    "jekyll/page_without_a_file"
+  autoload :PathManager,         "jekyll/path_manager"
   autoload :PluginManager,       "jekyll/plugin_manager"
   autoload :Publisher,           "jekyll/publisher"
   autoload :Reader,              "jekyll/reader"

data/lib/jekyll/cache.rb

@@ -4,9 +4,59 @@ require "digest"
 
 module Jekyll
   class Cache
-    # rubocop:disable Style/ClassVars
-    @@caches = {}
-    @@disk_cache_enabled = true
+    # class-wide base cache
+    @base_cache = {}
+
+    # class-wide directive to write cache to disk is enabled by default
+    @disk_cache_enabled = true
+
+    class << self
+      # class-wide cache location
+      attr_accessor :cache_dir
+
+      # class-wide directive to write cache to disk
+      attr_reader :disk_cache_enabled
+
+      # class-wide base cache reader
+      attr_reader :base_cache
+
+      # Disable Marshaling cached items to disk
+      def disable_disk_cache!
+        @disk_cache_enabled = false
+      end
+
+      # Clear all caches
+      def clear
+        delete_cache_files
+        base_cache.each_value(&:clear)
+      end
+
+      # Compare the current config to the cached config
+      # If they are different, clear all caches
+      #
+      # Returns nothing.
+      def clear_if_config_changed(config)
+        config = config.inspect
+        cache = Jekyll::Cache.new "Jekyll::Cache"
+        return if cache.key?("config") && cache["config"] == config
+
+        clear
+        cache = Jekyll::Cache.new "Jekyll::Cache"
+        cache["config"] = config
+        nil
+      end
+
+      private
+
+      # Delete all cached items from all caches
+      #
+      # Returns nothing.
+      def delete_cache_files
+        FileUtils.rm_rf(@cache_dir) if disk_cache_enabled
+      end
+    end
+
+    #
 
     # Get an existing named cache, or create a new one if none exists
     #
@@ -14,27 +64,10 @@ module Jekyll
     #
     # Returns nothing.
     def initialize(name)
-      @cache = @@caches[name] ||= {}
+      @cache = Jekyll::Cache.base_cache[name] ||= {}
       @name = name.gsub(%r![^\w\s-]!, "-")
     end
 
-    # Set class-wide base_dir
-    def self.base_dir=(dir_path)
-      @@base_dir = dir_path
-    end
-
-    # Disable Marshaling cached items to disk
-    def self.disable_disk_cache!
-      @@disk_cache_enabled = false
-    end
-    # rubocop:enable Style/ClassVars
-
-    # Clear all caches
-    def self.clear
-      delete_cache_files
-      @@caches.each_value(&:clear)
-    end
-
     # Clear this particular cache
     def clear
       delete_cache_files
@@ -49,7 +82,7 @@ module Jekyll
       return @cache[key] if @cache.key?(key)
 
       path = path_to(hash(key))
-      if @@disk_cache_enabled && File.file?(path) && File.readable?(path)
+      if disk_cache_enabled? && File.file?(path) && File.readable?(path)
         @cache[key] = load(path)
       else
         raise
@@ -61,7 +94,7 @@ module Jekyll
     # Returns nothing.
     def []=(key, value)
       @cache[key] = value
-      return unless @@disk_cache_enabled
+      return unless disk_cache_enabled?
 
       path = path_to(hash(key))
       value = new Hash(value) if value.is_a?(Hash) && !value.default.nil?
@@ -70,9 +103,8 @@ module Jekyll
       Jekyll.logger.debug "Cache:", "Cannot dump object #{key}"
     end
 
-    # If an item already exists in the cache, retrieve it
-    # Else execute code block, and add the result to the cache, and return that
-    #   result
+    # If an item already exists in the cache, retrieve it.
+    # Else execute code block, and add the result to the cache, and return that result.
     def getset(key)
       self[key]
     rescue StandardError
@@ -86,10 +118,7 @@ module Jekyll
     # Returns nothing.
     def delete(key)
       @cache.delete(key)
-      return unless @@disk_cache_enabled
-
-      path = path_to(hash(key))
-      File.delete(path)
+      File.delete(path_to(hash(key))) if disk_cache_enabled?
     end
 
     # Check if `key` already exists in this cache
@@ -100,40 +129,27 @@ module Jekyll
       return true if @cache.key?(key)
       # Otherwise, it might be cached on disk
       # but we should not consider the disk cache if it is disabled
-      return false unless @@disk_cache_enabled
+      return false unless disk_cache_enabled?
 
       path = path_to(hash(key))
       File.file?(path) && File.readable?(path)
     end
 
-    # Compare the current config to the cached config
-    # If they are different, clear all caches
-    #
-    # Returns nothing.
-    def self.clear_if_config_changed(config)
-      config = config.inspect
-      cache = Jekyll::Cache.new "Jekyll::Cache"
-      return if cache.key?("config") && cache["config"] == config
-
-      clear
-      cache = Jekyll::Cache.new "Jekyll::Cache"
-      cache["config"] = config
-      nil
+    def disk_cache_enabled?
+      !!Jekyll::Cache.disk_cache_enabled
     end
 
     private
 
-    # Given a hashed key, return the path to where this item would be saved on
-    # disk
+    # Given a hashed key, return the path to where this item would be saved on disk.
     def path_to(hash = nil)
-      @base_dir ||= File.join(@@base_dir, @name)
+      @base_dir ||= File.join(Jekyll::Cache.cache_dir, @name)
       return @base_dir if hash.nil?
 
       File.join(@base_dir, hash[0..1], hash[2..-1]).freeze
     end
 
-    # Given a key, return a SHA2 hash that can be used for caching this item to
-    # disk
+    # Given a key, return a SHA2 hash that can be used for caching this item to disk.
     def hash(key)
       Digest::SHA2.hexdigest(key).freeze
     end
@@ -142,22 +158,14 @@ module Jekyll
     #
     # Returns nothing.
     def delete_cache_files
-      FileUtils.rm_rf(path_to) if @@disk_cache_enabled
-    end
-
-    # Delete all cached items from all caches
-    #
-    # Returns nothing.
-    def self.delete_cache_files
-      FileUtils.rm_rf(@@base_dir) if @@disk_cache_enabled
+      FileUtils.rm_rf(path_to) if disk_cache_enabled?
     end
-    private_class_method :delete_cache_files
 
-    # Load `path` from disk and return the result
+    # Load `path` from disk and return the result.
     # This MUST NEVER be called in Safe Mode
     # rubocop:disable Security/MarshalLoad
     def load(path)
-      raise unless @@disk_cache_enabled
+      raise unless disk_cache_enabled?
 
       cached_file = File.open(path, "rb")
       value = Marshal.load(cached_file)
@@ -166,15 +174,14 @@ module Jekyll
     end
     # rubocop:enable Security/MarshalLoad
 
-    # Given a path and a value, save value to disk at path
+    # Given a path and a value, save value to disk at path.
     # This should NEVER be called in Safe Mode
     #
     # Returns nothing.
     def dump(path, value)
-      return unless @@disk_cache_enabled
+      return unless disk_cache_enabled?
 
-      dir = File.dirname(path)
-      FileUtils.mkdir_p(dir)
+      FileUtils.mkdir_p(File.dirname(path))
       File.open(path, "wb") do |cached_file|
         Marshal.dump(value, cached_file)
       end

data/lib/jekyll/cleaner.rb

@@ -66,7 +66,7 @@ module Jekyll
     #
     # Returns a Set with the directory paths
     def new_dirs
-      @new_dirs ||= new_files.map { |file| parent_dirs(file) }.flatten.to_set
+      @new_dirs ||= new_files.flat_map { |file| parent_dirs(file) }.to_set
     end
 
     # Private: The list of parent directories of a given file
@@ -77,7 +77,7 @@ module Jekyll
       if parent_dir == site.dest
         []
       else
-        [parent_dir] + parent_dirs(parent_dir)
+        parent_dirs(parent_dir).unshift(parent_dir)
       end
     end
 
@@ -94,7 +94,7 @@ module Jekyll
     #
     # Returns a Set with the directory paths
     def keep_dirs
-      site.keep_files.map { |file| parent_dirs(site.in_dest_dir(file)) }.flatten.to_set
+      site.keep_files.flat_map { |file| parent_dirs(site.in_dest_dir(file)) }.to_set
     end
 
     # Private: Creates a regular expression from the config's keep_files array

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.

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

@@ -79,15 +79,11 @@ module Jekyll
 
     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
@@ -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
 
@@ -284,15 +265,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 +277,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 +299,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