any_cache 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90ca0569d3cc57ab74792f1ba11226b508a7d465c3c7f8a669e46d4a64501fbf
-  data.tar.gz: 877f5ec51869e4788a99e2d416a9d818cf53427710e3249b8619304a89e2515f
+  metadata.gz: b3bdf02896428164f98d1f75d08b0d2347e15987a7c98772bc7d81bae11eca49
+  data.tar.gz: a48891de0ae0ba1939a2fe6c806f419afbe504122274398032e0976517c927b4
 SHA512:
-  metadata.gz: 04a47243ee066a715bb1d6b5116d936168e84f35bf95cf38625a790d652c7a0f613e158d8134f261a1adcda4af765d072adac84ce08cf3a57f6b61b0efa60702
-  data.tar.gz: 7cff2361d74b63a00384a1d250d7ba60175c1cd3bc31fa7cf216eadf7d8e332b360bdc41ef5d6ab5af1a2d0c0d020a1b8410f0fdf48fbf729fe4ad8627130b9e
+  metadata.gz: 38f73611a43a1dd977a0b0b9056e15f58e7727f9b3b7d8607e6ac051b76ba97bbcc18d8d80085f933e56d4c843538d46d0d7d8beb0b60b39cadab3a04df262dc
+  data.tar.gz: 1e9474f4ce950aed89e7ef9bb84023bffd52318d0f706f22f92919c60ebd9141c2fe146e00e111c53f46f29a95973569d19c2b818b0c38b888f3480e65bcdfea

data/.rubocop.yml

@@ -5,7 +5,7 @@ inherit_gem:
 
 AllCops:
   UseCache: true
-  TargetRubyVersion: 2.5.3
+  TargetRubyVersion: 2.6.3
   Include:
     - bin/console
     - lib/**/*.rb

data/.travis.yml

@@ -13,10 +13,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_MEMORY_STORE_CACHE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_MEMORY_STORE_CACHE=true
-  - rvm: 2.5.3
+  - rvm: 2.5.5
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_MEMORY_STORE_CACHE=true
+  - rvm: 2.6.3
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_MEMORY_STORE_CACHE=true
   - rvm: ruby-head
@@ -25,10 +28,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_FILE_STORE_CACHE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_FILE_STORE_CACHE=true
+  - rvm: 2.5.5
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_FILE_STORE_CACHE=true
-  - rvm: 2.5.3
+  - rvm: 2.6.3
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_FILE_STORE_CACHE=true
   - rvm: ruby-head
@@ -37,10 +43,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/active_support_with_redis.gemfile
     env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
     gemfile: gemfiles/active_support_with_redis.gemfile
     env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
-  - rvm: 2.5.3
+  - rvm: 2.5.5
+    gemfile: gemfiles/active_support_with_redis.gemfile
+    env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
+  - rvm: 2.6.3
     gemfile: gemfiles/active_support_with_redis.gemfile
     env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
   - rvm: ruby-head
@@ -49,10 +58,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/dalli.gemfile
     env: TEST_DALLI_CACHE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
+    gemfile: gemfiles/dalli.gemfile
+    env: TEST_DALLI_CACHE=true
+  - rvm: 2.5.5
     gemfile: gemfiles/dalli.gemfile
     env: TEST_DALLI_CACHE=true
-  - rvm: 2.5.3
+  - rvm: 2.6.3
     gemfile: gemfiles/dalli.gemfile
     env: TEST_DALLI_CACHE=true
   - rvm: ruby-head
@@ -61,10 +73,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_STORE_CACHE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_STORE_CACHE=true
-  - rvm: 2.5.3
+  - rvm: 2.5.5
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_STORE_CACHE=true
+  - rvm: 2.6.3
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_STORE_CACHE=true
   - rvm: ruby-head
@@ -73,10 +88,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_DALLI_STORE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
+    gemfile: gemfiles/active_support_with_dalli.gemfile
+    env: TEST_AS_DALLI_STORE=true
+  - rvm: 2.5.5
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_DALLI_STORE=true
-  - rvm: 2.5.3
+  - rvm: 2.6.3
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_DALLI_STORE=true
   - rvm: ruby-head
@@ -85,10 +103,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_CACHE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_CACHE=true
-  - rvm: 2.5.3
+  - rvm: 2.5.5
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_CACHE=true
+  - rvm: 2.6.3
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_CACHE=true
   - rvm: ruby-head
@@ -97,10 +118,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_MEM_CACHE_STORE_CACHE=true
-  - rvm: 2.4.5
+  - rvm: 2.4.6
+    gemfile: gemfiles/active_support_with_dalli.gemfile
+    env: TEST_AS_MEM_CACHE_STORE_CACHE=true
+  - rvm: 2.5.5
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_MEM_CACHE_STORE_CACHE=true
-  - rvm: 2.5.3
+  - rvm: 2.6.3
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_MEM_CACHE_STORE_CACHE=true
   - rvm: ruby-head

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2019-05-12
+### Added
+- Introduce Plugin Ecosystem (`AnyCache::Plugins`):
+  - load plugin: `AnyCache.plugin('plugin_name')` or `AnyCache.plugin(:plugin_name)`;
+  - get registered plugins: `AnyCache.plugins #=> array of strings`
+- Support for last ruby versions (`ruby@2.6.3`, `ruby@2.4.6`, `ruby@2.5.5`)
+
+### Changed
+- Actualized dependencies (`qonfig` - `~> 0.10`);
+- Actualized development dependencies;
+
 ## [0.4.0] - 2018-12-04
 - `AnyCache#cleanup` - remove expired entries manually
   (make sence only for `:as_file_store` and `:as_memory_store` at this moment);

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Rustam Ibragimov
+Copyright (c) 2018-2019 Rustam Ibragimov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -14,6 +14,9 @@ Supported clients:
 - `ActiveSupport::Cache::FileStore` ([gem activesupport](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/cache/file_store.rb)) ([file storage](https://api.rubyonrails.org/classes/ActiveSupport/Cache/FileStore.html))
 - `ActiveSupport::Cache::MemoryStore` ([gem activesupport](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/cache/memory_store.rb)) ([in memory storage](https://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html))
 
+- [Coming Soon] Simple in-memory hash-based cache client
+- [Coming Soon] Simple key-value storage based on PostgreSQL
+
 ---
 
 ## Installation
@@ -61,6 +64,7 @@ require 'any_cache'
     - [Existence](#existence)
     - [Clear](#clear)
     - [Cleanup](#cleanup)
+- [Plugins](#plugins)
 - [Roadmap](#roadmap)
 
 ---
@@ -335,6 +339,11 @@ end
 AnyCache.configure do |conf|
   conf.logger = AnyCache::Logging::Logger.new(STDOUT)
 end
+
+# --- (your cache client inherited from AnyCache) ---
+YourCacheClient.configure do |conf|
+  # same configs as above
+end
 ```
 
 Log message format:
@@ -689,6 +698,20 @@ cache_store.cleanup # remove expired entries from database (release disk space f
 
 ---
 
+## Plugins
+
+`AnyCache` provides a set of plugins and an interface for controllable plugin registering and loading.
+
+```ruby
+# --- show names of registered plugins ---
+AnyCache.plugins # => array of strings
+
+# --- load specific plugin ---
+AnyCache.plugin(:plugin_name) # or AnyCache.plugin('plugin_name')
+```
+
+---
+
 ## Build
 
 - see [bin/rspec](bin/rspec)

data/any_cache.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_dependency 'qonfig',          '~> 0.8'
+  spec.add_dependency 'qonfig',          '~> 0.10'
 
   spec.add_development_dependency 'coveralls',        '~> 0.8'
   spec.add_development_dependency 'simplecov',        '~> 0.16'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.13'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.29'
   spec.add_development_dependency 'rspec',            '~> 3.8'
 
   spec.add_development_dependency 'bundler'

data/gemfiles/active_support_with_redis.gemfile

@@ -2,7 +2,7 @@
 
 source 'https://rubygems.org'
 
-gem 'redis',         '~> 4.0'
+gem 'redis',         '~> 4.1'
 gem 'activesupport', '~> 5.2'
 
 gemspec path: '..'

data/gemfiles/redis.gemfile

@@ -2,6 +2,6 @@
 
 source 'https://rubygems.org'
 
-gem 'redis', '~> 4.0'
+gem 'redis', '~> 4.1'
 
 gemspec path: '..'

data/gemfiles/redis_store.gemfile

@@ -2,6 +2,6 @@
 
 source 'https://rubygems.org'
 
-gem 'redis-store', '~> 1.5'
+gem 'redis-store', '~> 1.6'
 
 gemspec path: '..'

data/lib/any_cache.rb

@@ -16,6 +16,7 @@ class AnyCache
   require_relative 'any_cache/logging'
   require_relative 'any_cache/delegation'
   require_relative 'any_cache/patches'
+  require_relative 'any_cache/plugins'
 
   # @since 0.2.0
   include Qonfig::Configurable
@@ -23,6 +24,8 @@ class AnyCache
   include Delegation
   # @since 0.3.1
   extend Patches::InterfaceAccessMixin
+  # @since 0.5.0
+  extend Plugins::InterfaceAccessMixin
 
   # @since 0.2.0
   # rubocop:disable Metrics/BlockLength

data/lib/any_cache/error.rb

@@ -11,4 +11,10 @@ class AnyCache
 
   # @since 0.3.1
   NonexistentPatchError = Class.new(Error)
+
+  # @since 0.5.0
+  AlreadyRegisteredPluginError = Class.new(StandardError)
+
+  # @since 0.5.0
+  UnregisteredPluginError = Class.new(StandardError)
 end

data/lib/any_cache/plugins.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.5.0
+module AnyCache::Plugins
+  require_relative 'plugins/abstract'
+  require_relative 'plugins/registry'
+  require_relative 'plugins/interface_access_mixin'
+
+  # @since 0.5.0
+  @plugin_registry = Registry.new
+  # @since 0.5.0
+  @access_lock = Mutex.new
+
+  class << self
+    # @param plugin_name [Symbol, String]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.5.0
+    def load(plugin_name)
+      thread_safe { plugin_registry[plugin_name].load! }
+    end
+
+    # @return [Array<String>]
+    #
+    # @api public
+    # @since 0.5.0
+    def names
+      thread_safe { plugin_registry.names }
+    end
+
+    # @param plugin_name [Symbol, String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def register(plugin_name, plugin_module)
+      thread_safe { plugin_registry[plugin_name] = plugin_module }
+    end
+
+    private
+
+    # @return [AnyCache::Plugins::Registry]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :plugin_registry
+
+    # @return [Mutex]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :access_lock
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def thread_safe
+      access_lock.synchronize { yield if block_given? }
+    end
+  end
+end

data/lib/any_cache/plugins/abstract.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.5.0
+class AnyCache::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def load!; end
+  end
+end

data/lib/any_cache/plugins/interface_access_mixin.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+module AnyCache::Plugins::InterfaceAccessMixin
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @see AnyCache::Plugins
+  #
+  # @api public
+  # @since 0.5.0
+  def plugin(plugin_name)
+    AnyCache::Plugins.load(plugin_name)
+  end
+
+  # @return [Array<String>]
+  #
+  # @see AnyCache::Plugins
+  #
+  # @api public
+  # @since 0.5.0
+  def plugins
+    AnyCache::Plugins.names
+  end
+end

data/lib/any_cache/plugins/registry.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class AnyCache::Plugins::Registry
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def initialize
+    @plugin_set = {}
+    @access_lock = Mutex.new
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [AnyCache::Plugins::Abstract]
+  #
+  # @api private
+  # @since 0.5.0
+  def [](plugin_name)
+    thread_safe { fetch(plugin_name) }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [AnyCache::Plugins::Abstract]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def register(plugin_name, plugin_module)
+    thread_safe { apply(plugin_name, plugin_module) }
+  end
+  alias_method :[]=, :register
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.5.0
+  def names
+    thread_safe { plugin_names }
+  end
+
+  private
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :plugin_set
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :access_lock
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def thread_safe
+    access_lock.synchronize { yield if block_given? }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.5.0
+  def plugin_names
+    plugin_set.keys
+  end
+
+  # @param plugin_name [String]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.5.0
+  def registered?(plugin_name)
+    plugin_set.key?(plugin_name)
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [AnyCache::Plugins::Abstract]
+  # @return [void]
+  #
+  # @raise [AnyCache::AlreadyRegisteredPluginError]
+  #
+  # @api private
+  # @since 0.5.0
+  def apply(plugin_name, plugin_module)
+    plugin_name = indifferently_accessable_plugin_name(plugin_name)
+
+    if registered?(plugin_name)
+      raise AnyCache::AlreadyRegisteredPluginError, "#{plugin_name} plugin already exist"
+    end
+
+    plugin_set[plugin_name] = plugin_module
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [AnyCache::Plugins::Abstract]
+  #
+  # @raise [AnyCache::UnregisteredPluginError]
+  #
+  # @api private
+  # @since 0.5.0
+  def fetch(plugin_name)
+    plugin_name = indifferently_accessable_plugin_name(plugin_name)
+
+    unless registered?(plugin_name)
+      raise AnyCache::UnregisteredPluginError, "#{plugin_name} plugin is not registered"
+    end
+
+    plugin_set[plugin_name]
+  end
+
+  # @param key [Symbol, String]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.5.0
+  def indifferently_accessable_plugin_name(plugin_name)
+    plugin_name.to_s
+  end
+end

data/lib/any_cache/version.rb

@@ -5,5 +5,5 @@ class AnyCache
   #
   # @api public
   # @since 0.1.0
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: any_cache
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2019-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +213,10 @@ files:
 - lib/any_cache/logging/logger.rb
 - lib/any_cache/patches.rb
 - lib/any_cache/patches/dalli_store.rb
+- lib/any_cache/plugins.rb
+- lib/any_cache/plugins/abstract.rb
+- lib/any_cache/plugins/interface_access_mixin.rb
+- lib/any_cache/plugins/registry.rb
 - lib/any_cache/version.rb
 homepage: https://github.com/0exp/any_cache
 licenses:
@@ -233,8 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: AnyCache - a simplest cache wrapper