any_cache 0.1.0 → 0.2.0

data/lib/any_cache/adapters/active_support_mem_cache_store.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.2.0
+  class ActiveSupportMemCacheStore < Basic
+    # NOTE: think about locks (Concurrent::ReentrantReadWriteLock)
+
+    class << self
+      # @param driver [Object]
+      # @retunr [Boolean]
+      #
+      # @api private
+      # @since 0.2.0
+      def supported_driver?(driver)
+        AnyCache::Drivers::ActiveSupportMemCacheStore.supported_source?(driver)
+      end
+    end
+
+    # @return [NilClass]
+    #
+    # @api private
+    # @since 0.2.0
+    NO_EXPIRATION_TTL = nil
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.2.0
+    DEAD_TTL = 0
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.2.0
+    DEFAULT_INCR_DECR_AMOUNT = 1
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.2.0
+    INITIAL_DECREMNETED_VALUE = 0
+
+    # @since 0.2.0
+    def_delegators :driver, :delete, :clear
+
+    # @param key
+    # @param options [Hash]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def read(key, **options)
+      raw = options.fetch(:raw, true)
+
+      driver.read(key, raw: raw)
+    end
+
+    # @param key [String]
+    # @param value [Object]
+    # @option expires_in [NilClass, Integer] Time in seconds
+    # @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)
+
+      driver.write(key, value, expires_in: expires_in, raw: raw)
+    end
+
+    # @param key [String]
+    # @param amount [Integer]
+    # @options expires_in [Integer]
+    # @return [Integer, Float]
+    #
+    # @api private
+    # @since 0.2.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.2.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 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 key [String]
+    # @option expires_in [Integer]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.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
+    # @sicne 0.2.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.2.0
+    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_memory_store.rb

@@ -18,8 +18,7 @@ module AnyCache::Adapters
       # @api private
       # @since 0.1.0
       def supported_driver?(driver)
-        defined?(::ActiveSupport::Cache::MemoryStore) &&
-        driver.is_a?(::ActiveSupport::Cache::MemoryStore)
+        AnyCache::Drivers::ActiveSupportMemoryStore.supported_source?(driver)
       end
     end
   end

data/lib/any_cache/adapters/active_support_naive_store.rb

@@ -118,6 +118,33 @@ module AnyCache::Adapters
       lock.with_write_lock { pers_operation.call(key) }
     end
 
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def exist?(key, **options)
+      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]
@@ -145,6 +172,9 @@ module AnyCache::Adapters
     attr_reader :expr_operation
 
     # @return [Operation::Persist]
+    #
+    # @api private
+    # @since 0.1.0
     attr_reader :pers_operation
   end
 end

data/lib/any_cache/adapters/active_support_redis_cache_store.rb

@@ -4,7 +4,7 @@ module AnyCache::Adapters
   # @api private
   # @since 0.1.0
   class ActiveSupportRedisCacheStore < Basic
-    # TODO: think about locks
+    # TODO: think about locks (Concurrent::ReentrantReadWriteLock)
 
     class << self
       # @param driver [Object]
@@ -13,9 +13,7 @@ module AnyCache::Adapters
       # @api private
       # @since 0.1.0
       def supported_driver?(driver)
-        defined?(::Redis) &&
-        defined?(::ActiveSupport::Cache::RedisCacheStore) &&
-        driver.is_a?(::ActiveSupport::Cache::RedisCacheStore)
+        AnyCache::Drivers::ActiveSupportRedisCacheStore.supported_source?(driver)
       end
     end
 
@@ -47,7 +45,9 @@ module AnyCache::Adapters
     # @api private
     # @since 0.1.0
     def read(key, **options)
-      driver.read(key, raw: true)
+      raw = options.fetch(:raw, true)
+
+      driver.read(key, raw: raw)
     end
 
     # @param key [String]
@@ -59,8 +59,9 @@ 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)
 
-      driver.write(key, value, expires_in: expires_in, raw: true)
+      driver.write(key, value, expires_in: expires_in, raw: raw)
     end
 
     # @param key [String]
@@ -72,9 +73,8 @@ module AnyCache::Adapters
     # @since 0.1.0
     def increment(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
-      is_initial = expires_in && !read(key)
 
-      if is_initial
+      unless exist?(key)
         write(key, amount, expires_in: expires_in) && amount
       else
         driver.increment(key, amount).tap do
@@ -92,9 +92,8 @@ module AnyCache::Adapters
     # @since 0.1.0
     def decrement(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
-      is_initial = expires_in && !read(key)
 
-      if is_initial
+      unless exist?(key)
         write(key, -amount, expires_in: expires_in) && -amount
       else
         driver.decrement(key, amount).tap do
@@ -125,5 +124,30 @@ module AnyCache::Adapters
     def persist(key, **options)
       read(key).tap { |value| write(key, value) }
     end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    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

@@ -114,5 +114,25 @@ module AnyCache::Adapters
     def clear(**options)
       raise NotImplementedError
     end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    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

data/lib/any_cache/adapters/dalli.rb

@@ -11,7 +11,7 @@ module AnyCache::Adapters
       # @api private
       # @since 0.1.0
       def supported_driver?(driver)
-        defined?(::Dalli::Client) && driver.is_a?(::Dalli::Client)
+        AnyCache::Drivers::Dalli.supported_source?(driver)
       end
     end
 
@@ -61,8 +61,9 @@ module AnyCache::Adapters
 
     def write(key, value, **options)
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+      raw = options.fetch(:raw, true)
 
-      set(key, value, expires_in, raw: true)
+      set(key, value, expires_in, raw: raw)
     end
 
     # @param key [String]
@@ -136,5 +137,32 @@ module AnyCache::Adapters
     def clear(**options)
       flush(0) # NOTE: 0 is a flush delay
     end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def exist?(key, **options)
+      !get(key).nil? # NOTE: can conflict with :cache_nils Dalli::Client's config
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @option force [Boolean]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def fetch(key, **options)
+      force_rewrite = options.fetch(:force, false)
+      force_rewrite = force_rewrite.call 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
+
+      yield.tap { |value| write(key, value, **options) } if block_given?
+    end
   end
 end

data/lib/any_cache/adapters/delegator.rb

@@ -18,7 +18,9 @@ module AnyCache::Adapters
         driver.respond_to?(:decrement) &&
         driver.respond_to?(:expire) &&
         driver.respond_to?(:persist) &&
-        driver.respond_to?(:clear)
+        driver.respond_to?(:clear) &&
+        driver.respond_to?(:exist?) &&
+        driver.respond_to?(:fetch)
       end
     end
 
@@ -31,6 +33,8 @@ module AnyCache::Adapters
                    :decrement,
                    :expire,
                    :persist,
-                   :clear
+                   :clear,
+                   :exist?,
+                   :fetch
   end
 end

data/lib/any_cache/adapters/redis.rb

@@ -11,7 +11,7 @@ module AnyCache::Adapters
       # @api private
       # @since 0.1.0
       def supported_driver?(driver)
-        defined?(::Redis) && driver.is_a?(::Redis)
+        AnyCache::Drivers::Redis.supported_source?(driver)
       end
     end
 
@@ -42,7 +42,8 @@ module AnyCache::Adapters
                    :incrby,
                    :decrby,
                    :pipelined,
-                   :flushdb
+                   :flushdb,
+                   :exists
 
     # @param key [String]
     # @param options [Hash]
@@ -88,7 +89,6 @@ module AnyCache::Adapters
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
       new_amount = nil
 
-      # TODO: think about Redis#multi
       pipelined do
         new_amount = incrby(key, amount)
         expire(key, expires_in: expires_in) if expires_in
@@ -108,7 +108,6 @@ module AnyCache::Adapters
       expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
       new_amount = nil
 
-      # TODO: think about Redis#multi
       pipelined do
         new_amount = decrby(key, amount)
         expire(key, expires_in: expires_in) if expires_in
@@ -147,5 +146,32 @@ module AnyCache::Adapters
     def clear(**options)
       flushdb
     end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def exist?(key, **options)
+      exists(key)
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @option force [Boolean]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def fetch(key, **options)
+      force_rewrite = options.fetch(:force, false)
+      force_rewrite = force_rewrite.call if force_rewrite.respond_to?(:call)
+
+      # NOTE: think about #pipelined
+      read(key).tap { |value| return value if value } unless force_rewrite
+
+      yield.tap { |value| write(key, value, **options) } if block_given?
+    end
   end
 end

data/lib/any_cache/adapters/redis_store.rb

@@ -11,7 +11,7 @@ module AnyCache::Adapters
       # @api private
       # @since 0.1.0
       def supported_driver?(driver)
-        defined?(::Redis::Store) && driver.is_a?(::Redis::Store)
+        AnyCache::Drivers::RedisStore.supported_source?(driver)
       end
     end
 
@@ -22,7 +22,9 @@ module AnyCache::Adapters
     # @api private
     # @since 0.1.0
     def read(key, **options)
-      get(key, raw: true)
+      raw = options.fetch(:raw, true)
+
+      get(key, raw: raw)
     end
 
     # @param key [String]
@@ -34,8 +36,9 @@ 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)
 
-      expires_in ? setex(key, expires_in, value, raw: true) : set(key, value, raw: true)
+      expires_in ? setex(key, expires_in, value, raw: raw) : set(key, value, raw: raw)
     end
   end
 end

data/lib/any_cache/adapters.rb

@@ -12,12 +12,13 @@ module AnyCache::Adapters
   require_relative 'adapters/active_support_file_store'
   require_relative 'adapters/active_support_redis_cache_store'
   require_relative 'adapters/active_support_memory_store'
+  require_relative 'adapters/active_support_mem_cache_store'
 
   class << self
     # @param driver [Object]
     # @return [AnyCache::Adapters::Basic]
     #
-    # @raise [AnyCache::UnsupportedCacheDriverError]
+    # @raise [AnyCache::UnsupportedDriverError]
     #
     # @api private
     # @since 0.1.0
@@ -30,9 +31,10 @@ module AnyCache::Adapters
       when ActiveSupportRedisCacheStore.supported_driver?(driver) then ActiveSupportRedisCacheStore.new(driver)
       when ActiveSupportMemoryStore.supported_driver?(driver)     then ActiveSupportMemoryStore.new(driver)
       when ActiveSupportFileStore.supported_driver?(driver)       then ActiveSupportFileStore.new(driver)
+      when ActiveSupportMemCacheStore.supported_driver?(driver)   then ActiveSupportMemCacheStore.new(driver)
       when Delegator.supported_driver?(driver)                    then Delegator.new(driver)
       else
-        raise AnyCache::UnsupportedCacheDriverError
+        raise AnyCache::UnsupportedDriverError
       end
     end
     # rubocop:enable Metrics/LineLength

data/lib/any_cache/drivers/active_support_file_store.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module AnyCache::Drivers::ActiveSupportFileStore
+  class << self
+    # @param driver [::ActiveSupport::Cache::FileStore]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def supported_source?(driver)
+      defined?(::ActiveSupport::Cache::FileStore) &&
+      driver.is_a?(::ActiveSupport::Cache::FileStore)
+    end
+
+    # @param settings [Qonfig::Settings]
+    # @return [::ActiveSupport::Cache::FileStore]
+    #
+    # @api private
+    # @sicne 0.2.0
+    def build(settings)
+      ::ActiveSupport::Cache::FileStore.new(settings.cache_path, settings.options)
+    end
+  end
+end

data/lib/any_cache/drivers/active_support_mem_cache_store.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AnyCache::Drivers::ActiveSupportMemCacheStore
+  class << self
+    # @param driver [::ActiveSupport::Cache::MemCacheStore]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def supported_source?(driver)
+      defined?(::Dalli) &&
+      defined?(::ActiveSupport::Cache::MemCacheStore) &&
+      driver.is_a?(::ActiveSupport::Cache::MemCacheStore)
+    end
+
+    # @param settings [Qonfig:Settings]
+    # @return [::ActiveSupport::Cache::MemCacheStore]
+    #
+    # @api private
+    # @since 0.2.0
+    def build(settings)
+      ::ActiveSupport::Cache::MemCacheStore.new([Array(settings.servers), settings.options])
+    end
+  end
+end

data/lib/any_cache/drivers/active_support_memory_store.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module AnyCache::Drivers::ActiveSupportMemoryStore
+  class << self
+    # @param driver [::ActiveSupport::Cache::MemoryStore]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def supported_source?(driver)
+      defined?(::ActiveSupport::Cache::MemoryStore) &&
+      driver.is_a?(::ActiveSupport::Cache::MemoryStore)
+    end
+
+    # @param settings [Qonfig::Settings]
+    # @return [::ActiveSupport::Cache::MemoryStore]
+    #
+    # @api private
+    # @sicne 0.2.0
+    def build(settings)
+      ::ActiveSupport::Cache::MemoryStore.new(settings.options)
+    end
+  end
+end

data/lib/any_cache/drivers/active_support_redis_cache_store.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module AnyCache::Drivers::ActiveSupportRedisCacheStore
+  class << self
+    # @param driver [::ActiveSupport::Cache::RedisCacheStore]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def supported_source?(driver)
+      defined?(::Redis) &&
+      defined?(::ActiveSupport::Cache::RedisCacheStore) &&
+      driver.is_a?(::ActiveSupport::Cache::RedisCacheStore)
+    end
+
+    # @param settings [Qonfig::Settings]
+    # @return [::ActiveSupport::Cache::RedisCacheStore]
+    #
+    # @api private
+    # @sicne 0.2.0
+    def build(settings)
+      ::ActiveSupport::Cache::RedisCacheStore.new(settings.options)
+    end
+  end
+end

data/lib/any_cache/drivers/dalli.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module AnyCache::Drivers::Dalli
+  class << self
+    # @param driver [::Dalli::Client]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def supported_source?(driver)
+      defined?(::Dalli::Client) && driver.is_a?(::Dalli::Client)
+    end
+
+    # @param settings [Qonfig::Settings]
+    # @return [::Dalli::Client]
+    #
+    # @api private
+    # @sicne 0.2.0
+    def build(settings)
+      ::Dalli::Client.new(Array(settings.servers), settings.options)
+    end
+  end
+end

data/lib/any_cache/drivers/redis.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module AnyCache::Drivers::Redis
+  class << self
+    # @param driver [::Redis]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.2.0
+    def supported_source?(driver)
+      defined?(::Redis) && driver.is_a?(::Redis)
+    end
+
+    # @param settings [Qonfig::Settings]
+    # @return [::Redis]
+    #
+    # @api private
+    # @sicne 0.2.0
+    def build(settings)
+      ::Redis.new(settings.options)
+    end
+  end
+end