[cleanup] realization

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [Unreleased]
+- `AnyCache#cleanup` - remove expired entries manually
+  (make sence only for `:as_file_store` and `:as_memory_store` at this moment);
+
 ## [0.3.1] - 2018-10-08
 ### Added
 - patch interface `AnyCache.enable_patch!(:patch_series_name)`:

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)
 
 ---
@@ -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
@@ -640,6 +642,21 @@ cache_store.read("another_data") # => nil
 
 ---
 
+### Cleanup
+
+- `AnyCache#cleanup()` - remove expired entries from cache database (make sense only for `:as_file_store` && `as_memory_store`)
+
+```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)

lib/any_cache/adapters/active_support_mem_cache_store.rb

@@ -214,5 +214,14 @@ def persist(key, **options)
     def exist?(key, **options)
       driver.exist?(key)
     end
+
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      # NOTE: manual removing is not supported (memcached doing it by itself)
+    end
   end
 end

lib/any_cache/adapters/active_support_naive_store.rb

@@ -77,6 +77,15 @@ def clear(**options)
       lock.with_write_lock { super }
     end
 
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      lock.with_write_lock { super }
+    end
+
     # @param key [String]
     # @param value [Object]
     # @param options [Hash]

lib/any_cache/adapters/active_support_redis_cache_store.rb

@@ -24,7 +24,7 @@ def supported_driver?(driver)
     READ_MULTI_EMPTY_KEYS_SET = [].freeze
 
     # @since 0.1.0
-    def_delegators :driver, :delete, :delete_matched, :clear
+    def_delegators :driver, :delete, :delete_matched, :clear, :cleanup
 
     # @return [NilClass]
     #

lib/any_cache/adapters/dalli.rb

@@ -219,6 +219,15 @@ def clear(**options)
       flush(0) # NOTE: 0 is a flush delay
     end
 
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      # NOTE: manual removing is not suppored (memcached doing it by itself)
+    end
+
     # @param key [String]
     # @param options [Hash]
     # @return [Boolean]

lib/any_cache/adapters/redis.rb

@@ -238,6 +238,15 @@ def clear(**options)
       flushdb
     end
 
+    # @param options [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def cleanup(**options)
+      # NOTE: manual removing is not suppored (redis doing this by itself)
+    end
+
     # @param key [String]
     # @param options [Hash]
     # @return [Boolean]

spec/features/cleanup_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+describe 'Operation: #cleanup', :focus do
+  include_context 'cache store'
+
+  it 'removes expired entries' do
+    cache_store.write(:key_1, 'key_1_value', expires_in: 4) # 4 seconds lifetime
+    cache_store.write(:key_2, 'key_2_value', expires_in: 8) # 8 seconds lifetime
+    cache_store.write(:key_3, 'key_3_value', expires_in: 12) # 12 seconds lifetime
+    cache_store.write(:key_4, 'key_4_value', expires_in: 16) # 16 seconds lifetime
+
+    sleep(1) # 1 second left
+    cache_store.cleanup
+    expect(cache_store.fetch_multi(:key_1, :key_2, :key_3, :key_4)).to match(
+      key_1: 'key_1_value',
+      key_2: 'key_2_value',
+      key_3: 'key_3_value',
+      key_4: 'key_4_value',
+    )
+
+    sleep(3) # 4 seconds left
+    cache_store.cleanup
+    expect(cache_store.fetch_multi(:key_1, :key_2, :key_3, :key_4)).to match(
+      key_1: nil, # expired
+      key_2: 'key_2_value',
+      key_3: 'key_3_value',
+      key_4: 'key_4_value',
+    )
+
+    sleep(4) # 8 seconds left
+    cache_store.cleanup
+    expect(cache_store.fetch_multi(:key_1, :key_2, :key_3, :key_4)).to match(
+      key_1: nil, # expired
+      key_2: nil, # expired
+      key_3: 'key_3_value',
+      key_4: 'key_4_value',
+    )
+
+    sleep(4) # 12 seconds left
+    cache_store.cleanup
+    expect(cache_store.fetch_multi(:key_1, :key_2, :key_3, :key_4)).to match(
+      key_1: nil, # expired
+      key_2: nil, # expired
+      key_3: nil, # expired
+      key_4: 'key_4_value',
+    )
+
+    sleep(4) # 16 seconds left
+    cache_store.cleanup
+    expect(cache_store.fetch_multi(:key_1, :key_2, :key_3, :key_4)).to match(
+      key_1: nil, # expired
+      key_2: nil, # expired
+      key_3: nil, # expired
+      key_4: nil, # expired
+    )
+  end
+end