zache 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 257081764cc35a64985d251872770a52136ad5bdab0a11c6183e61af038e2eed
-  data.tar.gz: 8fcdeb45bdb0471b97b3706ad0c82b6779a11fc7d930b9e2d7706691f400acb1
+  metadata.gz: 60df3e71e2b231946894808553577fa3877e865f1556858d195e0d49957b75d0
+  data.tar.gz: 2d64c893d7bf7dd43d5788b9a3ad155df595dc8ad22b48f536ed4484b037dd4f
 SHA512:
-  metadata.gz: 0a232c9be3072ade8f8d83c647f67b85d7506cc34a2c17bd3ce6b85af5cf0cd8c5aed420d0019264ad62c73855ec28bbe7443b170f006dede7eec3d5dfb077f5
-  data.tar.gz: b0eb1264f9ad527ec8fa36f12b2911dfcdfb62c9add06c7de088401a546bb96836279692e7138a0e51e74c74b2f4e80b60a5e2d31007a1d9bf406463710abe91
+  metadata.gz: 27bb7605e2618a94c0bcc2d6978a19055bbced16b7f398a1ad232009d091259c7846efde96975bb0929940f9fc52a47345a62007b3b6fccaed7870eaf04cc267
+  data.tar.gz: 7101a0956069c62e85dfcc7796033e0133303a0f3b8ee87a46b90316991db1d2fd41ff1375c3b7fd1985412e7c301d9b876576d2f41b5876bc8550c3ad673441

data/README.md

@@ -25,13 +25,21 @@ zache = Zache.new
 v = zache.get(:count, lifetime: 5 * 60) { expensive() }
 ```
 
-By default `Zache` is thread-safe. You turn that off by using `sync` argument:
+By default `Zache` is thread-safe. It locks the entire cache on each
+`get` call. You turn that off by using `sync` argument:
 
 ```ruby
 zache = Zache.new(sync: false)
 v = zache.get(:count) { expensive() }
 ```
 
+You may use "dirty" mode, which will return you an expired value, while
+calculation is waiting. Say, you have something in the cache, but it's
+expired. Then, you call `get` with a long running block. The thread waits,
+while another one calls `get` again. That second thread won't wait, but will
+receive what's left in the cache. This is a very convenient mode for situations
+when you don't really care about data accuracy, but performance is an issue.
+
 That's it.
 
 # How to contribute

data/lib/zache.rb

@@ -22,8 +22,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'monitor'
-
 # 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:
 #
@@ -50,7 +48,7 @@ class Zache
     @hash = {}
     @sync = sync
     @dirty = dirty
-    @monitor = Monitor.new
+    @mutex = Mutex.new
   end
 
   # Gets the value from the cache by the provided key. If the value is not
@@ -92,7 +90,7 @@ class Zache
 
   # Is cache currently locked doing something?
   def locked?
-    !@monitor.mon_try_enter { true }
+    @mutex.locked?
   end
 
   # Put a value into the cache.
@@ -139,7 +137,7 @@ class Zache
 
   def synchronized
     if @sync
-      @monitor.synchronize do
+      @mutex.synchronize do
         # I don't know why, but if you remove this line, the tests will
         # break. It seems to me that there is a bug in Ruby. Let's try to
         # fix it or find a workaround and remove this line.

data/test/test_zache.rb

@@ -168,9 +168,11 @@ class ZacheTest < Minitest::Test
     assert_equal(123, cache.get(:hey))
   end
 
-  def test_sync_zache_is_reentrant
+  def test_sync_zache_is_not_reentrant
     cache = Zache.new
-    cache.get(:first) { cache.get(:second) { cache.get(:third) { 1 } } }
+    assert_raises ThreadError do
+      cache.get(:first) { cache.get(:second) { 1 } }
+    end
   end
 
   def test_calculates_only_once
@@ -188,6 +190,15 @@ class ZacheTest < Minitest::Test
     long.kill
   end
 
+  def test_checks_locked_status_from_inside
+    cache = Zache.new
+    cache.get(:x) do
+      assert(cache.locked?)
+      'done'
+    end
+    assert(!cache.locked?)
+  end
+
   def test_returns_dirty_result
     cache = Zache.new
     cache.get(:x, lifetime: 0) { 1 }
@@ -204,10 +215,20 @@ class ZacheTest < Minitest::Test
     long.kill
   end
 
-  def test_fetches_multiple_keys_in_many_threads
+  def test_fetches_multiple_keys_in_many_threads_in_dirty_mode
     cache = Zache.new(dirty: true)
     set = Concurrent::Set.new
     threads = 50
+    Threads.new(threads).assert(threads * 2) do |i|
+      set << cache.get(i, lifetime: 0.001) { i }
+    end
+    assert_equal(threads, set.size)
+  end
+
+  def test_fetches_multiple_keys_in_many_threads
+    cache = Zache.new
+    set = Concurrent::Set.new
+    threads = 50
     Threads.new(threads).assert(threads * 2) do |i|
       set << cache.get(i) { i }
     end

data/zache.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.5'
   s.required_ruby_version = '>=2.5'
   s.name = 'zache'
-  s.version = '0.5.2'
+  s.version = '0.5.3'
   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.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby