any_cache 0.0.0 → 0.1.0

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:rspec)
+
+task default: :rspec

data/any_cache.gemspec

@@ -1,18 +1,24 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "any_cache/version"
+require 'any_cache/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "any_cache"
-  spec.version       = AnyCache::VERSION
+  spec.required_ruby_version = '>= 2.3.7'
 
+  spec.name          = 'any_cache'
+  spec.version       = AnyCache::VERSION
   spec.authors       = ['Rustam Ibragimov']
   spec.email         = ['iamdaiver@icloud.com']
-  spec.summary       = 'Soon'
-  spec.description   = 'Soon'
+
+  spec.summary       = 'AnyCache - a simplest cache wrapper'
+  spec.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.'
+
   spec.homepage      = 'https://github.com/0exp/any_cache'
   spec.license       = 'MIT'
-
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -21,6 +27,14 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
   end
 
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+
+  spec.add_development_dependency 'coveralls',        '~> 0.8'
+  spec.add_development_dependency 'simplecov',        '~> 0.16'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.6'
+  spec.add_development_dependency 'rspec',            '~> 3.8'
+  spec.add_development_dependency 'qonfig',           '~> 0.6'
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry'

data/bin/console

@@ -1,14 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "any_cache"
+require 'bundler/setup'
+require 'any_cache'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require 'pry'
+Pry.start

data/bin/rspec

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+require 'optparse'
+
+module AnyCacheSpecRunner
+  extend self
+
+  def expand_gemfile_path(gemfile_name)
+    File.expand_path(
+      File.join('..', '..', 'gemfiles', gemfile_name),
+      Pathname.new(__FILE__).realpath
+    )
+  end
+
+  GEMFILES = {
+    redis:                     expand_gemfile_path('redis.gemfile'),
+    redis_store:               expand_gemfile_path('redis_store.gemfile'),
+    dalli:                     expand_gemfile_path('dalli.gemfile'),
+    active_support_with_redis: expand_gemfile_path('active_support_with_redis.gemfile'),
+    active_support:            expand_gemfile_path('active_support.gemfile')
+  }.freeze
+
+  # rubocop:disable Metrics/MethodLength, Metrics/BlockLength
+  def run!
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: bin/rspec [options]'
+
+      opts.on(
+        '--test-redis',
+        'Run specs with Redis cache storage'
+      ) { run_redis_cache_specs! }
+
+      opts.on(
+        '--test-redis-store',
+        'Run specs with Redis::Store cache storage'
+      ) { run_redis_store_cache_specs! }
+
+      opts.on(
+        '--test-dalli',
+        'Run specs with Dalli spec storage'
+      ) { run_dalli_cache_specs! }
+
+      opts.on(
+        '--test-as-redis-cache-store',
+        'Run specs with ActiveSupport::Cache::RedisCacheStore cache storage'
+      ) { run_as_redis_cache_store_cache_specs! }
+
+      opts.on(
+        '--test-as-file-store',
+        'Run specs with ActiveSupport::Cache::FileStore cache storage'
+      ) { run_as_file_store_cache_specs! }
+
+      opts.on(
+        '--test-as-memory-store',
+        'Run specs with ActiveSupport::Cache::MemoryStore cache storage'
+      ) { run_as_memory_store_cache_specs! }
+
+      opts.on(
+        '-h', '--help',
+        'Show this message'
+      ) { puts opts }
+    end.parse!
+  end
+  # rubocop:enable Metrics/MethodLength, Metrics/BlockLength
+
+  private
+
+  def run_redis_cache_specs!
+    ENV['TEST_REDIS_CACHE'] = 'true'
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:redis]
+
+    run_tests!
+  end
+
+  def run_redis_store_cache_specs!
+    ENV['TEST_REDIS_STORE_CACHE'] = 'true'
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:redis_store]
+
+    run_tests!
+  end
+
+  def run_dalli_cache_specs!
+    ENV['TEST_DALLI_CACHE'] = 'true'
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:dalli]
+
+    run_tests!
+  end
+
+  def run_as_redis_cache_store_cache_specs!
+    ENV['TEST_AS_REDIS_CACHE_STORE_CACHE'] = 'true'
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:active_support_with_redis]
+
+    run_tests!
+  end
+
+  def run_as_file_store_cache_specs!
+    ENV['TEST_AS_FILE_STORE_CACHE'] = 'true'
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:active_support]
+
+    run_tests!
+  end
+
+  def run_as_memory_store_cache_specs!
+    ENV['TEST_AS_MEMORY_STORE_CACHE'] = 'true'
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:active_support]
+
+    run_tests!
+  end
+
+  def run_tests!
+    require 'rubygems'
+    require 'bundler/setup'
+    load Gem.bin_path('rspec-core', 'rspec')
+  end
+end
+
+AnyCacheSpecRunner.run!

data/gemfiles/active_support.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 5.2'
+
+gemspec path: '..'

data/gemfiles/active_support_with_redis.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'redis',         '~> 4.0'
+gem 'activesupport', '~> 5.2'
+
+gemspec path: '..'

data/gemfiles/dalli.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'dalli', '~> 2.7'
+
+gemspec path: '..'

data/gemfiles/redis.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'redis', '~> 4.0'
+
+gemspec path: '..'

data/gemfiles/redis_store.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'redis-store', '~> 1.5'
+
+gemspec path: '..'

data/lib/any_cache.rb

@@ -1,5 +1,51 @@
-require "any_cache/version"
+# frozen_string_literal: true
 
-module AnyCache
-  # Your code goes here...
+require 'securerandom'
+require 'concurrent/atomic/reentrant_read_write_lock'
+
+# @api public
+# @since 0.1.0
+class AnyCache
+  require_relative 'any_cache/version'
+  require_relative 'any_cache/adapters'
+
+  # @since 0.1.0
+  extend Forwardable
+
+  class << self
+    # @param driver [Object]
+    # @return [AnyCache]
+    #
+    # @api private
+    # @since 0.1.0
+    def build(driver)
+      new(Adapters.build(driver))
+    end
+  end
+
+  # @since 0.1.0
+  def_delegators :adapter,
+                 :read,
+                 :write,
+                 :delete,
+                 :increment,
+                 :decrement,
+                 :expire,
+                 :persist,
+                 :clear
+
+  # @return [AnyCache::Adapters::Basic]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :adapter
+
+  # @param adapter [AnyCache::Adapters::Basic]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(adapter)
+    @adapter = adapter
+  end
 end

data/lib/any_cache/adapters.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module AnyCache::Adapters
+  require_relative 'adapters/basic'
+  require_relative 'adapters/delegator'
+  require_relative 'adapters/dalli'
+  require_relative 'adapters/redis'
+  require_relative 'adapters/redis_store'
+  require_relative 'adapters/active_support_naive_store'
+  require_relative 'adapters/active_support_file_store'
+  require_relative 'adapters/active_support_redis_cache_store'
+  require_relative 'adapters/active_support_memory_store'
+
+  class << self
+    # @param driver [Object]
+    # @return [AnyCache::Adapters::Basic]
+    #
+    # @raise [AnyCache::UnsupportedCacheDriverError]
+    #
+    # @api private
+    # @since 0.1.0
+    # rubocop:disable Metrics/LineLength
+    def build(driver)
+      case
+      when RedisStore.supported_driver?(driver)                   then RedisStore.new(driver)
+      when Redis.supported_driver?(driver)                        then Redis.new(driver)
+      when Dalli.supported_driver?(driver)                        then Dalli.new(driver)
+      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 Delegator.supported_driver?(driver)                    then Delegator.new(driver)
+      else
+        raise AnyCache::UnsupportedCacheDriverError
+      end
+    end
+    # rubocop:enable Metrics/LineLength
+  end
+end

data/lib/any_cache/adapters/active_support_file_store.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class ActiveSupportFileStore < ActiveSupportNaiveStore
+    require_relative 'active_support_file_store/fetching'
+    require_relative 'active_support_file_store/operation'
+    require_relative 'active_support_file_store/increment'
+    require_relative 'active_support_file_store/decrement'
+    require_relative 'active_support_file_store/expire'
+    require_relative 'active_support_file_store/persist'
+
+    class << self
+      # @param driver [Object]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.1.0
+      def supported_driver?(driver)
+        defined?(::ActiveSupport::Cache::FileStore) &&
+        driver.is_a?(::ActiveSupport::Cache::FileStore)
+      end
+    end
+  end
+end

data/lib/any_cache/adapters/active_support_file_store/decrement.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class ActiveSupportFileStore::Decrement < ActiveSupportNaiveStore::Decrement
+    # @since 0.1.0
+    include ActiveSupportFileStore::Fetching
+  end
+end

data/lib/any_cache/adapters/active_support_file_store/expire.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class ActiveSupportFileStore::Expire < ActiveSupportNaiveStore::Expire
+    # @since 0.1.0
+    include ActiveSupportFileStore::Fetching
+  end
+end

data/lib/any_cache/adapters/active_support_file_store/fetching.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class AnyCache::Adapters::ActiveSupportFileStore
+  # @api private
+  # @since 0.1.0
+  module Fetching
+    # @param key [String]
+    # @return [NilClass, ActiveSupport::Cache::Entry]
+    #
+    # @api private
+    # @since 0.1.0
+    def fetch_entry(key)
+      driver.instance_eval do
+        read_options   = merged_options(nil)
+        searched_entry = nil
+
+        search_dir(cache_path) do |fname|
+          entry_object = read_entry(fname, read_options)
+          entry_name   = file_path_key(fname)
+
+          searched_entry = entry_object if entry_name == key
+        end
+
+        searched_entry
+      end
+    end
+  end
+end

data/lib/any_cache/adapters/active_support_file_store/increment.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class ActiveSupportFileStore::Increment < ActiveSupportNaiveStore::Increment
+    # @since 0.1.0
+    include ActiveSupportFileStore::Fetching
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AnyCache::Adapters
+  # @api private
+  # @since 0.1.0
+  class ActiveSupportFileStore::Operation < ActiveSupportNaiveStore::Operation
+    # @since 0.1.0
+    include ActiveSupportFileStore::Fetching
+  end
+end