any_cache 0.3.1 → 0.4.0

data/lib/any_cache.rb

@@ -10,6 +10,7 @@ require 'concurrent/atomic/reentrant_read_write_lock'
 class AnyCache
   require_relative 'any_cache/version'
   require_relative 'any_cache/error'
+  require_relative 'any_cache/dumper'
   require_relative 'any_cache/drivers'
   require_relative 'any_cache/adapters'
   require_relative 'any_cache/logging'
@@ -95,6 +96,7 @@ class AnyCache
                           :expire,
                           :persist,
                           :clear,
+                          :cleanup,
                           :exist?
 
   # @return [AnyCache::Adapters::Basic]

data/lib/any_cache/adapters/active_support_dalli_store.rb

@@ -46,28 +46,28 @@ module AnyCache::Adapters
     DEAD_TTL = 0
 
     # @since 0.3.0
-    def_delegators :driver, :delete, :clear
+    def_delegators :driver, :delete, :clear, :cleanup
 
     # @param key [String]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [void]
     #
     # @api private
     # @since 0.3.0
     def read(key, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.read(key, raw: raw)
     end
 
     # @param keys [Array<String>]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [Hash]
     #
     # @api private
     # @since 0.3.0
     def read_multi(*keys, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.read_multi(*keys, raw: raw).tap do |entries|
         entries.merge!(Hash[(keys - entries.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
@@ -77,25 +77,26 @@ module AnyCache::Adapters
     # @param key [String]
     # @param value [Object]
     # @option expires_in [NilClass, Integer] Time in seconds
+    # @option raw [Boolean]
     # @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)
+      raw = options.fetch(:raw, false)
 
       driver.write(key, value, expires_in: expires_in, raw: raw)
     end
 
     # @param entries [Hash]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [void]
     #
     # @api private
     # @since 0.3.0
     def write_multi(entries, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       # NOTE: ActiveSupport::Cache::DalliStore does not support #write_multi :\
       entries.each_pair do |key, value|
@@ -106,6 +107,7 @@ module AnyCache::Adapters
     # @param key [String]
     # @option expires_in [Integer]
     # @option force [Boolean, Proc]
+    # @option raw [Boolean]
     # @return [Object]
     #
     # @api private
@@ -114,8 +116,9 @@ module AnyCache::Adapters
       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, false)
 
-      driver.fetch(key, force: force_rewrite, expires_in: expires_in, &fallback)
+      driver.fetch(key, force: force_rewrite, expires_in: expires_in, raw: raw, &fallback)
     end
 
     # @param keys [Array<String>]
@@ -142,7 +145,7 @@ module AnyCache::Adapters
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
 
       unless exist?(key)
-        write(key, amount, expires_in: expires_in) && amount
+        write(key, amount, expires_in: expires_in, raw: true) && amount
       else
         driver.increment(key, amount).tap do
           expire(key, expires_in: expires_in) if expires_in
@@ -165,7 +168,8 @@ module AnyCache::Adapters
         #   - non-raw values;
         #   - values lower than zero;
         #   - empty entries;
-        write(key, INITIAL_DECREMNETED_VALUE, expires_in: expires_in) && INITIAL_DECREMNETED_VALUE
+        write(key, INITIAL_DECREMNETED_VALUE, expires_in: expires_in, raw: true)
+        INITIAL_DECREMNETED_VALUE
       else
         driver.decrement(key, amount).tap do
           expire(key, expires_in: expires_in) if expires_in
@@ -190,9 +194,9 @@ module AnyCache::Adapters
     # @api private
     # @since 0.3.0
     def expire(key, expires_in: DEAD_TTL)
-      read(key).tap do |value|
+      read(key, raw: true).tap do |value|
         is_alive = expires_in ? expires_in.positive? : false
-        is_alive ? write(key, value, expires_in: expires_in) : delete(key)
+        is_alive ? write(key, value, expires_in: expires_in, raw: true) : delete(key)
       end
     end
 

data/lib/any_cache/adapters/active_support_mem_cache_store.rb

@@ -51,25 +51,25 @@ module AnyCache::Adapters
     def_delegators :driver, :delete, :clear
 
     # @param key [String]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [Object]
     #
     # @api private
     # @since 0.2.0
     def read(key, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.read(key, raw: raw)
     end
 
     # @param keys [Array<String>]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [Hash]
     #
     # @api private
     # @since 0.3.0
     def read_multi(*keys, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.read_multi(*keys, raw: raw).tap do |entries|
         entries.merge!(Hash[(keys - entries.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
@@ -79,25 +79,26 @@ module AnyCache::Adapters
     # @param key [String]
     # @param value [Object]
     # @option expires_in [NilClass, Integer] Time in seconds
+    # @option raw [Boolean]
     # @return [void]
     #
     # @api private
     # @sicne 0.2.0
     def write(key, value, **options)
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.write(key, value, expires_in: expires_in, raw: raw)
     end
 
     # @param entries [Hash]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [void]
     #
     # @api private
     # @since 0.3.0
     def write_multi(entries, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.write_multi(entries, expires_in: NO_EXPIRATION_TTL, raw: raw)
     end
@@ -105,6 +106,7 @@ module AnyCache::Adapters
     # @param key [String]
     # @option expires_in [Integer]
     # @option force [Boolean, Proc]
+    # @option raw [Boolean]
     # @return [Object]
     #
     # @api private
@@ -113,8 +115,9 @@ module AnyCache::Adapters
       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, false)
 
-      driver.fetch(key, force: force_rewrite, expires_in: expires_in, &fallback)
+      driver.fetch(key, force: force_rewrite, expires_in: expires_in, raw: raw, &fallback)
     end
 
     # @param keys [Array<String>]
@@ -151,7 +154,7 @@ module AnyCache::Adapters
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
 
       unless exist?(key)
-        write(key, amount, expires_in: expires_in) && amount
+        write(key, amount, expires_in: expires_in, raw: true) && amount
       else
         driver.increment(key, amount).tap do
           expire(key, expires_in: expires_in) if expires_in
@@ -174,7 +177,8 @@ module AnyCache::Adapters
         #   - non-raw values;
         #   - values lower than zero;
         #   - empty entries;
-        write(key, INITIAL_DECREMNETED_VALUE, expires_in: expires_in) && INITIAL_DECREMNETED_VALUE
+        write(key, INITIAL_DECREMNETED_VALUE, expires_in: expires_in, raw: true)
+        INITIAL_DECREMNETED_VALUE
       else
         driver.decrement(key, amount).tap do
           expire(key, expires_in: expires_in) if expires_in
@@ -189,9 +193,9 @@ module AnyCache::Adapters
     # @api private
     # @since 0.2.0
     def expire(key, expires_in: DEAD_TTL)
-      read(key).tap do |value|
+      read(key, raw: true).tap do |value|
         is_alive = expires_in ? expires_in.positive? : false
-        is_alive ? write(key, value, expires_in: expires_in) : delete(key)
+        is_alive ? write(key, value, expires_in: expires_in, raw: true) : delete(key)
       end
     end
 
@@ -214,5 +218,14 @@ module AnyCache::Adapters
     def exist?(key, **options)
       driver.exist?(key)
     end
+
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      # NOTE: manual removing is not supported (memcached doing this by itself)
+    end
   end
 end

data/lib/any_cache/adapters/active_support_naive_store.rb

@@ -77,6 +77,15 @@ module AnyCache::Adapters
       lock.with_write_lock { super }
     end
 
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      lock.with_write_lock { super }
+    end
+
     # @param key [String]
     # @param value [Object]
     # @param options [Hash]

data/lib/any_cache/adapters/active_support_redis_cache_store.rb

@@ -23,9 +23,6 @@ module AnyCache::Adapters
     # @since 0.3.0
     READ_MULTI_EMPTY_KEYS_SET = [].freeze
 
-    # @since 0.1.0
-    def_delegators :driver, :delete, :delete_matched, :clear
-
     # @return [NilClass]
     #
     # @api private
@@ -44,26 +41,29 @@ module AnyCache::Adapters
     # @since 0.1.0
     DEFAULT_INCR_DECR_AMOUNT = 1
 
+    # @since 0.1.0
+    def_delegators :driver, :delete, :delete_matched, :clear
+
     # @param key [String]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [Object]
     #
     # @api private
     # @since 0.1.0
     def read(key, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.read(key, raw: raw)
     end
 
     # @param keys [Array<String>]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [Hash]
     #
     # @api private
     # @since 0.3.0
     def read_multi(*keys, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.read_multi(*keys, raw: raw).tap do |res|
         res.merge!(Hash[(keys - res.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
@@ -73,25 +73,26 @@ module AnyCache::Adapters
     # @param key [String]
     # @param value [Object]
     # @option expires_in [NilClass, Integer] Time in seconds
+    # @option raw [Boolean]
     # @return [void]
     #
     # @api private
     # @since 0.1.0
     def write(key, value, **options)
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.write(key, value, expires_in: expires_in, raw: raw)
     end
 
     # @param entries [Hash]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [void]
     #
     # @api private
     # @sicne 0.3.0
     def write_multi(entries, **options)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
 
       driver.write_multi(entries, expires_in: NO_EXPIRATION_TTL, raw: raw)
     end
@@ -100,6 +101,7 @@ module AnyCache::Adapters
     # @param fallback [Proc]
     # @option expires_in [Integer]
     # @option force [Boolean, Proc]
+    # @option raw [Boolean]
     # @return [Object]
     #
     # @api private
@@ -108,7 +110,7 @@ module AnyCache::Adapters
       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)
+      raw           = options.fetch(:raw, false)
 
       driver.fetch(key, force: force_rewrite, expires_in: expires_in, raw: raw, &fallback)
     end
@@ -141,7 +143,7 @@ module AnyCache::Adapters
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
 
       unless exist?(key)
-        write(key, amount, expires_in: expires_in) && amount
+        write(key, amount, expires_in: expires_in, raw: true) && amount
       else
         driver.increment(key, amount).tap do
           expire(key, expires_in: expires_in) if expires_in
@@ -160,7 +162,7 @@ module AnyCache::Adapters
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
 
       unless exist?(key)
-        write(key, -amount, expires_in: expires_in) && -amount
+        write(key, -amount, expires_in: expires_in, raw: true) && -amount
       else
         driver.decrement(key, amount).tap do
           expire(key, expires_in: expires_in) if expires_in
@@ -175,9 +177,12 @@ module AnyCache::Adapters
     # @api private
     # @since 0.1.0
     def expire(key, expires_in: DEAD_TTL)
-      read(key).tap do |value|
+      # NOTE:
+      #   raw is true cuz we want the raw cached value.
+      #   this raw value would be cached again if needed.
+      read(key, raw: true).tap do |value|
         is_alive = expires_in ? expires_in.positive? : false
-        is_alive ? write(key, value, expires_in: expires_in) : delete(key)
+        is_alive ? write(key, value, expires_in: expires_in, raw: true) : delete(key)
       end
     end
 
@@ -200,5 +205,14 @@ module AnyCache::Adapters
     def exist?(key, **options)
       driver.exist?(key)
     end
+
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      # NOTE: manual removing is not suppored (redis doing this by itself)
+    end
   end
 end

data/lib/any_cache/adapters/basic.rb

@@ -6,6 +6,8 @@ module AnyCache::Adapters
   class Basic
     # @since 0.1.0
     extend Forwardable
+    # @since 0.4.0
+    include AnyCache::Dumper::InterfaceAccessMixin
 
     class << self
       # @param driver [Object]
@@ -167,6 +169,15 @@ module AnyCache::Adapters
       raise NotImplementedError
     end
 
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      raise NotImplementedError
+    end
+
     # @param key [String]
     # @param options [Hash]
     # @return [Boolean]

data/lib/any_cache/adapters/dalli.rb

@@ -57,29 +57,46 @@ module AnyCache::Adapters
                    :flush
 
     # @param key [String]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [Object]
     #
     # @api private
     # @since 0.1.0
     def read(key, **options)
-      get(key)
+      raw = options.fetch(:raw, false)
+      value = get(key)
+
+      raw ? value : detransform_value(value)
     end
 
     # @param keys [Array<String>]
-    # @param options [Hash]
+    # @option raw [Boolean]
     # @return [Hash]
     #
     # @api private
     # @since 0.3.0
     def read_multi(*keys, **options)
-      get_multi(*keys).tap do |res|
-        res.merge!(Hash[(keys - res.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
+      raw = options.fetch(:raw, false)
+
+      entries = get_multi(*keys).tap do |res|
+        # NOTE:
+        #   dalli does not return nonexistent entries
+        #   but we want to be consistent with another cache storages
+        #   that returns nonexistent antries as { key => nil } pair
+        res.merge!(Hash[(keys.map(&:to_s) - res.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
+
+        # NOTE:
+        #   dalli stringifies requred keys but we want to be consistent with symbol keys
+        #   cuz another cache storages are already consistent
+        keys.each { |key| res.key?(key) ? next : (res[key] = res.delete(key.to_s)) }
       end
+
+      raw ? entries : detransform_pairset(entries)
     end
 
     # @param key [String]
     # @param value [Object]
+    # @option raw [Boolean]
     # @option expires_in [Integer]
     # @return [void]
     #
@@ -87,7 +104,8 @@ module AnyCache::Adapters
     # @since 0.1.0
     def write(key, value, **options)
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
-      raw = options.fetch(:raw, true)
+      raw = options.fetch(:raw, false)
+      value = transform_value(value) unless raw
 
       set(key, value, expires_in, raw: raw)
     end
@@ -99,9 +117,7 @@ module AnyCache::Adapters
     # @api private
     # @since 0.3.0
     def write_multi(entries, **options)
-      raw = options.fetch(:raw, true)
-
-      entries.each_pair { |key, value| write(key, value, raw: raw) }
+      entries.each_pair { |key, value| write(key, value, **options) }
     end
 
     # @param key [String]
@@ -117,7 +133,7 @@ module AnyCache::Adapters
       force_rewrite = force_rewrite.call(key) if force_rewrite.respond_to?(:call)
 
       # NOTE: can conflict with :cache_nils Dalli::Client's config
-      read(key).tap { |value| return value if value } unless force_rewrite
+      read(key, **options).tap { |value| return value if value } unless force_rewrite
 
       yield(key).tap { |value| write(key, value, **options) } if block_given?
     end
@@ -219,6 +235,15 @@ module AnyCache::Adapters
       flush(0) # NOTE: 0 is a flush delay
     end
 
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      # NOTE: manual removing is not suppored (memcached doing it by itself)
+    end
+
     # @param key [String]
     # @param options [Hash]
     # @return [Boolean]