jekyll-cache 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 999222f8c1428d0a0e7323f68095209d3831da59
+  data.tar.gz: 417b41339b40d0e6ddb522db4bf74002f90e21ed
+SHA512:
+  metadata.gz: 5c8eadfed318f0bd0d15bbe0b92dd05082c014b701104890501e4daa95f3abf3bd018b90e95f9dd7df91dca783ac720378e060ee13a5017a2b96b25c38a124fa
+  data.tar.gz: bceb3e98be5fdb5312231ab93d579a6ebcf9339954b92ff77251ab82fd1c79afcc04ccd9157426496047af1bb2dd508dd920af6d4f217c0582416c45a6a1ca6e

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+gem "pry"
+
+if ENV["JEKYLL_VERSION"]
+  # So we can test across all our supported.
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/lib/jekyll-cache.rb

@@ -0,0 +1,5 @@
+# Frozen-string-literal: true
+# Copyright: 2017 Jordon Bedwell - MIT License
+# Encoding: utf-8
+
+require "jekyll/cache"

data/lib/jekyll/cache.rb

@@ -0,0 +1,46 @@
+# Frozen-string-literal: true
+# Copyright: 2017 Jordon Bedwell - MIT License
+# Encoding: utf-8
+
+require "jekyll/sanity"
+require "jekyll/log_wrapper"
+require "jekyll"
+
+
+module Jekyll
+  module Cache
+    autoload   :FileStore, "jekyll/cache/file_store"
+    autoload :MemoryStore, \
+      "jekyll/cache/memory_store"
+
+    # --
+    # Clear the entire cache.
+    # @note Doesn't matter if it exists.
+    # @return [true,false]
+    # --
+    def self.clear
+      if Jekyll.cache_dir && Jekyll.cache_dir.directory?
+        return Jekyll.cache_dir.rm_rf
+      end
+    end
+
+    # --
+    # @return [Jekyll::LogWrapper]
+    # Creates a log wrapper for ActiveSupport
+    # @see Jekyll::LogWrapper
+    # --
+    def self.logger
+      @logger ||= LogWrapper.new(Jekyll.logger)
+    end
+  end
+
+  # --
+  # @note this should always use FileStore.
+  # A global cache that uses the FileStore. This is meant
+  #   for quick caching (or) one off caching.
+  # @return [FileStore] the new cache.
+  # --
+  def self.cache
+    @cache ||= Cache::FileStore.new("global")
+  end
+end

data/lib/jekyll/cache/file_store.rb

@@ -0,0 +1,65 @@
+# Frozen-string-literal: true
+# Copyright: 2017 Jordon Bedwell - MIT License
+# Encoding: utf-8
+
+require_relative "../cache"
+require "active_support/cache"
+require "forwardable/extended"
+require "jekyll/sanity"
+
+module Jekyll
+  module Cache
+    class FileStore < ActiveSupport::Cache::FileStore
+      def self.clear
+        Cache.method(:clear).call
+      end
+
+      # --
+      # @return [<EnvyGeeks::Cache>] the cache
+      # Overrides the default method so that we can simply
+      #   pass in the name of the directory we want to store
+      #   cache files inside of
+      # @see https://goo.gl/3G35gw
+      # --
+      def initialize(dir)
+        super(Jekyll.cache_dir.join(dir))
+        self.logger = Cache.logger
+      end
+
+      # --
+      # So that users don't freak out.
+      # @return nil
+      # --
+      def middleware
+        nil
+      end
+
+      # --
+      # @param key [String,Symbol] the cache key.
+      # Overrides `fetch` so that we can automatically
+      #   (immediately) expire if we are in development, without
+      #   the need for any one class to carry expirey data.
+      # @return [<Any>] the cached value.
+      # --
+      def fetch(key, **opts)
+        opts[:expires_in] = expires_in unless opts.key?(:expires_in)
+        return yield if opts[:expires_in] == 0.minutes
+        super(key, **opts) do
+          yield
+        end
+      end
+
+      # --
+      # @return [ActiveSupport::Duration] the time.
+      # Tells you how long until we plan to expire something
+      #   In production this is always set to 0 minutes, in dev
+      #   it's set to around 6 minutes, this way your sites
+      #   don't build slow when you are working.
+      # --
+      private
+      def expires_in
+        (Jekyll.env == "development" ? 24 : 0).minutes
+      end
+    end
+  end
+end

data/lib/jekyll/cache/memory_store.rb

@@ -0,0 +1,36 @@
+# Frozen-string-literal: true
+# Copyright: 2017 Jordon Bedwell - MIT License
+# Encoding: utf-8
+
+require "active_support/cache"
+require_relative "../cache"
+
+module Jekyll
+  module Cache
+    class MemoryStore < ActiveSupport::Cache::MemoryStore
+      def self.clear
+        Cache.method(:clear).call
+      end
+
+      # --
+      # @return [<EnvyGeeks::Cache>] the cache
+      # Overrides the default method so that we can simply
+      #   pass in the name of the directory we want to store
+      #   cache files inside of
+      # @see https://goo.gl/3G35gw
+      # --
+      def initialize(*args)
+        self.logger = Cache.logger
+        super(*args)
+      end
+
+      # --
+      # So that users don't freak out.
+      # @return nil
+      # --
+      def middleware
+        nil
+      end
+    end
+  end
+end

data/lib/jekyll/cache/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Cache
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordon Bedwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: luna-rspec-formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: jekyll-log-wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-sanity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Caching for Jekyll
+email:
+- jordon@envygeeks.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/jekyll-cache.rb
+- lib/jekyll/cache.rb
+- lib/jekyll/cache/file_store.rb
+- lib/jekyll/cache/memory_store.rb
+- lib/jekyll/cache/version.rb
+homepage: http://github.com/envygeeks/jekyll-cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A cache library that wraps around ActiveSupport
+test_files: []