jekyll 3.8.7 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd47a6bdaa39cc18841830cb20efc1c186f2aa992562ef329f34586151c199d8
-  data.tar.gz: 462e3ca561bf78c0a063214788bada40fcb38a45f2430574f4ed4ab6a1cb1f07
+  metadata.gz: 8de141f536d43289d9c0f6dcea9282eca345760cb15208d11971128f0e9c9b23
+  data.tar.gz: d3f2ed7b92cc8a96b1c56c183912247d60399fb13bf899b874093797d1b8c574
 SHA512:
-  metadata.gz: 66a5f9995d79653ae1f30119f54337148baaa94b54b7965280647fd7323df475114ac7aaaae6e2bb87023d4dd941074c4bc0eed963197d14c976946f02373ee4
-  data.tar.gz: e6dcd91c748f7ddf19ab2c74cfdef3c1598ca40e1825c79c704b977c34ee60421947c2d00d64d924ee3ebd4c12f59b2a7ec577bb9b24430d3c9c3d0433d5733f
+  metadata.gz: 188a24d699ba093c3a55048cacb969158cb027a4df37cdc62bd31c22dd8223c8c8b138a190b5eaee85fb811be771fa3e8256bde4b1c8f6fdfbac8a69dbc221c4
+  data.tar.gz: d2eb7caccefdaebfeec3cce77f749d4ade2d463eb39d85ab9f3fe9a54afadc193fcfc7218692124e217843443f0ae9b0a3ee71a9ffb6ececc245fc063c370f1e

data/.rubocop.yml

@@ -1,6 +1,8 @@
 ---
+inherit_from: .rubocop_todo.yml
 
 require:
+  - rubocop-performance
   - ./rubocop/jekyll
 
 Jekyll/NoPutsAllowed:
@@ -8,9 +10,10 @@ Jekyll/NoPutsAllowed:
     - rake/*.rake
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
   Include:
     - lib/**/*.rb
+    - test/**/*.rb
   Exclude:
     - bin/**/*
     - exe/**/*
@@ -18,49 +21,51 @@ AllCops:
     - script/**/*
     - vendor/**/*
     - tmp/**/*
-Layout/AlignArray:
+
+Layout/EmptyComment:
   Enabled: false
-Layout/AlignHash:
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/EndAlignment:
+  Severity: error
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
-Layout/AlignParameters:
-  Enabled: false
-Layout/EmptyLinesAroundAccessModifier:
-  Enabled: false
-Layout/EmptyLinesAroundModuleBody:
-  Enabled: false
-Layout/EndOfLine:
-  EnforcedStyle: native
-Layout/ExtraSpacing:
-  AllowForAlignment: true
-Layout/FirstParameterIndentation:
-  EnforcedStyle: consistent
 Layout/IndentationWidth:
   Severity: error
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
-Layout/IndentHeredoc:
-  Enabled: false
+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:
-  Enabled: false
-Layout/EndAlignment:
-  Severity: error
-Lint/SplatKeywordArguments:
-  Enabled: false
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Lint/UnreachableCode:
   Severity: error
-Lint/UselessAccessModifier:
-  Enabled: false
 Lint/Void:
-  Enabled: false
+  Exclude:
+    - lib/jekyll/site.rb
+
 Metrics/AbcSize:
   Max: 21
 Metrics/BlockLength:
@@ -68,45 +73,44 @@ Metrics/BlockLength:
     - test/**/*.rb
     - lib/jekyll/configuration.rb
     - rake/*.rake
-    - jekyll.gemspec
 Metrics/ClassLength:
   Exclude:
     - !ruby/regexp /features\/.*.rb$/
     - !ruby/regexp /test\/.*.rb$/
-  Max: 300
+    - lib/jekyll/document.rb
+    - lib/jekyll/site.rb
+    - lib/jekyll/commands/serve.rb
+    - lib/jekyll/configuration.rb
+  Max: 240
 Metrics/CyclomaticComplexity:
-  Max: 9
-Metrics/LineLength:
   Exclude:
-    - !ruby/regexp /features\/.*.rb/
-    - Rakefile
-    - rake/*.rake
-    - Gemfile
-    - jekyll.gemspec
-  Max: 90
-  Severity: warning
+    - lib/jekyll/utils.rb
+    - lib/jekyll/commands/serve.rb
 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:
-  Enabled: false
+  Exclude:
+    - test/**/*.rb
 Naming/MemoizedInstanceVariableName:
   Exclude:
-    - lib/jekyll/page_without_a_file.rb
-    - lib/jekyll/drops/unified_payload_drop.rb
+    - lib/jekyll/convertible.rb
     - lib/jekyll/drops/site_drop.rb
-Naming/UncommunicativeMethodParamName:
-  AllowedNames:
-    - _
+    - lib/jekyll/drops/unified_payload_drop.rb
+    - lib/jekyll/page_without_a_file.rb
+
 Security/MarshalLoad:
   Exclude:
     - !ruby/regexp /test\/.*.rb$/
@@ -115,34 +119,40 @@ Security/YAMLLoad:
   Exclude:
     - !ruby/regexp /features\/.*.rb/
     - !ruby/regexp /test\/.*.rb$/
-Style/Alias:
+
+Style/AccessModifierDeclarations:
   Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
 Style/AndOr:
   Severity: error
-Style/BracesAroundHashParameters:
-  Enabled: false
 Style/ClassAndModuleChildren:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
+  Exclude:
+    - test/**/*.rb
 Style/Documentation:
   Enabled: false
-  Exclude:
-    - !ruby/regexp /features\/.*.rb$/
 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/IfUnlessModifier:
-  Enabled: false
-Style/InverseMethods:
+Style/HashTransformKeys:
   Enabled: false
+Style/HashTransformValues:
+  Enabled: true
 Style/MixinUsage:
   Exclude:
     - test/helper.rb
@@ -159,24 +169,23 @@ Style/PercentLiteralDelimiters:
     "%w": "()"
     "%W": "()"
     "%x": "()"
-Style/RedundantReturn:
-  Enabled: false
-Style/RedundantSelf:
-  Enabled: false
 Style/RegexpLiteral:
   EnforcedStyle: percent_r
 Style/RescueModifier:
   Enabled: false
+Style/SafeNavigation:
+  Exclude:
+    - lib/jekyll/document.rb
 Style/SignalException:
   EnforcedStyle: only_raise
-Style/SingleLineMethods:
+Style/SlicingWithRange:
   Enabled: false
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 Style/SymbolArray:
-  Enabled: false
+  EnforcedStyle: brackets
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInHashLiteral:

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2008-2018 Tom Preston-Werner and Jekyll contributors
+Copyright (c) 2008-present Tom Preston-Werner and Jekyll contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -3,13 +3,13 @@
 [![Gem Version](https://img.shields.io/gem/v/jekyll.svg)][ruby-gems]
 [![Linux Build Status](https://img.shields.io/travis/jekyll/jekyll/master.svg?label=Linux%20build)][travis]
 [![Windows Build status](https://img.shields.io/appveyor/ci/jekyll/jekyll/master.svg?label=Windows%20build)][appveyor]
-[![Maintainability](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/maintainability)](codeclimate)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/test_coverage)](coverage)
-[![Dependency Status](https://img.shields.io/gemnasium/jekyll/jekyll.svg)][gemnasium]
+[![Maintainability](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/maintainability)][codeclimate]
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/test_coverage)][coverage]
 [![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)][hakiri]
+[![Backers on Open Collective](https://opencollective.com/jekyll/backers/badge.svg)](#backers)
+[![Sponsors on Open Collective](https://opencollective.com/jekyll/sponsors/badge.svg)](#sponsors)
 
 [ruby-gems]: https://rubygems.org/gems/jekyll
-[gemnasium]: https://gemnasium.com/jekyll/jekyll
 [codeclimate]: https://codeclimate.com/github/jekyll/jekyll
 [coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage
 [hakiri]: https://hakiri.io/github/jekyll/jekyll/master
@@ -24,18 +24,28 @@ Jekyll does what you tell it to do — no more, no less. It doesn't try to outs
 
 See: https://jekyllrb.com/philosophy
 
-## Having trouble?
-
-See: https://jekyllrb.com/docs/troubleshooting/
-
 ## Getting Started
 
 * [Install](https://jekyllrb.com/docs/installation/) the gem
 * Read up about its [Usage](https://jekyllrb.com/docs/usage/) and [Configuration](https://jekyllrb.com/docs/configuration/)
-* Take a gander at some existing [Sites](https://wiki.github.com/jekyll/jekyll/sites)
+* Take a gander at some existing [Sites](https://github.com/jekyll/jekyll/wiki/sites)
 * [Fork](https://github.com/jekyll/jekyll/fork) and [Contribute](https://jekyllrb.com/docs/contributing/) your own modifications
 * Have questions? Check out our official forum community [Jekyll Talk](https://talk.jekyllrb.com/) or [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/)
 
+## Diving In
+
+* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
+* Learn how [Front Matter](https://jekyllrb.com/docs/front-matter/) works
+* Put information on your site with [Variables](https://jekyllrb.com/docs/variables/)
+* Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with
+* Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier
+* Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site
+* Watch [video tutorials from Giraffe Academy](https://jekyllrb.com/tutorials/video-walkthroughs/)
+
+## Need help?
+
+If you don't find the answer to your problem in our [docs](https://jekyllrb.com/docs/), or in the [troubleshooting section](https://jekyllrb.com/docs/troubleshooting/), ask the [community](https://jekyllrb.com/docs/community/) for help.
+
 ## Code of Conduct
 
 In order to have a more open and welcoming community, Jekyll adheres to a
@@ -45,16 +55,35 @@ conduct.
 Please adhere to this code of conduct in any interactions you have in the
 Jekyll community. It is strictly enforced on all official Jekyll
 repositories, websites, and resources. If you encounter someone violating
-these terms, please let one of our core team members [Olivia](mailto:olivia@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Pat](mailto:pat@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Matt](mailto:matt@jekyllrb.com?subject=Jekyll%20CoC%20Violation) or [Parker](mailto:parker@jekyllrb.com?subject=Jekyll%20CoC%20Violation) know and we will address it as soon as possible.
+these terms, please let one of our [core team members](https://jekyllrb.com/team/#core-team) know and we will address it as soon as possible.
 
-## Diving In
+## Credits
 
-* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
-* Learn how the [YAML Front Matter](https://jekyllrb.com/docs/frontmatter/) works
-* Put information on your site with [Variables](https://jekyllrb.com/docs/variables/)
-* Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with
-* Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier
-* Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site
+### Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up in this README with a link to your website. [Become a sponsor!](https://opencollective.com/jekyll#sponsor)
+
+<a href="https://opencollective.com/jekyll/sponsor/0/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/0/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/1/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/1/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/2/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/2/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/3/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/3/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/4/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/4/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/5/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/5/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/6/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/6/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/7/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/7/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/8/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/8/avatar.svg" /></a>
+<a href="https://opencollective.com/jekyll/sponsor/9/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/9/avatar.svg" /></a>
+
+### Contributors
+
+This project exists thanks to all the people who contribute.
+<a href="../../graphs/contributors"><img src="https://opencollective.com/jekyll/contributors.svg?width=890&button=false" /></a>
+
+### Backers
+
+Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/jekyll#backer)
+
+<a href="https://opencollective.com/jekyll#backers" target="_blank"><img src="https://opencollective.com/jekyll/backers.svg?width=890" /></a>
 
 ## License
 

data/lib/blank_template/_config.yml

@@ -0,0 +1,3 @@
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+baseurl: "" # the subpath of your site, e.g. /blog
+title: "" # the name of your site, e.g. ACME Corp.

data/lib/blank_template/_layouts/default.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta charset="utf-8">
+    <title>{{ page.title }} - {{ site.title }}</title>
+    <link rel="stylesheet" href="{{ "/assets/css/main.css" | relative_url }}">
+  </head>
+  <body>
+    {{ content}}
+  </body>
+</html>

data/lib/blank_template/_sass/main.scss

@@ -0,0 +1,9 @@
+$backgroundColor: #ffffff;
+$bodyColor: #000000;
+$bodyFont: -apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
+
+body {
+  background: $backgroundColor;
+  color: $bodyColor;
+  font-family: $bodyFont;
+}

data/lib/blank_template/assets/css/main.scss

@@ -0,0 +1,4 @@
+---
+---
+
+@import "main";

data/lib/blank_template/index.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: "Happy Jekylling!"
+---
+
+## You're ready to go!
+
+Start developing your Jekyll website.

data/lib/jekyll.rb

@@ -50,10 +50,13 @@ 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"
   autoload :LayoutReader,        "jekyll/readers/layout_reader"
@@ -64,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"
@@ -175,6 +180,10 @@ module Jekyll
 
       return clean_path if clean_path.eql?(base_directory)
 
+      # remove any remaining extra leading slashes not stripped away by calling
+      # `File.expand_path` above.
+      clean_path.squeeze!("/")
+
       if clean_path.start_with?(base_directory.sub(%r!\z!, "/"))
         clean_path
       else
@@ -184,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

@@ -0,0 +1,190 @@
+# 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