jekyll 4.2.1 → 4.3.2

data/lib/jekyll/cache.rb

@@ -1,190 +1,186 @@
-# frozen_string_literal: true
-
-require "digest"
-
-module Jekyll
-  class Cache
-    # 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
-    #
-    # name - name of the cache
-    #
-    # Returns nothing.
-    def initialize(name)
-      @cache = Jekyll::Cache.base_cache[name] ||= {}
-      @name = name.gsub(%r![^\w\s-]!, "-")
-    end
-
-    # Clear this particular cache
-    def clear
-      delete_cache_files
-      @cache.clear
-    end
-
-    # Retrieve a cached item
-    # Raises if key does not exist in cache
-    #
-    # Returns cached value
-    def [](key)
-      return @cache[key] if @cache.key?(key)
-
-      path = path_to(hash(key))
-      if disk_cache_enabled? && File.file?(path) && File.readable?(path)
-        @cache[key] = load(path)
-      else
-        raise
-      end
-    end
-
-    # Add an item to cache
-    #
-    # Returns nothing.
-    def []=(key, value)
-      @cache[key] = value
-      return unless disk_cache_enabled?
-
-      path = path_to(hash(key))
-      value = new Hash(value) if value.is_a?(Hash) && !value.default.nil?
-      dump(path, value)
-    rescue TypeError
-      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.
-    def getset(key)
-      self[key]
-    rescue StandardError
-      value = yield
-      self[key] = value
-      value
-    end
-
-    # Remove one particular item from the cache
-    #
-    # Returns nothing.
-    def delete(key)
-      @cache.delete(key)
-      File.delete(path_to(hash(key))) if disk_cache_enabled?
-    end
-
-    # Check if `key` already exists in this cache
-    #
-    # Returns true if key exists in the cache, false otherwise
-    def key?(key)
-      # First, check if item is already cached in memory
-      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?
-
-      path = path_to(hash(key))
-      File.file?(path) && File.readable?(path)
-    end
-
-    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.
-    def path_to(hash = nil)
-      @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.
-    def hash(key)
-      Digest::SHA2.hexdigest(key).freeze
-    end
-
-    # Remove all this caches items from disk
-    #
-    # Returns nothing.
-    def delete_cache_files
-      FileUtils.rm_rf(path_to) if disk_cache_enabled?
-    end
-
-    # 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?
-
-      cached_file = File.open(path, "rb")
-      value = Marshal.load(cached_file)
-      cached_file.close
-      value
-    end
-    # rubocop:enable Security/MarshalLoad
-
-    # 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?
-
-      FileUtils.mkdir_p(File.dirname(path))
-      File.open(path, "wb") do |cached_file|
-        Marshal.dump(value, cached_file)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "digest"
+
+module Jekyll
+  class Cache
+    # class-wide base cache
+    @base_cache = {}
+
+    # class-wide directive to write cache to disk is enabled by default
+    @disk_cache_enabled = true
+
+    class << self
+      attr_accessor :cache_dir # class-wide cache location
+
+      attr_reader :base_cache, # class-wide base cache reader
+                  :disk_cache_enabled # class-wide directive to write cache to disk
+
+      # 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
+    #
+    # name - name of the cache
+    #
+    # Returns nothing.
+    def initialize(name)
+      @cache = Jekyll::Cache.base_cache[name] ||= {}
+      @name = name.gsub(%r![^\w\s-]!, "-")
+    end
+
+    # Clear this particular cache
+    def clear
+      delete_cache_files
+      @cache.clear
+    end
+
+    # Retrieve a cached item
+    # Raises if key does not exist in cache
+    #
+    # Returns cached value
+    def [](key)
+      return @cache[key] if @cache.key?(key)
+
+      path = path_to(hash(key))
+      if disk_cache_enabled? && File.file?(path) && File.readable?(path)
+        @cache[key] = load(path)
+      else
+        raise
+      end
+    end
+
+    # Add an item to cache
+    #
+    # Returns nothing.
+    def []=(key, value)
+      @cache[key] = value
+      return unless disk_cache_enabled?
+
+      path = path_to(hash(key))
+      value = new Hash(value) if value.is_a?(Hash) && !value.default.nil?
+      dump(path, value)
+    rescue TypeError
+      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.
+    def getset(key)
+      self[key]
+    rescue StandardError
+      value = yield
+      self[key] = value
+      value
+    end
+
+    # Remove one particular item from the cache
+    #
+    # Returns nothing.
+    def delete(key)
+      @cache.delete(key)
+      File.delete(path_to(hash(key))) if disk_cache_enabled?
+    end
+
+    # Check if `key` already exists in this cache
+    #
+    # Returns true if key exists in the cache, false otherwise
+    def key?(key)
+      # First, check if item is already cached in memory
+      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?
+
+      path = path_to(hash(key))
+      File.file?(path) && File.readable?(path)
+    end
+
+    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.
+    def path_to(hash = nil)
+      @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.
+    def hash(key)
+      Digest::SHA2.hexdigest(key).freeze
+    end
+
+    # Remove all this caches items from disk
+    #
+    # Returns nothing.
+    def delete_cache_files
+      FileUtils.rm_rf(path_to) if disk_cache_enabled?
+    end
+
+    # 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?
+
+      cached_file = File.open(path, "rb")
+      value = Marshal.load(cached_file)
+      cached_file.close
+      value
+    end
+    # rubocop:enable Security/MarshalLoad
+
+    # 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?
+
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, "wb") do |cached_file|
+        Marshal.dump(value, cached_file)
+      end
+    end
+  end
+end

data/lib/jekyll/cleaner.rb

@@ -1,111 +1,111 @@
-# frozen_string_literal: true
-
-module Jekyll
-  # Handles the cleanup of a site's destination before it is built.
-  class Cleaner
-    HIDDEN_FILE_REGEX = %r!/\.{1,2}$!.freeze
-    attr_reader :site
-
-    def initialize(site)
-      @site = site
-    end
-
-    # Cleans up the site's destination directory
-    def cleanup!
-      FileUtils.rm_rf(obsolete_files)
-      FileUtils.rm_rf(metadata_file) unless @site.incremental?
-    end
-
-    private
-
-    # Private: The list of files and directories to be deleted during cleanup process
-    #
-    # Returns an Array of the file and directory paths
-    def obsolete_files
-      out = (existing_files - new_files - new_dirs + replaced_files).to_a
-      Jekyll::Hooks.trigger :clean, :on_obsolete, out
-      out
-    end
-
-    # Private: The metadata file storing dependency tree and build history
-    #
-    # Returns an Array with the metdata file as the only item
-    def metadata_file
-      [site.regenerator.metadata_file]
-    end
-
-    # Private: The list of existing files, apart from those included in
-    # keep_files and hidden files.
-    #
-    # Returns a Set with the file paths
-    def existing_files
-      files = Set.new
-      regex = keep_file_regex
-      dirs = keep_dirs
-
-      Utils.safe_glob(site.in_dest_dir, ["**", "*"], File::FNM_DOTMATCH).each do |file|
-        next if HIDDEN_FILE_REGEX.match?(file) || regex.match?(file) || dirs.include?(file)
-
-        files << file
-      end
-
-      files
-    end
-
-    # Private: The list of files to be created when site is built.
-    #
-    # Returns a Set with the file paths
-    def new_files
-      @new_files ||= Set.new.tap do |files|
-        site.each_site_file { |item| files << item.destination(site.dest) }
-      end
-    end
-
-    # Private: The list of directories to be created when site is built.
-    # These are the parent directories of the files in #new_files.
-    #
-    # Returns a Set with the directory paths
-    def new_dirs
-      @new_dirs ||= new_files.flat_map { |file| parent_dirs(file) }.to_set
-    end
-
-    # Private: The list of parent directories of a given file
-    #
-    # Returns an Array with the directory paths
-    def parent_dirs(file)
-      parent_dir = File.dirname(file)
-      if parent_dir == site.dest
-        []
-      else
-        parent_dirs(parent_dir).unshift(parent_dir)
-      end
-    end
-
-    # Private: The list of existing files that will be replaced by a directory
-    # during build
-    #
-    # Returns a Set with the file paths
-    def replaced_files
-      new_dirs.select { |dir| File.file?(dir) }.to_set
-    end
-
-    # Private: The list of directories that need to be kept because they are
-    # parent directories of files specified in keep_files
-    #
-    # Returns a Set with the directory paths
-    def keep_dirs
-      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
-    #
-    # Examples
-    #   ['.git','.svn'] with site.dest "/myblog/_site" creates
-    #   the following regex: /\A\/myblog\/_site\/(\.git|\/.svn)/
-    #
-    # Returns the regular expression
-    def keep_file_regex
-      %r!\A#{Regexp.quote(site.dest)}/(#{Regexp.union(site.keep_files).source})!
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  # Handles the cleanup of a site's destination before it is built.
+  class Cleaner
+    HIDDEN_FILE_REGEX = %r!/\.{1,2}$!.freeze
+    attr_reader :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    # Cleans up the site's destination directory
+    def cleanup!
+      FileUtils.rm_rf(obsolete_files)
+      FileUtils.rm_rf(metadata_file) unless @site.incremental?
+    end
+
+    private
+
+    # Private: The list of files and directories to be deleted during cleanup process
+    #
+    # Returns an Array of the file and directory paths
+    def obsolete_files
+      out = (existing_files - new_files - new_dirs + replaced_files).to_a
+      Jekyll::Hooks.trigger :clean, :on_obsolete, out
+      out
+    end
+
+    # Private: The metadata file storing dependency tree and build history
+    #
+    # Returns an Array with the metadata file as the only item
+    def metadata_file
+      [site.regenerator.metadata_file]
+    end
+
+    # Private: The list of existing files, apart from those included in
+    # keep_files and hidden files.
+    #
+    # Returns a Set with the file paths
+    def existing_files
+      files = Set.new
+      regex = keep_file_regex
+      dirs = keep_dirs
+
+      Utils.safe_glob(site.in_dest_dir, ["**", "*"], File::FNM_DOTMATCH).each do |file|
+        next if HIDDEN_FILE_REGEX.match?(file) || regex.match?(file) || dirs.include?(file)
+
+        files << file
+      end
+
+      files
+    end
+
+    # Private: The list of files to be created when site is built.
+    #
+    # Returns a Set with the file paths
+    def new_files
+      @new_files ||= Set.new.tap do |files|
+        site.each_site_file { |item| files << item.destination(site.dest) }
+      end
+    end
+
+    # Private: The list of directories to be created when site is built.
+    # These are the parent directories of the files in #new_files.
+    #
+    # Returns a Set with the directory paths
+    def new_dirs
+      @new_dirs ||= new_files.flat_map { |file| parent_dirs(file) }.to_set
+    end
+
+    # Private: The list of parent directories of a given file
+    #
+    # Returns an Array with the directory paths
+    def parent_dirs(file)
+      parent_dir = File.dirname(file)
+      if parent_dir == site.dest
+        []
+      else
+        parent_dirs(parent_dir).unshift(parent_dir)
+      end
+    end
+
+    # Private: The list of existing files that will be replaced by a directory
+    # during build
+    #
+    # Returns a Set with the file paths
+    def replaced_files
+      new_dirs.select { |dir| File.file?(dir) }.to_set
+    end
+
+    # Private: The list of directories that need to be kept because they are
+    # parent directories of files specified in keep_files
+    #
+    # Returns a Set with the directory paths
+    def keep_dirs
+      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
+    #
+    # Examples
+    #   ['.git','.svn'] with site.dest "/myblog/_site" creates
+    #   the following regex: /\A\/myblog\/_site\/(\.git|\/.svn)/
+    #
+    # Returns the regular expression
+    def keep_file_regex
+      %r!\A#{Regexp.quote(site.dest)}/(#{Regexp.union(site.keep_files).source})!
+    end
+  end
+end