any_cache 0.0.0 → 0.1.0

data/lib/any_cache/adapters/redis.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class Redis < Basic
+    class << self
+      # @param driver [Object]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.1.0
+      def supported_driver?(driver)
+        defined?(::Redis) && driver.is_a?(::Redis)
+      end
+    end
+
+    # @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
+
+    # @since 0.1.0
+    def_delegators :driver,
+                   :get,
+                   :set,
+                   :setex,
+                   :del,
+                   :incrby,
+                   :decrby,
+                   :pipelined,
+                   :flushdb
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.1.0
+    def read(key, **options)
+      get(key)
+    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)
+
+      expires_in ? setex(key, expires_in, value) : set(key, value)
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def delete(key, **options)
+      del(key)
+    end
+
+    # @param key [String]
+    # @param amount [Integer]
+    # @option expires_in [NilClass, Integer] Time in seconds
+    # @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)
+      new_amount = nil
+
+      # TODO: think about Redis#multi
+      pipelined do
+        new_amount = incrby(key, amount)
+        expire(key, expires_in: expires_in) if expires_in
+      end
+
+      new_amount&.value
+    end
+
+    # @param key [String]
+    # @param amount [Integer]
+    # @options expires_in [NillClass, Integer] Time in seconds
+    # @return [NillClass, 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)
+      new_amount = nil
+
+      # TODO: think about Redis#multi
+      pipelined do
+        new_amount = decrby(key, amount)
+        expire(key, expires_in: expires_in) if expires_in
+      end
+
+      new_amount&.value
+    end
+
+    # @param key [String]
+    # @option expires_in [Integer]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def expire(key, expires_in: DEAD_TTL)
+      expires_in ||= DEAD_TTL unless expires_in
+
+      driver.expire(key, expires_in)
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def persist(key, **options)
+      driver.persist(key)
+    end
+
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def clear(**options)
+      flushdb
+    end
+  end
+end

data/lib/any_cache/adapters/redis_store.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class RedisStore < Redis
+    class << self
+      # @param driver [Object]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.1.0
+      def supported_driver?(driver)
+        defined?(::Redis::Store) && driver.is_a?(::Redis::Store)
+      end
+    end
+
+    # @param key [String]
+    # @param options [Hash]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.1.0
+    def read(key, **options)
+      get(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)
+
+      expires_in ? setex(key, expires_in, value, raw: true) : set(key, value, raw: true)
+    end
+  end
+end

data/lib/any_cache/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class AnyCache
+  # @since 0.1.0
+  Error = Class.new(StandardError)
+
+  # @since 0.1.0
+  UnsupportedDriverError = Class.new(Error)
+end

data/lib/any_cache/version.rb

@@ -1,3 +1,6 @@
-module AnyCache
-  VERSION = "0.0.0"
+# frozen_string_literal: true
+
+class AnyCache
+  # @since 0.1.0
+  VERSION = '0.1.0'
 end

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: any_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-19 00:00:00.000000000 Z
+date: 2018-08-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: armitage-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: qonfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +136,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Soon
+description: AnyCache - a simplest cache wrapper that provides a minimalistic generic
+  interface for the all well-known cache storages and includes a minimal set of necessary
+  operations.
 email:
 - iamdaiver@icloud.com
 executables: []
@@ -61,7 +147,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -69,8 +157,42 @@ files:
 - Rakefile
 - any_cache.gemspec
 - bin/console
+- bin/rspec
 - bin/setup
+- gemfiles/active_support.gemfile
+- gemfiles/active_support_with_redis.gemfile
+- gemfiles/dalli.gemfile
+- gemfiles/redis.gemfile
+- gemfiles/redis_store.gemfile
 - lib/any_cache.rb
+- lib/any_cache/adapters.rb
+- lib/any_cache/adapters/active_support_file_store.rb
+- lib/any_cache/adapters/active_support_file_store/decrement.rb
+- lib/any_cache/adapters/active_support_file_store/expire.rb
+- lib/any_cache/adapters/active_support_file_store/fetching.rb
+- lib/any_cache/adapters/active_support_file_store/increment.rb
+- lib/any_cache/adapters/active_support_file_store/operation.rb
+- lib/any_cache/adapters/active_support_file_store/persist.rb
+- lib/any_cache/adapters/active_support_memory_store.rb
+- lib/any_cache/adapters/active_support_memory_store/decrement.rb
+- lib/any_cache/adapters/active_support_memory_store/expire.rb
+- lib/any_cache/adapters/active_support_memory_store/fetching.rb
+- lib/any_cache/adapters/active_support_memory_store/increment.rb
+- lib/any_cache/adapters/active_support_memory_store/operation.rb
+- lib/any_cache/adapters/active_support_memory_store/persist.rb
+- lib/any_cache/adapters/active_support_naive_store.rb
+- lib/any_cache/adapters/active_support_naive_store/decrement.rb
+- lib/any_cache/adapters/active_support_naive_store/expire.rb
+- lib/any_cache/adapters/active_support_naive_store/increment.rb
+- lib/any_cache/adapters/active_support_naive_store/operation.rb
+- lib/any_cache/adapters/active_support_naive_store/persist.rb
+- lib/any_cache/adapters/active_support_redis_cache_store.rb
+- lib/any_cache/adapters/basic.rb
+- lib/any_cache/adapters/dalli.rb
+- lib/any_cache/adapters/delegator.rb
+- lib/any_cache/adapters/redis.rb
+- lib/any_cache/adapters/redis_store.rb
+- lib/any_cache/error.rb
 - lib/any_cache/version.rb
 homepage: https://github.com/0exp/any_cache
 licenses:
@@ -84,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -95,5 +217,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Soon
+summary: AnyCache - a simplest cache wrapper
 test_files: []