jekyll 4.0.0.pre.alpha1 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1510de5e88a3e6d48fa5eb7686dfafc1cf94b820cd9b44fdd635bff9c306d98b
-  data.tar.gz: e4f444b21baf087d33f3dd7040c17b2fa00f5ed4a32f3602ee26722d4270ebc3
+  metadata.gz: b74631944252558b9ad068a1df651f0890577d11c6ac24d06050fe76e9a41d60
+  data.tar.gz: c34826fe92efe4fe968692fa3517c4f8ddf600b9c99af1776d305804e313a1fe
 SHA512:
-  metadata.gz: 854691fcc3090fe0292767b7aaa5c20504d5d11c08c9f301398cc5af70d387c002ad804fdf20a1583ab4a93d326425aff205b89554860c6babb84f6154923b85
-  data.tar.gz: ef22dd4eea32776ef7f25748241f1236431b8fd566bb377d8d66a657ade71e5de836ea149f7c7e0ff3483f471e8da801915261c6e0a110e97a43970707b3b05c
+  metadata.gz: d89ea1ca35864a53aa21d21847ef357d33a28f8e094bc4c39bc519c2895ea6e8a87d86669252af4b9431a23634209bf38e909ea7b0686ba22bcac898a43488cc
+  data.tar.gz: 950488593a4b255d8196baf07dfdd04a85bd062cf7b612531b6253eb4118d77ab8209290f535621dd2dc6aec2a73f8079092d243aaa002411e855b6264a5c33a

data/.rubocop.yml

@@ -1,6 +1,8 @@
 ---
+inherit_from: .rubocop_todo.yml
 
 require:
+  - rubocop-performance
   - ./rubocop/jekyll
 
 Jekyll/NoPutsAllowed:
@@ -8,7 +10,7 @@ Jekyll/NoPutsAllowed:
     - rake/*.rake
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Include:
     - lib/**/*.rb
     - test/**/*.rb
@@ -19,30 +21,53 @@ AllCops:
     - script/**/*
     - vendor/**/*
     - tmp/**/*
-Layout/AlignHash:
+
+Layout/EmptyComment:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/EndAlignment:
+  Severity: error
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
 Layout/IndentationWidth:
   Severity: error
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
+Layout/LineLength:
+  Exclude:
+    - !ruby/regexp /features\/.*.rb/
+    - Rakefile
+    - rake/*.rake
+    - Gemfile
+  Max: 100
+  Severity: warning
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
 Lint/NestedPercentLiteral:
   Exclude:
     - test/test_site.rb
-Layout/EmptyComment:
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
   Enabled: false
-Layout/EndAlignment:
-  Severity: error
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Lint/UnreachableCode:
   Severity: error
 Lint/Void:
   Exclude:
     - lib/jekyll/site.rb
+
 Metrics/AbcSize:
   Max: 21
 Metrics/BlockLength:
@@ -63,24 +88,20 @@ Metrics/CyclomaticComplexity:
   Exclude:
     - lib/jekyll/utils.rb
     - lib/jekyll/commands/serve.rb
-Metrics/LineLength:
-  Exclude:
-    - !ruby/regexp /features\/.*.rb/
-    - Rakefile
-    - rake/*.rake
-    - Gemfile
-  Max: 100
-  Severity: warning
+  Max: 11
 Metrics/MethodLength:
   CountComments: false
   Max: 20
   Severity: error
 Metrics/ModuleLength:
   Max: 240
+  Exclude:
+    - lib/jekyll/filters.rb
 Metrics/ParameterLists:
   Max: 4
 Metrics/PerceivedComplexity:
   Max: 8
+
 Naming/FileName:
   Enabled: false
 Naming/HeredocDelimiterNaming:
@@ -92,6 +113,7 @@ Naming/MemoizedInstanceVariableName:
     - lib/jekyll/drops/site_drop.rb
     - lib/jekyll/drops/unified_payload_drop.rb
     - lib/jekyll/page_without_a_file.rb
+
 Security/MarshalLoad:
   Exclude:
     - !ruby/regexp /test\/.*.rb$/
@@ -100,6 +122,7 @@ Security/YAMLLoad:
   Exclude:
     - !ruby/regexp /features\/.*.rb/
     - !ruby/regexp /test\/.*.rb$/
+
 Style/AccessModifierDeclarations:
   Enabled: false
 Style/Alias:
@@ -109,20 +132,30 @@ Style/AndOr:
 Style/ClassAndModuleChildren:
   Exclude:
     - test/**/*.rb
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
 Style/Documentation:
   Enabled: false
 Style/DoubleNegation:
   Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
 Style/FormatStringToken:
   Exclude:
     - lib/jekyll/utils/ansi.rb
+    - lib/jekyll/liquid_renderer/table.rb
+    - lib/jekyll/profiler.rb
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
 Style/GuardClause:
   Enabled: false
+Style/HashEachMethods:
+  Enabled: true
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
   Severity: error
+Style/HashTransformKeys:
+  Enabled: false
+Style/HashTransformValues:
+  Enabled: true
 Style/MixinUsage:
   Exclude:
     - test/helper.rb
@@ -139,6 +172,12 @@ Style/PercentLiteralDelimiters:
     "%w": "()"
     "%W": "()"
     "%x": "()"
+Style/RedundantFetchBlock:
+  Enabled: false
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
 Style/RegexpLiteral:
   EnforcedStyle: percent_r
 Style/RescueModifier:
@@ -148,6 +187,8 @@ Style/SafeNavigation:
     - lib/jekyll/document.rb
 Style/SignalException:
   EnforcedStyle: only_raise
+Style/SlicingWithRange:
+  Enabled: false
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 Style/StringLiteralsInInterpolation:

data/lib/jekyll.rb

@@ -50,10 +50,12 @@ module Jekyll
   autoload :EntryFilter,         "jekyll/entry_filter"
   autoload :Errors,              "jekyll/errors"
   autoload :Excerpt,             "jekyll/excerpt"
+  autoload :PageExcerpt,         "jekyll/page_excerpt"
   autoload :External,            "jekyll/external"
   autoload :FrontmatterDefaults, "jekyll/frontmatter_defaults"
   autoload :Hooks,               "jekyll/hooks"
   autoload :Layout,              "jekyll/layout"
+  autoload :Inclusion,           "jekyll/inclusion"
   autoload :Cache,               "jekyll/cache"
   autoload :CollectionReader,    "jekyll/readers/collection_reader"
   autoload :DataReader,          "jekyll/readers/data_reader"
@@ -65,8 +67,10 @@ 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 :Profiler,            "jekyll/profiler"
   autoload :Reader,              "jekyll/reader"
   autoload :Regenerator,         "jekyll/regenerator"
   autoload :RelatedPosts,        "jekyll/related_posts"
@@ -189,7 +193,7 @@ module Jekyll
     end
 
     # Conditional optimizations
-    Jekyll::External.require_if_present("liquid-c")
+    Jekyll::External.require_if_present("liquid/c")
   end
 end
 

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

@@ -3,7 +3,7 @@
 module Jekyll
   # Handles the cleanup of a site's destination before it is built.
   class Cleaner
-    HIDDEN_FILE_REGEX = %r!\/\.{1,2}$!.freeze
+    HIDDEN_FILE_REGEX = %r!/\.{1,2}$!.freeze
     attr_reader :site
 
     def initialize(site)
@@ -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
@@ -105,7 +105,7 @@ module Jekyll
     #
     # Returns the regular expression
     def keep_file_regex
-      %r!\A#{Regexp.quote(site.dest)}\/(#{Regexp.union(site.keep_files).source})!
+      %r!\A#{Regexp.quote(site.dest)}/(#{Regexp.union(site.keep_files).source})!
     end
   end
 end