any_cache 0.2.0 → 0.3.0

data/lib/any_cache/adapters/active_support_dalli_store.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.3.0
+  class ActiveSupportDalliStore < Basic
+    class << self
+      # @param driver [Object]
+      # @retunr [Boolean]
+      #
+      # @api private
+      # @since 0.3.0
+      def supported_driver?(driver)
+        AnyCache::Drivers::ActiveSupportDalliStore.supported_source?(driver)
+      end
+    end
+
+    # @return [Array]
+    #
+    # @api private
+    # @since 0.3.0
+    READ_MULTI_EMPTY_KEYS_SET = [].freeze
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.3.0
+    DEFAULT_INCR_DECR_AMOUNT = 1
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.3.0
+    INITIAL_DECREMNETED_VALUE = 0
+
+    # @return [NilClass]
+    #
+    # @api private
+    # @since 0.3.0
+    NO_EXPIRATION_TTL = nil
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.3.0
+    DEAD_TTL = 0
+
+    # @since 0.3.0
+    def_delegators :driver, :delete, :clear
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def read(key, **options)
+      raw = options.fetch(:raw, true)
+
+      driver.read(key, raw: raw)
+    end
+
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def read_multi(*keys, **options)
+      raw = options.fetch(:raw, true)
+
+      driver.read_multi(*keys, raw: raw).tap do |entries|
+        entries.merge!(Hash[(keys - entries.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
+      end
+    end
+
+    # @param key [String]
+    # @param value [Object]
+    # @option expires_in [NilClass, Integer] Time in seconds
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def write(key, value, **options)
+      expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+      raw = options.fetch(:raw, true)
+
+      driver.write(key, value, expires_in: expires_in, raw: raw)
+    end
+
+    # @param entries [Hash]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def write_multi(entries, **options)
+      raw = options.fetch(:raw, true)
+
+      # NOTE: ActiveSupport::Cache::DalliStore does not support #write_multi :\
+      entries.each_pair do |key, value|
+        write(key, value, expires_in: NO_EXPIRATION_TTL, raw: raw)
+      end
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @option force [Boolean, Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.3.0
+    def fetch(key, **options, &fallback)
+      force_rewrite = options.fetch(:force, false)
+      force_rewrite = force_rewrite.call(key) if force_rewrite.respond_to?(:call)
+      expires_in    = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      driver.fetch(key, force: force_rewrite, expires_in: expires_in, &fallback)
+    end
+
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @param fallback [Proc]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def fetch_multi(*keys, **options, &fallback)
+      keys.each_with_object({}) do |key, dataset|
+        dataset[key] = fetch(key, **options, &fallback)
+      end
+    end
+
+    # @param key [String]
+    # @param amount [Integer]
+    # @options expires_in [Integer]
+    # @return [Integer, Float]
+    #
+    # @api private
+    # @since 0.3.0
+    def increment(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
+      expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      unless exist?(key)
+        write(key, amount, expires_in: expires_in) && amount
+      else
+        driver.increment(key, amount).tap do
+          expire(key, expires_in: expires_in) if expires_in
+        end
+      end
+    end
+
+    # @param key [String]
+    # @param amount [Integer]
+    # @option expires_in [Integer]
+    # @return [Integer, Float]
+    #
+    # @api private
+    # @since 0.3.0
+    def decrement(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
+      expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      unless exist?(key)
+        # NOTE: Dalli::Client (under the hood of this) can't decrement:
+        #   - non-raw values;
+        #   - values lower than zero;
+        #   - empty entries;
+        write(key, INITIAL_DECREMNETED_VALUE, expires_in: expires_in) && INITIAL_DECREMNETED_VALUE
+      else
+        driver.decrement(key, amount).tap do
+          expire(key, expires_in: expires_in) if expires_in
+        end
+      end
+    end
+
+    # @param pattern [String, Regexp]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def delete_matched(pattern, **options)
+      # TODO: make it real >:]
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def expire(key, expires_in: DEAD_TTL)
+      read(key).tap do |value|
+        is_alive = expires_in ? expires_in.positive? : false
+        is_alive ? write(key, value, expires_in: expires_in) : delete(key)
+      end
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def persist(key, **options)
+      read(key).tap { |value| write(key, value) }
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [BOolean]
+    #
+    # @api private
+    # @since 0.3.0
+    def exist?(key, **options)
+      driver.exist?(key, options)
+    end
+  end
+end

data/lib/any_cache/adapters/active_support_mem_cache_store.rb

@@ -17,6 +17,12 @@ module AnyCache::Adapters
       end
     end
 
+    # @return [Array]
+    #
+    # @api private
+    # @since 0.3.0
+    READ_MULTI_EMPTY_KEYS_SET = [].freeze
+
     # @return [NilClass]
     #
     # @api private
@@ -44,7 +50,7 @@ module AnyCache::Adapters
     # @since 0.2.0
     def_delegators :driver, :delete, :clear
 
-    # @param key
+    # @param key [String]
     # @param options [Hash]
     # @return [Object]
     #
@@ -56,6 +62,20 @@ module AnyCache::Adapters
       driver.read(key, raw: raw)
     end
 
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def read_multi(*keys, **options)
+      raw = options.fetch(:raw, true)
+
+      driver.read_multi(*keys, raw: raw).tap do |entries|
+        entries.merge!(Hash[(keys - entries.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
+      end
+    end
+
     # @param key [String]
     # @param value [Object]
     # @option expires_in [NilClass, Integer] Time in seconds
@@ -70,6 +90,56 @@ module AnyCache::Adapters
       driver.write(key, value, expires_in: expires_in, raw: raw)
     end
 
+    # @param entries [Hash]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def write_multi(entries, **options)
+      raw = options.fetch(:raw, true)
+
+      driver.write_multi(entries, expires_in: NO_EXPIRATION_TTL, raw: raw)
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @option force [Boolean, Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def fetch(key, **options, &fallback)
+      force_rewrite = options.fetch(:force, false)
+      force_rewrite = force_rewrite.call(key) if force_rewrite.respond_to?(:call)
+      expires_in    = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      driver.fetch(key, force: force_rewrite, expires_in: expires_in, &fallback)
+    end
+
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @param fallback [Proc]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def fetch_multi(*keys, **options, &fallback)
+      keys.each_with_object({}) do |key, dataset|
+        dataset[key] = fetch(key, **options, &fallback)
+      end
+    end
+
+    # @param pattern [String, Regexp]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def delete_matched(pattern, **options)
+      # TODO: make it real >:]
+    end
+
     # @param key [String]
     # @param amount [Integer]
     # @options expires_in [Integer]
@@ -144,20 +214,5 @@ module AnyCache::Adapters
     def exist?(key, **options)
       driver.exist?(key)
     end
-
-    # @param key [String]
-    # @option expires_in [Integer]
-    # @option force [Boolean]
-    # @return [Object]
-    #
-    # @api private
-    # @since 0.2.0
-    def fetch(key, **options, &block)
-      force_rewrite = options.fetch(:force, false)
-      force_rewrite = force_rewrite.call if force_rewrite.respond_to?(:call)
-      expires_in    = options.fetch(:expires_in, NO_EXPIRATION_TTL)
-
-      driver.fetch(key, force: force_rewrite, expires_in: expires_in, &block)
-    end
   end
 end

data/lib/any_cache/adapters/active_support_naive_store/operation.rb

@@ -7,6 +7,12 @@ class AnyCache::Adapters::ActiveSupportNaiveStore
     # @since 0.1.0
     extend Forwardable
 
+    # @return [Array]
+    #
+    # @api private
+    # @since 0.3.0
+    READ_MULTI_EMPTY_KEYS_SET = [].freeze
+
     # @return [NilClass]
     #
     # @api private

data/lib/any_cache/adapters/active_support_naive_store.rb

@@ -34,6 +34,20 @@ module AnyCache::Adapters
       lock.with_read_lock { super }
     end
 
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def read_multi(*keys, **options)
+      lock.with_read_lock do
+        super.tap do |res|
+          res.merge!(Hash[(keys - res.keys).zip(Operation::READ_MULTI_EMPTY_KEYS_SET)])
+        end
+      end
+    end
+
     # @param key [String]
     # @param options [Hash]
     # @return [void]
@@ -44,6 +58,16 @@ module AnyCache::Adapters
       lock.with_write_lock { super }
     end
 
+    # @param pattern [String, Regexp]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def delete_matched(pattern, **options)
+      lock.with_write_lock { super }
+    end
+
     # @param options [Hash]
     # @return [void]
     #
@@ -68,6 +92,61 @@ module AnyCache::Adapters
       end
     end
 
+    # @param entries [Hash]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def write_multi(entries, **options)
+      lock.with_write_lock do
+        expires_in = self.class::Operation::NO_EXPIRATION_TTL
+
+        super(entries, expires_in: expires_in)
+      end
+    end
+
+    # @param key [String]
+    # @param fallback [Proc]
+    # @option expires_in [Integer]
+    # @option force [Boolean, Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def fetch(key, **options, &fallback)
+      lock.with_write_lock do
+        force_rewrite = options.fetch(:force, false)
+        force_rewrite = force_rewrite.call(key) if force_rewrite.respond_to?(:call)
+        expires_in    = options.fetch(:expires_in, self.class::Operation::NO_EXPIRATION_TTL)
+
+        super(key, force: force_rewrite, expires_in: expires_in, &fallback)
+      end
+    end
+
+    # @param keys [Array<String>]
+    # @param fallback [Proc]
+    # @option force [Boolean, Proc]
+    # @option expires_in [Integer]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def fetch_multi(*keys, **options, &fallback)
+      lock.with_write_lock do
+        force_rewrite = options.fetch(:force, false)
+        expires_in    = options.fetch(:expires_in, self.class::Operation::NO_EXPIRATION_TTL)
+
+        # NOTE:
+        #   use own #fetch_multi implementation cuz original #fetch_multi
+        #   does not support :force option
+        keys.each_with_object({}) do |key, dataset|
+          force = force_rewrite.respond_to?(:call) ? force_rewrite.call(key) : force_rewrite
+          dataset[key] = driver.fetch(key, force: force, expires_in: expires_in, &fallback)
+        end
+      end
+    end
+
     # @param key [String]
     # @param amount [Integer, Float]
     # @option expires_in [NilClass, Integer]
@@ -128,23 +207,6 @@ module AnyCache::Adapters
       lock.with_read_lock { super }
     end
 
-    # @param key [String]
-    # @option expires_in [Integer]
-    # @option force [Boolean]
-    # @return [Object]
-    #
-    # @api private
-    # @since 0.2.0
-    def fetch(key, **options, &block)
-      lock.with_write_lock do
-        force_rewrite = options.fetch(:force, false)
-        force_rewrite = force_rewrite.call if force_rewrite.respond_to?(:call)
-        expires_in    = options.fetch(:expires_in, self.class::Operation::NO_EXPIRATION_TTL)
-
-        super(key, force: force_rewrite, expires_in: expires_in, &block)
-      end
-    end
-
     private
 
     # @return [Concurrent::ReentrantReadWriteLock]

data/lib/any_cache/adapters/active_support_redis_cache_store.rb

@@ -17,8 +17,14 @@ module AnyCache::Adapters
       end
     end
 
+    # @return [Array]
+    #
+    # @api private
+    # @since 0.3.0
+    READ_MULTI_EMPTY_KEYS_SET = [].freeze
+
     # @since 0.1.0
-    def_delegators :driver, :delete, :clear
+    def_delegators :driver, :delete, :delete_matched, :clear
 
     # @return [NilClass]
     #
@@ -38,7 +44,7 @@ module AnyCache::Adapters
     # @since 0.1.0
     DEFAULT_INCR_DECR_AMOUNT = 1
 
-    # @param key
+    # @param key [String]
     # @param options [Hash]
     # @return [Object]
     #
@@ -50,6 +56,20 @@ module AnyCache::Adapters
       driver.read(key, raw: raw)
     end
 
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def read_multi(*keys, **options)
+      raw = options.fetch(:raw, true)
+
+      driver.read_multi(*keys, raw: raw).tap do |res|
+        res.merge!(Hash[(keys - res.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
+      end
+    end
+
     # @param key [String]
     # @param value [Object]
     # @option expires_in [NilClass, Integer] Time in seconds
@@ -64,6 +84,52 @@ module AnyCache::Adapters
       driver.write(key, value, expires_in: expires_in, raw: raw)
     end
 
+    # @param entries [Hash]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @sicne 0.3.0
+    def write_multi(entries, **options)
+      raw = options.fetch(:raw, true)
+
+      driver.write_multi(entries, expires_in: NO_EXPIRATION_TTL, raw: raw)
+    end
+
+    # @param key [String]
+    # @param fallback [Proc]
+    # @option expires_in [Integer]
+    # @option force [Boolean, Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def fetch(key, **options, &fallback)
+      force_rewrite = options.fetch(:force, false)
+      force_rewrite = force_rewrite.call(key) if force_rewrite.respond_to?(:call)
+      expires_in    = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+      raw           = options.fetch(:raw, true)
+
+      driver.fetch(key, force: force_rewrite, expires_in: expires_in, raw: raw, &fallback)
+    end
+
+    # @param keys [Array<string]
+    # @param fallback [Proc]
+    # @poption expires_in [Integer]
+    # @option force [Boolean, Proc]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def fetch_multi(*keys, **options, &fallback)
+      # NOTE:
+      #   use own :fetch_multi implementation cuz original :fetch_multi
+      #   doesnt support :force option
+      keys.each_with_object({}) do |key, dataset|
+        dataset[key] = fetch(key, **options, &fallback)
+      end
+    end
+
     # @param key [String]
     # @param amount [Integer, Float]
     # @option expires_in [Integer]
@@ -134,20 +200,5 @@ module AnyCache::Adapters
     def exist?(key, **options)
       driver.exist?(key)
     end
-
-    # @param key [String]
-    # @option expires_in [Integer]
-    # @option force [Boolean]
-    # @return [Object]
-    #
-    # @api private
-    # @since 0.2.0
-    def fetch(key, **options, &block)
-      force_rewrite = options.fetch(:force, false)
-      force_rewrite = force_rewrite.call if force_rewrite.respond_to?(:call)
-      expires_in    = options.fetch(:expires_in, NO_EXPIRATION_TTL)
-
-      driver.fetch(key, force: force_rewrite, expires_in: expires_in, &block)
-    end
   end
 end

data/lib/any_cache/adapters/basic.rb

@@ -43,6 +43,16 @@ module AnyCache::Adapters
       raise NotImplementedError
     end
 
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def read_multi(*keys, **options)
+      raise NotImplementedError
+    end
+
     # @param key [String]
     # @param value [Object]
     # @param options [Hash]
@@ -54,6 +64,38 @@ module AnyCache::Adapters
       raise NotImplementedError
     end
 
+    # @param entries [Hash]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def write_multi(entries, **options)
+      raise NotImplementedError
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @param fallback [Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def fetch(key, **options, &fallback)
+      raise NotImplementedError
+    end
+
+    # @param keys [Array<String>]
+    # @param options [Hash]
+    # @param fallback [Proc]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.3.0
+    def fetch_multi(*keys, **options, &fallback)
+      raise NotImplementedError
+    end
+
     # @param key [String]
     # @param options [Hash]
     # @return [void]
@@ -64,6 +106,16 @@ module AnyCache::Adapters
       raise NotImplementedError
     end
 
+    # @param pattern [Regexp, String, Object]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def delete_matched(pattern, **options)
+      raise NotImplementedError
+    end
+
     # @param key [String]
     # @param value [Integer, Float]
     # @param options [Hash]
@@ -124,15 +176,5 @@ module AnyCache::Adapters
     def exist?(key, **options)
       raise NotImplementedError
     end
-
-    # @param key [String]
-    # @param options [Hash]
-    # @return [Object]
-    #
-    # @api private
-    # @since 0.2.0
-    def fetch(key, **options, &block)
-      raise NotImplementedError
-    end
   end
 end