zache 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 186b5dcd33ca13d027053e477dc378e8cd203d96e43257f591d8537d8b665c17
-  data.tar.gz: c39d96fefe90f9b481bbd6acd49ac4d2cd7cd675d83462b53895a8fc2ef1f49a
+  metadata.gz: 8ad9aee02e0592400be73acb02cdf8878c314950df90fce1632ea00e7d07d396
+  data.tar.gz: 802eba8bf8ad6e027b17d85eb296957b0255fde72e9340713bad5b0b96e4dd67
 SHA512:
-  metadata.gz: fd75a39fa850377dc87c9f6658e6bd03f49304a7b167ff6b6e59ba676ca6a6b727333a1cc83248fcd9b45dd3ad118911e092de60991d4fd4ed8c35a700a80dcc
-  data.tar.gz: 110ad00c04c2d65c65bf9c875dd21c9b9e3254412eae28766cf53be3cad07ebe9e81a09de881f0aec1d2747fcf35ca0f461503bcc2a5c47dacd1f35dc29c47f3
+  metadata.gz: c756d6ba076c41371f3c47d1d2f825f06876ea9dea1d39a86f1d7f5f6b93a87d077427af2726e4dc211248e416b02dba26a130a54b1a40e74eeb8f3e64b982bc
+  data.tar.gz: af8e41d5048f8afa5275362d3e23da9b9276c6277f7f0db33d0353e40bac2e4223806da97f612621b5b587e9f8c964aa737310696a76b9829f242ec543b6fae1

data/.rultor.yml

@@ -20,4 +20,7 @@ architect:
 - yegor256
 merge:
   commanders: []
+  script: |-
+    bundle install
+    rake
 deploy: {}

data/README.md

@@ -1,3 +1,4 @@
+[![EO principles respected here](http://www.elegantobjects.org/badge.svg)](http://www.elegantobjects.org)
 [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/zache)](http://www.rultor.com/p/yegor256/zache)
 [![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 

data/Rakefile

@@ -44,6 +44,13 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = false
 end
 
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
 require 'rubocop/rake_task'
 desc 'Run RuboCop on all directories'
 RuboCop::RakeTask.new(:rubocop) do |task|

data/lib/zache.rb

@@ -22,18 +22,36 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# Cache.
+# It is a very simple thread-safe in-memory cache with an ability to expire
+# keys automatically, when their lifetime is over. Use it like this:
+#
+#  require 'zache'
+#  zache = Zache.new
+#  # Expires in 5 minutes
+#  v = zache.get(:count, lifetime: 5 * 60) { expensive() }
+#
+# For more information read
+# {README}[https://github.com/yegor256/zache/blob/master/README.md] file.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2018 Yegor Bugayenko
 # License:: MIT
 class Zache
+  # Makes a new object of the cache.
+  # "sync" is whether the hash is thread-safe (`true`)
+  # or not (`false`); it is recommended to leave this parameter untouched,
+  # unless you really know what you are doing.
   def initialize(sync: true)
     @hash = {}
     @sync = sync
     @mutex = Mutex.new
   end
 
+  # Gets the value from the cache by the provided key. If the value is not
+  # found in the cache, it will be calculated via the provided block. If
+  # the block is not given, an exception will be raised.
   def get(key, lifetime: 60 * 60)
+    raise 'A block is required' unless block_given?
     if @sync
       @mutex.synchronize do
         calc(key, lifetime) { yield }
@@ -43,11 +61,49 @@ class Zache
     end
   end
 
+  # Checks whether the value exists in the cache by the provided key. Returns
+  # TRUE if the value is here. If the key is already expired in the hash,
+  # it will be removed by this method and the result will be FALSE.
+  def exists?(key)
+    rec = @hash[key]
+    if key_expired?(key)
+      @hash.delete(key)
+      rec = nil
+    end
+    !rec.nil?
+  end
+
+  # Removes the value from the hash, by the provied key. If the key is absent
+  # and the block is provide, the block will be called.
+  def remove(key)
+    if @sync
+      @mutex.synchronize do
+        @hash.delete(key) { yield if block_given? }
+      end
+    else
+      @hash.delete(key) { yield if block_given? }
+    end
+  end
+
+  def clean
+    if @sync
+      @mutex.synchronize do
+        @hash.delete_if do |_key, value|
+          value[:start] < Time.now - value[:lifetime]
+        end
+      end
+    else
+      @hash.delete_if do |_key, value|
+        value[:start] < Time.now - value[:lifetime]
+      end
+    end
+  end
+
   private
 
   def calc(key, lifetime)
     rec = @hash[key]
-    rec = nil if !rec.nil? && rec[:start] < Time.now - rec[:lifetime]
+    rec = nil if key_expired?(key)
     if rec.nil?
       @hash[key] = {
         value: yield,
@@ -57,4 +113,9 @@ class Zache
     end
     @hash[key][:value]
   end
+
+  def key_expired?(key)
+    rec = @hash[key]
+    !rec.nil? && rec[:start] < Time.now - rec[:lifetime]
+  end
 end

data/test/test_zache.rb

@@ -52,4 +52,78 @@ class ZacheTest < Minitest::Test
       cache.get(:hey, lifetime: 0.0001) { Random.rand }
     end
   end
+
+  def test_key_exists
+    cache = Zache.new
+    cache.get(:hey) { Random.rand }
+    exists_result = cache.exists?(:hey)
+    not_exists_result = cache.exists?(:bye)
+    assert(exists_result == true)
+    assert(not_exists_result == false)
+  end
+
+  def test_remove_key
+    cache = Zache.new
+    cache.get(:hey) { Random.rand }
+    cache.get(:wey) { Random.rand }
+    assert(cache.exists?(:hey) == true)
+    assert(cache.exists?(:wey) == true)
+    cache.remove(:hey)
+    assert(cache.exists?(:hey) == false)
+    assert(cache.exists?(:wey) == true)
+  end
+
+  def test_remove_key_with_sync_false
+    cache = Zache.new(sync: false)
+    cache.get(:hey) { Random.rand }
+    cache.get(:wey) { Random.rand }
+    assert(cache.exists?(:hey) == true)
+    assert(cache.exists?(:wey) == true)
+    cache.remove(:hey)
+    assert(cache.exists?(:hey) == false)
+    assert(cache.exists?(:wey) == true)
+  end
+
+  def test_clean_with_threads
+    cache = Zache.new
+    Threads.new(300).assert(3000) do
+      cache.get(:hey) { Random.rand }
+      cache.get(:bye, lifetime: 0.01) { Random.rand }
+      sleep 0.1
+      cache.clean
+    end
+    assert(cache.exists?(:hey) == true)
+    assert(cache.exists?(:bye) == false)
+  end
+
+  def test_clean
+    cache = Zache.new
+    cache.get(:hey) { Random.rand }
+    cache.get(:bye, lifetime: 0.01) { Random.rand }
+    sleep 0.1
+    cache.clean
+    assert(cache.exists?(:hey) == true)
+    assert(cache.exists?(:bye) == false)
+  end
+
+  def test_clean_with_sync_false
+    cache = Zache.new(sync: false)
+    cache.get(:hey) { Random.rand }
+    cache.get(:bye, lifetime: 0.01) { Random.rand }
+    sleep 0.1
+    cache.clean
+    assert(cache.exists?(:hey) == true)
+    assert(cache.exists?(:bye) == false)
+  end
+
+  def test_remove_absent_key
+    cache = Zache.new
+    cache.remove(:hey)
+  end
+
+  def test_check_and_remove
+    cache = Zache.new
+    cache.get(:hey, lifetime: 0) { Random.rand }
+    assert(!cache.exists?(:hey))
+  end
 end

data/zache.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.3.3'
   s.required_ruby_version = '>=2.3'
   s.name = 'zache'
-  s.version = '0.2.0'
+  s.version = '0.3.0'
   s.license = 'MIT'
   s.summary = 'In-memory Cache'
   s.description = 'Zero-footprint in-memory thread-safe cache'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zache
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest