any_cache 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffa4d18aa6e7fdabf6cbb94da73a58c5daf2ced4aa74b28a7f16a73ed24cfc3e
-  data.tar.gz: 3a275c65d65426dfa41ba0fc00ac9b9de2da3684427e6ead5de9586021bcd574
+  metadata.gz: 90ca0569d3cc57ab74792f1ba11226b508a7d465c3c7f8a669e46d4a64501fbf
+  data.tar.gz: 877f5ec51869e4788a99e2d416a9d818cf53427710e3249b8619304a89e2515f
 SHA512:
-  metadata.gz: 01e02bdaa716816ff2be016843337c1968a865b99ac98418ae2b7fa6bc5d7e32b9be986e48ffcd417b65fd6e88dc635b2087d14ee12b057c7e7b1cddf8e7706f
-  data.tar.gz: cf62adafcbf850fd47147e6b35f2dd9fc8adaf34735bebed6a66b86bb89bbc0d76d035774dfae885a708c5ef542684fea13891d06d7e93d2fb8e50d002d9c488
+  metadata.gz: 04a47243ee066a715bb1d6b5116d936168e84f35bf95cf38625a790d652c7a0f613e158d8134f261a1adcda4af765d072adac84ce08cf3a57f6b61b0efa60702
+  data.tar.gz: 7cff2361d74b63a00384a1d250d7ba60175c1cd3bc31fa7cf216eadf7d8e332b360bdc41ef5d6ab5af1a2d0c0d020a1b8410f0fdf48fbf729fe4ad8627130b9e

data/.rubocop.yml

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

data/.travis.yml

@@ -10,97 +10,97 @@ services:
 matrix:
   fast_finish: true
   include:
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_MEMORY_STORE_CACHE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_MEMORY_STORE_CACHE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.3
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_MEMORY_STORE_CACHE=true
   - rvm: ruby-head
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_MEMORY_STORE_CACHE=true
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_FILE_STORE_CACHE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_FILE_STORE_CACHE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.3
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_FILE_STORE_CACHE=true
   - rvm: ruby-head
     gemfile: gemfiles/active_support.gemfile
     env: TEST_AS_FILE_STORE_CACHE=true
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/active_support_with_redis.gemfile
     env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/active_support_with_redis.gemfile
     env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.3
     gemfile: gemfiles/active_support_with_redis.gemfile
     env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
   - rvm: ruby-head
     gemfile: gemfiles/active_support_with_redis.gemfile
     env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/dalli.gemfile
     env: TEST_DALLI_CACHE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/dalli.gemfile
     env: TEST_DALLI_CACHE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.3
     gemfile: gemfiles/dalli.gemfile
     env: TEST_DALLI_CACHE=true
   - rvm: ruby-head
     gemfile: gemfiles/dalli.gemfile
     env: TEST_DALLI_CACHE=true
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_STORE_CACHE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_STORE_CACHE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.3
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_STORE_CACHE=true
   - rvm: ruby-head
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_STORE_CACHE=true
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_DALLI_STORE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_DALLI_STORE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.3
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_DALLI_STORE=true
   - rvm: ruby-head
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_DALLI_STORE=true
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_CACHE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_CACHE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.3
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_CACHE=true
   - rvm: ruby-head
     gemfile: gemfiles/redis_store.gemfile
     env: TEST_REDIS_CACHE=true
-  - rvm: 2.3.7
+  - rvm: 2.3.8
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_MEM_CACHE_STORE_CACHE=true
-  - rvm: 2.4.4
+  - rvm: 2.4.5
     gemfile: gemfiles/active_support_with_dalli.gemfile
     env: TEST_AS_MEM_CACHE_STORE_CACHE=true
-  - rvm: 2.5.1
+  - rvm: 2.5.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,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [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);
+- automatic object marshaling (used in `fetch`, `fetch_multi`, `write`, `write_multi`, `read`, `read_multi`):
+  - used by default (`raw: false`);
+  - can be disabled via `raw: true` option;
+  - `raw: true` is required for incrementable/decrementable entries;
+
 ## [0.3.1] - 2018-10-08
 ### Added
 - patch interface `AnyCache.enable_patch!(:patch_series_name)`:

data/README.md

@@ -1,7 +1,7 @@
 # AnyCache · [![Gem Version](https://badge.fury.io/rb/any_cache.svg)](https://badge.fury.io/rb/any_cache) [![Build Status](https://travis-ci.org/0exp/any_cache.svg?branch=master)](https://travis-ci.org/0exp/any_cache) [![Coverage Status](https://coveralls.io/repos/github/0exp/any_cache/badge.svg?branch=master)](https://coveralls.io/github/0exp/any_cache?branch=master)
 
 AnyCache - a simplest cache wrapper that provides a minimalistic generic interface for all well-known cache storages and includes a minimal set of necessary operations:
-`fetch`, `read`, `write`, `delete`, `fetch_multi`, `read_multi`, `write_multi`, `delete_matched`, `expire`, `persist`, `exist?`, `clear`, `increment`, `decrement`.
+`fetch`, `read`, `write`, `delete`, `fetch_multi`, `read_multi`, `write_multi`, `delete_matched`, `expire`, `persist`, `exist?`, `clear`, `cleanup`, `increment`, `decrement`.
 
 Supported clients:
 
@@ -60,6 +60,7 @@ require 'any_cache'
     - [Persist](#persist)
     - [Existence](#existence)
     - [Clear](#clear)
+    - [Cleanup](#cleanup)
 - [Roadmap](#roadmap)
 
 ---
@@ -196,7 +197,7 @@ require 'dalli'
 require 'active_support'
 require 'any_cache'
 
-AnyCache.enable_patch!(:dalli_store)
+AnyCache.enable_patch!(:dalli_store) # NOTE: actual for Dalli <= 2.7.8
 
 AnyCache.configure do |conf|
   conf.driver = :as_dalli_store
@@ -290,6 +291,7 @@ If you want to use your own cache client implementation, you should provide an o
 - `#persist(key, [**options])` ([doc](#persist))
 - `#exist?(key, [**options])` ([doc](#existence))
 - `#clear([**options])` ([doc](#clear))
+- `#cleanup([**options])` ([doc](#cleanup))
 
 ```ruby
 class MyCacheClient
@@ -351,10 +353,10 @@ params: INSPECTED_ARGUMENTS and options: INSPECTED_OPTIONS
 
 ```ruby
 any_cache.write("data", 123, expires_in: 60)
-# I, [2018-09-07T10:04:56.649960 #15761]  INFO -- [AnyCache<AnyCache>/Activity<write>]: performed <write> operation with params: ["data", 123] and options: {:expires_in=>60}.
+# I, [2018-09-07T10:04:56.649960 #15761]  INFO -- [AnyCache<AnyCache>/Activity<write>]: performed <write> operation with attributes: ["data", 123] and options: {:expires_in=>60}.
 
 any_cache.clear
-# I, [2018-09-07T10:05:26.999847 #15761]  INFO -- [AnyCache<AnyCache>/Activity<clear>]: performed <clear> operation with params: [] and options: {}.
+# I, [2018-09-07T10:05:26.999847 #15761]  INFO -- [AnyCache<AnyCache>/Activity<clear>]: performed <clear> operation with attributes: [] and options: {}.
 ```
 
 ## Operations
@@ -380,6 +382,7 @@ any_cache.clear
     - fetches data from the cache using the given key;
     - if a `fallback` block has been passed and data with the given key does not exist - that block
       will be called with the given key and the return value will be written to the cache;
+    - use `raw: true` if you want to fetch incrementable/decrementable entry;
 
 ```ruby
 # --- entry exists ---
@@ -414,6 +417,7 @@ cache_store.fetch("data") # => nil
     - get a set of entries in hash form from the cache storage using given keys;
     - works in `#fetch` manner but with a series of entries;
     - nonexistent entries will be fetched with `nil` values;
+    - use `raw: true` if you want to fetch incrementable/decrementable entries;
 
 ```ruby
 # --- fetch entries ---
@@ -449,6 +453,7 @@ cache_store.fetch_multi("data", "second_data", "last_data", force: true) { |key|
 ### Read
 
 - `AnyCache#read(key)` - get an entry value from the cache storage
+  - pass `raw: true` if you want to read incrementable/decrementable entries;
 
 ```ruby
 # --- entry exists ---
@@ -456,6 +461,9 @@ cache_store.read("data") # => "some_data"
 
 # --- entry doesnt exist ---
 cache_store.read("data") # => nil
+
+# --- read incrementable/decrementable entry ---
+cache_store.read("data", raw: true) # => "2" (for example)
 ```
 
 ---
@@ -465,6 +473,7 @@ cache_store.read("data") # => nil
 - `AnyCache#read_multi(*keys)`
     - get entries from the cache storage in hash form;
     - nonexistent entries will be fetched with `nil` values;
+    - pass `raw: true` if you want to read incrementable/decrementable entries;
 
 ```ruby
 cache_store.read_multi("data", "another_data", "last_data", "super_data")
@@ -475,13 +484,22 @@ cache_store.read_multi("data", "another_data", "last_data", "super_data")
   "last_data" => "some_data", # exisitng enry
   "super_data" => nil # existing entry
 }
+
+# --- read incrementable/decrementable entries ---
+cache_store.read_multi("data", "another_data", raw: true)
+# => returns
+{
+  "data" => "1",
+  "another_data" => "2",
+}
 ```
 
 ---
 
 ### Write
 
-- `AnyCache#write(key, value, [expires_in:])` - write a new entry to the cache storage
+- `AnyCache#write(key, value, [expires_in:])` - write a new entry to the cache storage;
+  - pass `raw: true` if you want to store incrementable/decrementable entries;
 
 ```ruby
 # --- permanent entry ---
@@ -489,23 +507,30 @@ cache_store.write("data", 123)
 
 # --- temporal entry (expires in 60 seconds) ---
 cache_store.write("data", 123, expires_in: 60)
+
+# --- incrementable/decrementable entry ---
+cache_store.write("data", 123, raw: true)
 ```
 
 ---
 
 ### Write Multi
 
-- `AnyCache#write_multi(**entries)` - write a set of permanent entries to the cache storage
+- `AnyCache#write_multi(**entries)` - write a set of permanent entries to the cache storage;
+  - pass `raw: true` if you want to store incrementable/decrementable entries;
 
 ```ruby
 cache_store.write_multi("data" => "test", "another_data" => 123)
+
+# --- incrementable/decrementable entries ---
+cache_store.write_multi("data" => 1, "another_data" => 2, raw: true)
 ```
 
 ---
 
 ### Delete
 
-- `AnyCache#delete(key)` - remove entry from the cache storage
+- `AnyCache#delete(key)` - remove entry from the cache storage;
 
 ```ruby
 cache_store.delete("data")
@@ -517,7 +542,7 @@ cache_store.delete("data")
 
 - `AnyCache#delete_matched(pattern)`
     - removes all entries with keys matching the pattern;
-    - currently unsupported: `:dalli`, `:as_mem_cache_store`, `:as_dalli_Store`;
+    - currently unsupported: `:dalli`, `:as_mem_cache_store`, `:as_dalli_store`;
 
 ```ruby
 # --- using a regepx ---
@@ -532,11 +557,12 @@ cache_store.delete_matched("data")
 ### Increment
 
 - `AnyCache#increment(key, amount = 1, [expires_in:])` - increment entry's value by the given amount
-  and set the new expiration time if needed
+  and set the new expiration time if needed;
+  - can increment only nonexistent entries OR entries that were written with `raw: true` option;
 
 ```ruby
 # --- increment existing entry ---
-cache_store.write("data", 1)
+cache_store.write("data", 1, raw: true) # you must provide :raw => true for incrementable entries
 
 # --- increment by default value (1) ---
 cache_store.increment("data") # => 2
@@ -549,6 +575,9 @@ cache_store.incrmeent("data", expires_in: 31) # => 15
 
 # --- increment nonexistent entry (create new entry) ---
 cache_store.increment("another_data", 5, expires_in: 5) # => 5
+
+# --- read incrementable entry ---
+cache_store.read("data", raw: true) # you must provide :raw => true for incrementable entries
 ```
 
 ---
@@ -556,11 +585,12 @@ cache_store.increment("another_data", 5, expires_in: 5) # => 5
 ### Decrement
 
 - `AnyCache#decrement(key, amount = 1, [expires_in:])` - decrement entry's value by the given amount
-  and set the new expiration time if needed
+  and set the new expiration time if needed;
+  - can decrement only nonexistent entries OR entries that were written with `raw: true` option;
 
 ```ruby
 # --- decrement existing entry ---
-cache_store.write("data", 15)
+cache_store.write("data", 15, raw: true) # you must provide :raw => true for decrementable entries
 
 # --- decrement by default value (1) ---
 cache_store.decrement("data") # => 14
@@ -573,13 +603,16 @@ cache_store.decrememnt("data", expirs_in: 5) # => 3
 
 # --- decrement nonexistent entry (create new entry) ---
 cache_store.decrememnt("another_data", 2, expires_in: 10) # => -2 (or 0 for Dalli::Client)
+
+# --- read decrementable entry ---
+cache_store.read("data", raw: true) # you must provide :raw => true for decrementable entries
 ```
 
 ---
 
 ### Expire
 
-- `AnyCache#expire(key, [expires_in:])` - expire entry immediately or set the new expiration time
+- `AnyCache#expire(key, [expires_in:])` - expire entry immediately or set the new expiration time;
 
 ```ruby
 # --- expire immediately ---
@@ -593,7 +626,7 @@ cache_store.expire("data", expires_in: 36)
 
 ### Persist
 
-- `AnyCache#persist(key)` - change entry's expiration time to permanent
+- `AnyCache#persist(key)` - change entry's expiration time to permanent;
 
 ```ruby
 # --- create temporal entry (30 seconds) ---
@@ -607,7 +640,7 @@ cache_store.persist("data")
 
 ### Existence
 
-- `AnyCache#exist?(key)` - determine if an entry exists
+- `AnyCache#exist?(key)` - determine if an entry exists;
 
 ```ruby
 # --- entry exists ---
@@ -621,7 +654,7 @@ cache_store.exist?("another-data") # => false
 
 ### Clear
 
-- `AnyCache#clear()` - clear cache database
+- `AnyCache#clear()` - clear cache database;
 
 ```ruby
 # --- prepare cache data ---
@@ -640,6 +673,22 @@ cache_store.read("another_data") # => nil
 
 ---
 
+### Cleanup
+
+- `AnyCache#cleanup()` - remove expired entries from cache database
+  (make sense only for `:as_file_store` and `:as_memory_store` cache clients);
+
+```ruby
+# --- prepare cache data ---
+cache_store.write("data", "123", expires_in: 5)
+cache_store.write("another_data", "456", expires_in: 10)
+
+# --- waiting for cache exiration (10 seconds) ---
+cache_store.cleanup # remove expired entries from database (release disk space for example)
+```
+
+---
+
 ## Build
 
 - see [bin/rspec](bin/rspec)
@@ -662,6 +711,7 @@ bin/rspec --test-as-memory-store # run specs with ActiveSupport::Cache::MemorySt
 - instrumentation layer;
 - global and configurable default expiration time;
 - `#delete_matched` for memcached-based cache storages;
+- rails integration;
 
 ---
 

data/any_cache.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'any_cache/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.3.7'
+  spec.required_ruby_version = '>= 2.3.8'
 
   spec.name          = 'any_cache'
   spec.version       = AnyCache::VERSION
@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_dependency 'qonfig',          '~> 0.6'
+  spec.add_dependency 'qonfig',          '~> 0.8'
 
   spec.add_development_dependency 'coveralls',        '~> 0.8'
   spec.add_development_dependency 'simplecov',        '~> 0.16'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.9'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.13'
   spec.add_development_dependency 'rspec',            '~> 3.8'
 
   spec.add_development_dependency 'bundler'

data/bin/rspec

@@ -56,7 +56,7 @@ module AnyCacheSpecRunner
       ) { run_as_memory_store_cache_specs! }
 
       opts.on(
-        '--test-as-mem-cache-store',
+        '--test-as-memcache-store',
         'Run specs with ActiveSupport::Cache::MemCacheStore cache storage'
       ) { run_as_mem_cache_store_cache_specs! }