any_cache 0.0.0 → 0.1.0

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class AnyCache::Adapters::ActiveSupportNaiveStore
+  # @api private
+  # @since 0.1.0
+  class Persist < Operation
+    # @param key [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def call(key)
+      fetch_entry(key).tap do |entry|
+        write(key, entry.value, expires_in: NO_EXPIRATION_TTL) if entry
+      end
+    end
+
+    # @!method fetch_entry(key)
+    #   @param key [String]
+    #   @return [NilClass, ActiveSupport::Cache::Entry]
+  end
+end

data/lib/any_cache/adapters/active_support_redis_cache_store.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class ActiveSupportRedisCacheStore < Basic
+    # TODO: think about locks
+
+    class << self
+      # @param driver [Object]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.1.0
+      def supported_driver?(driver)
+        defined?(::Redis) &&
+        defined?(::ActiveSupport::Cache::RedisCacheStore) &&
+        driver.is_a?(::ActiveSupport::Cache::RedisCacheStore)
+      end
+    end
+
+    # @since 0.1.0
+    def_delegators :driver, :delete, :clear
+
+    # @return [NilClass]
+    #
+    # @api private
+    # @since 0.1.0
+    NO_EXPIRATION_TTL = nil
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.1.0
+    DEAD_TTL = 0
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.1.0
+    DEFAULT_INCR_DECR_AMOUNT = 1
+
+    # @param key
+    # @param options [Hash]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.1.0
+    def read(key, **options)
+      driver.read(key, raw: true)
+    end
+
+    # @param key [String]
+    # @param value [Object]
+    # @option expires_in [NilClass, Integer] Time in seconds
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def write(key, value, **options)
+      expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      driver.write(key, value, expires_in: expires_in, raw: true)
+    end
+
+    # @param key [String]
+    # @param amount [Integer, Float]
+    # @option expires_in [Integer]
+    # @return [Integer, Float]
+    #
+    # @api private
+    # @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
+        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, Float]
+    # @option expires_in [Integer]
+    # @return [Integer, Float]
+    #
+    # @api private
+    # @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
+        write(key, -amount, expires_in: expires_in) && -amount
+      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.1.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.1.0
+    def persist(key, **options)
+      read(key).tap { |value| write(key, value) }
+    end
+  end
+end

data/lib/any_cache/adapters/basic.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class Basic
+    # @since 0.1.0
+    extend Forwardable
+
+    class << self
+      # @param driver [Object]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.1.0
+      def supported_driver?(driver)
+        false
+      end
+    end
+
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.1.0
+    attr_reader :driver
+
+    # @param driver [Object]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def initialize(driver)
+      @driver = driver
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.1.0
+    def read(key, **options)
+      raise NotImplementedError
+    end
+
+    # @param key [String]
+    # @param value [Object]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @sinc 0.1.0
+    def write(key, value, **options)
+      raise NotImplementedError
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def delete(key, **options)
+      raise NotImplementedError
+    end
+
+    # @param key [String]
+    # @param value [Integer, Float]
+    # @param options [Hash]
+    # @return [Integer, Float]
+    #
+    # @api private
+    # @sinc 0.1.0
+    def increment(key, value, **options)
+      raise NotImplementedError
+    end
+
+    # @param key [String]
+    # @param value [Integer, Float]
+    # @param options [Hash]
+    # @return [Integer, Float]
+    #
+    # @api private
+    # @since 0.1.0
+    def decrement(key, value, **options)
+      raise NotImplementedError
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def expire(key, expires_in:)
+      raise NotImplementedError
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def persist(key, **options)
+      raise NotImplementedError
+    end
+
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def clear(**options)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/any_cache/adapters/dalli.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class Dalli < Basic
+    class << self
+      # @param driver [Object]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.1.0
+      def supported_driver?(driver)
+        defined?(::Dalli::Client) && driver.is_a?(::Dalli::Client)
+      end
+    end
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.1.0
+    NO_EXPIRATION_TTL = 0
+
+    # @return [NilClass]
+    #
+    # @api private
+    # @since 0.1.0
+    DEAD_TTL = nil
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.1.0
+    DEFAULT_INCR_DECR_AMOUNT = 1
+
+    # @return [Integer]
+    #
+    # @api private
+    # @since 0.1.0
+    MIN_DECRESEAD_VAL = 0
+
+    # @since 0.1.0
+    def_delegators :driver,
+                   :get,
+                   :set,
+                   :incr,
+                   :decr,
+                   :multi,
+                   :touch,
+                   :flush
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.1.0
+    def read(key, **options)
+      get(key)
+    end
+
+    def write(key, value, **options)
+      expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      set(key, value, expires_in, raw: true)
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def delete(key, **options)
+      driver.delete(key)
+    end
+
+    # @param key [String]
+    # @param amount [Integer]
+    # @option expires_in [NilClass, Integer]
+    # @return [NilClass, Integer]
+    #
+    # @api private
+    # @since 0.1.0
+    def increment(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
+      expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      # TODO: think about #cas and Concurrent::ReentrantReadWriteLock
+      incr(key, amount, expires_in, amount).tap do |new_amount|
+        touch(key, expires_in) if new_amount && expires_in.positive?
+      end
+    end
+
+    # @param key [String]
+    # @param amount [Integer]
+    # @option expires_in [NilClass, Integer]
+    # @return [NilClass, Integer]
+    #
+    # @api private
+    # @since 0.1.0
+    def decrement(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
+      expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
+
+      # TODO: think about #cas and Concurrent::ReentrantReadWriteLock
+      decr(key, amount, expires_in, MIN_DECRESEAD_VAL).tap do |new_amount|
+        touch(key, expires_in) if new_amount && expires_in.positive?
+      end
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def expire(key, expires_in: DEAD_TTL)
+      is_alive = expires_in ? expires_in.positive? : false
+      is_alive ? touch(key, expires_in) : driver.delete(key)
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def persist(key, **options)
+      touch(key, NO_EXPIRATION_TTL)
+    end
+
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def clear(**options)
+      flush(0) # NOTE: 0 is a flush delay
+    end
+  end
+end

data/lib/any_cache/adapters/delegator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class Delegator < Basic
+    class << self
+      # @param driver [Object]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.1.0
+      def supported_driver?(driver)
+        driver.respond_to?(:read) &&
+        driver.respond_to?(:write) &&
+        driver.respond_to?(:delete) &&
+        driver.respond_to?(:increment) &&
+        driver.respond_to?(:decrement) &&
+        driver.respond_to?(:expire) &&
+        driver.respond_to?(:persist) &&
+        driver.respond_to?(:clear)
+      end
+    end
+
+    # @since 0.1.0
+    def_delegators :driver,
+                   :read,
+                   :write,
+                   :delete,
+                   :increment,
+                   :decrement,
+                   :expire,
+                   :persist,
+                   :clear
+  end
+end