iknow_cache 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a5fbfe4eb06e835259e354c8a8fdfb9bc82c2d34bfe6ea62fc8269144ca8a5
-  data.tar.gz: 22da19d2f809d5d092298d47d1b703a146ff6d143d7ac83c0191a8fae98eca36
+  metadata.gz: f2f251be058a4e00de4f8dc19eef0cfe2fd35423fe954d74648a51e45b11ee4c
+  data.tar.gz: 807534bc5abde0fe64d7d8a6a419d71e21695617b01e58b94d5da5dc90a39746
 SHA512:
-  metadata.gz: 80d4ff3de7d25e388217e20922971d4378970591bc6a8c57672e1c4745e1451e57a2105f16a468c7845ce4103dae8b62a5f8abe5cf6ab66713a4fa9ec23aac8f
-  data.tar.gz: c23861a1464d8e2ea0c6d711eac3b8517253f745cda66bb9c612b4c67be11f669fff637c0e5eeb49c967600d38b050692895104c7d84500d5d8aa78a4f3c9cc0
+  metadata.gz: 98c3d4cbb6e4f2dd6d6d0c145c3be61734e562927dca4be79ce2f91226faba0633da677be77459fd7b3c47d5a015808da8ab318fb3182f481e31a43d2b3681ce
+  data.tar.gz: c89989310153a661059cd79c58f337263ac711f65f8dc38cd259e2bd5ed0fae03421d1b5e3539fc6a3995c6bb6a8a91169530d8ab37d1042e7fc02a1dcd57b70

data/lib/iknow_cache/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class IknowCache
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      unless IknowCache.configured?
+        IknowCache.configure! do
+          logger Rails.logger
+          cache Rails.cache
+        end
+      end
+    end
+  end
+end

data/lib/iknow_cache/version.rb

@@ -1,3 +1,3 @@
 class IknowCache
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/iknow_cache.rb

@@ -1,6 +1,46 @@
 # frozen_string_literal: true
 
 class IknowCache
+  Config = Struct.new(:logger, :cache)
+
+  class ConfigWriter
+    def initialize(config)
+      @config = config
+    end
+
+    def logger(logger)
+      @config.logger = logger
+    end
+
+    def cache(cache)
+      @config.cache = cache
+    end
+  end
+
+  def self.configured?
+    ! config.nil?
+  end
+
+  def self.configure!(&block)
+    raise ArgumentError.new("Already configured!") if configured?
+
+    config = Config.new
+    ConfigWriter.new(config).instance_eval(&block)
+    @config = config.freeze
+  end
+
+  class << self
+    attr_reader :config
+
+    def logger
+      config.logger
+    end
+
+    def cache
+      config.cache
+    end
+  end
+
   def self.register_group(name, key_name, default_options: nil, static_version: 1)
     group = CacheGroup.new(nil, name, key_name, default_options, static_version)
     yield group if block_given?
@@ -51,7 +91,7 @@ class IknowCache
     # invalidating all caches in it and its children
     def invalidate_cache_group(parent_key = nil)
       parent_path = self.parent_path(parent_key)
-      Rails.cache.increment(version_path_string(parent_path))
+      IknowCache.cache.increment(version_path_string(parent_path))
     end
 
     # Fetch the path for this cache. We allow the parent_path to be precomputed
@@ -78,7 +118,7 @@ class IknowCache
     end
 
     def version(parent_path)
-      Rails.cache.fetch(version_path_string(parent_path), raw: true) { 1 }
+      IknowCache.cache.fetch(version_path_string(parent_path), raw: true) { 1 }
     end
 
     # compute multiple paths at once: returns { key => path }
@@ -121,12 +161,12 @@ class IknowCache
       version_paths = version_by_pp.values
 
       # look up versions in cache
-      versions = Rails.cache.read_multi(*version_paths, raw: true)
+      versions = IknowCache.cache.read_multi(*version_paths, raw: true)
 
       version_paths.each do |vp|
         next if versions.has_key?(vp)
 
-        versions[vp] = Rails.cache.fetch(vp, raw: true) { 1 }
+        versions[vp] = IknowCache.cache.fetch(vp, raw: true) { 1 }
       end
 
       # swap in the versions
@@ -163,33 +203,33 @@ class IknowCache
 
     def fetch(key, parent_path: nil, **options, &block)
       p = path(key, parent_path)
-      Rails.logger.debug("Cache Fetch: #{p}") if DEBUG
-      v = Rails.cache.fetch(p, IknowCache.merge_options(cache_options, options), &block)
-      Rails.logger.debug("=> #{v.inspect}") if DEBUG
+      IknowCache.logger.debug("Cache Fetch: #{p}") if DEBUG
+      v = IknowCache.cache.fetch(p, IknowCache.merge_options(cache_options, options), &block)
+      IknowCache.logger.debug("=> #{v.inspect}") if DEBUG
       v
     end
 
     def read(key, parent_path: nil, **options)
       p = path(key, parent_path)
-      Rails.logger.debug("Cache Read: #{p}") if DEBUG
-      v = Rails.cache.read(p, IknowCache.merge_options(cache_options, options))
-      Rails.logger.debug("=> #{v.inspect}") if DEBUG
+      IknowCache.logger.debug("Cache Read: #{p}") if DEBUG
+      v = IknowCache.cache.read(p, IknowCache.merge_options(cache_options, options))
+      IknowCache.logger.debug("=> #{v.inspect}") if DEBUG
       v
     end
 
     def write(key, value, parent_path: nil, **options)
       p = path(key, parent_path)
       if DEBUG
-        Rails.logger.debug("Cache Store: #{p} (#{IknowCache.merge_options(cache_options, options).inspect})")
-        Rails.logger.debug("<= #{value.inspect}")
+        IknowCache.logger.debug("Cache Store: #{p} (#{IknowCache.merge_options(cache_options, options).inspect})")
+        IknowCache.logger.debug("<= #{value.inspect}")
       end
-      Rails.cache.write(p, value, IknowCache.merge_options(cache_options, options))
+      IknowCache.cache.write(p, value, IknowCache.merge_options(cache_options, options))
     end
 
     def delete(key, parent_path: nil, **options)
       p = path(key, parent_path)
-      Rails.logger.debug("Cache Delete: #{p}") if DEBUG
-      Rails.cache.delete(p, IknowCache.merge_options(cache_options, options))
+      IknowCache.logger.debug("Cache Delete: #{p}") if DEBUG
+      IknowCache.cache.delete(p, IknowCache.merge_options(cache_options, options))
     end
 
     def read_multi(keys)
@@ -198,12 +238,12 @@ class IknowCache
       key_paths = path_multi(keys)
       path_keys = key_paths.invert
 
-      Rails.logger.debug("Cache Multi-Read: #{key_paths.values.inspect}") if DEBUG
-      raw = Rails.cache.read_multi(*key_paths.values)
+      IknowCache.logger.debug("Cache Multi-Read: #{key_paths.values.inspect}") if DEBUG
+      raw = IknowCache.cache.read_multi(*key_paths.values)
       vs = raw.each_with_object({}) do |(path, value), h|
         h[path_keys[path]] = value
       end
-      Rails.logger.debug("=> #{vs.inspect}") if DEBUG
+      IknowCache.logger.debug("=> #{vs.inspect}") if DEBUG
       vs
     end
 
@@ -214,12 +254,14 @@ class IknowCache
       options = IknowCache.merge_options(cache_options, options)
 
       entries.each do |key, value|
-        Rails.logger.debug("Cache Multi-Write: #{key_paths[key]}") if DEBUG
-        Rails.cache.write(key_paths[key], value, options)
+        IknowCache.logger.debug("Cache Multi-Write: #{key_paths[key]}") if DEBUG
+        IknowCache.cache.write(key_paths[key], value, options)
       end
     end
 
-    delegate :key, to: :cache_group
+    def key
+      cache_group.key
+    end
 
     private
 
@@ -249,3 +291,5 @@ class IknowCache
     end
   end
 end
+
+require "iknow_cache/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,23 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: iknow_cache
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris Andreae
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -63,6 +77,7 @@ files:
 - README.md
 - Rakefile
 - lib/iknow_cache.rb
+- lib/iknow_cache/railtie.rb
 - lib/iknow_cache/version.rb
 homepage: https://github.com/iknow/iknow_cache
 licenses:
@@ -83,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: iKnow's versioned nested cache