iknow_cache 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a5fbfe4eb06e835259e354c8a8fdfb9bc82c2d34bfe6ea62fc8269144ca8a5
-  data.tar.gz: 22da19d2f809d5d092298d47d1b703a146ff6d143d7ac83c0191a8fae98eca36
+  metadata.gz: b80c0ec650d3fd5801512fefc162526b6502da2553e1640a3495defe4f7c5195
+  data.tar.gz: e5aa1520f3ffe851ca6bf37fd71946e44dd9706b1cf38b781c88cdfd11494607
 SHA512:
-  metadata.gz: 80d4ff3de7d25e388217e20922971d4378970591bc6a8c57672e1c4745e1451e57a2105f16a468c7845ce4103dae8b62a5f8abe5cf6ab66713a4fa9ec23aac8f
-  data.tar.gz: c23861a1464d8e2ea0c6d711eac3b8517253f745cda66bb9c612b4c67be11f669fff637c0e5eeb49c967600d38b050692895104c7d84500d5d8aa78a4f3c9cc0
+  metadata.gz: 50155988a7d4926758e063c06d01e0791e646ce0177ee33652384079fb88e403dc62718cc648f14115b8596f776f619f6e64ea64d2b3a9189a67c764720f083a
+  data.tar.gz: 8e4464752708f4e966822a08b05c68d514fa31b90ecad296748f2fdacb1e735ab379e2a135b0c7a50f338de88ce2e128c408f17046455a4b1fd565cedcc84ec1

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.1'
 end

data/lib/iknow_cache.rb

@@ -1,6 +1,48 @@
 # frozen_string_literal: true
 
+require 'active_support/version'
+
 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?
@@ -29,8 +71,8 @@ class IknowCache
       group
     end
 
-    def register_cache(name, cache_options: nil)
-      c = Cache.new(self, name, cache_options)
+    def register_cache(name, static_version: nil, cache_options: nil)
+      c = Cache.new(self, name, static_version, cache_options)
       @caches << c
       c
     end
@@ -51,7 +93,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 +120,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 +163,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
@@ -153,43 +195,57 @@ class IknowCache
   class Cache
     DEBUG = false
 
-    attr_reader :name, :cache_options, :cache_group
+    attr_reader :name, :static_version, :cache_options, :cache_group
 
-    def initialize(cache_group, name, cache_options)
-      @cache_group   = cache_group
-      @name          = name
-      @cache_options = IknowCache.merge_options(cache_group.default_options, cache_options).try { |x| x.dup.freeze }
+    def initialize(cache_group, name, static_version, cache_options)
+      @cache_group    = cache_group
+      @name           = name
+      @static_version = static_version
+      @cache_options  = IknowCache.merge_options(cache_group.default_options, cache_options).try { |x| x.dup.freeze }
     end
 
     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 fetch_multi(keys, write_options = nil)
+      results = read_multi(keys)
+
+      missing_keys = keys - results.keys
+      if missing_keys.present?
+        loaded_results = yield(missing_keys)
+        write_multi(loaded_results, write_options)
+        results.merge!(loaded_results)
+      end
+
+      results
     end
 
     def read_multi(keys)
@@ -198,12 +254,10 @@ 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)
-      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("Cache Multi-Read: #{key_paths.values.inspect}") if DEBUG
+      raw = IknowCache.cache.read_multi(*key_paths.values)
+      vs = raw.transform_keys { |path| path_keys[path] }
+      IknowCache.logger.debug("=> #{vs.inspect}") if DEBUG
       vs
     end
 
@@ -214,12 +268,31 @@ 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
+
+    if Gem::Version.new(ActiveSupport::VERSION::STRING) >= Gem::Version.new('6.1')
+      def delete_multi(keys, **options)
+        return if keys.blank?
+
+        key_paths = path_multi(keys)
+
+        IknowCache.logger.debug("Cache Delete Multi: #{key_paths}") if DEBUG
+        IknowCache.cache.delete_multi(key_paths.values, IknowCache.merge_options(cache_options, options))
+      end
+    else
+      def delete_multi(keys, **options)
+        keys.each do |key|
+          delete(key, **options)
+        end
       end
     end
 
-    delegate :key, to: :cache_group
+    def key
+      cache_group.key
+    end
 
     private
 
@@ -235,7 +308,9 @@ class IknowCache
     end
 
     def path_string(group_path)
-      "#{group_path}/#{self.name}"
+      path = "#{group_path}/#{self.name}"
+      path = "#{path}/#{self.static_version}" if static_version
+      path
     end
   end
 
@@ -249,3 +324,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.1
 platform: ruby
 authors:
 - Chris Andreae
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2024-03-28 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