lock_and_cache 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbcf2cc4c2e6b8f6c7af7eb5226733eb5f9d2180
-  data.tar.gz: ff2b4cf01475da48793e76bf5dccc1b3d437218c
+  metadata.gz: 240e0a726e297cc0a7ceb14a90f64ded7a6a2717
+  data.tar.gz: 2ebadb4c71d8e9044ccceb7e5b9025d3d1c67631
 SHA512:
-  metadata.gz: dfa83fd496ab5fbd254cf2eab5c497990610af87ec7a013735acbc7c4281961526b592f4312e83251b550dacdccf80f6ea02e368af263fc7077641692e51f294
-  data.tar.gz: 16aaf6d638e1f5b6c1c65cfc4d792a21ce73e5a07c164be22a53194a2f6a955346b449a7e1f4c73fab8fc017e427e15d20d73ae24d7b9593fa0147dc9c33149e
+  metadata.gz: 440b0ab4a18aadec5170d99600467353fb25a3d6f448bbc5e8628845941fa366c810637f526e49e4918be0f58729a85f5094372aec63addfc5ae9162ab13a142
+  data.tar.gz: 5ee8fd515dcfde1ad4f20c2cc4c17526a548dda99c1fa8b6160b912a5a9486d6dfdafe0b1389777f8362a362e8397090e22611b9234aab65cae4f874e640e56a

data/CHANGELOG

@@ -1,3 +1,13 @@
+1.1.0 / 2015-08-07
+
+* Breaking changes
+
+  * Reduce default lock expiry to 1 day instead of weird 3 days
+
+* Enhancements
+
+  * Added :max_lock_wait option inspired by @leandromoreira
+
 1.0.3 / 2015-08-06
 
 * Enhancements

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/seamusabshere/lock_and_cache.svg?branch=master)](https://travis-ci.org/seamusabshere/lock_and_cache)
 [![Code Climate](https://codeclimate.com/github/seamusabshere/lock_and_cache/badges/gpa.svg)](https://codeclimate.com/github/seamusabshere/lock_and_cache)
 [![Dependency Status](https://gemnasium.com/seamusabshere/lock_and_cache.svg)](https://gemnasium.com/seamusabshere/lock_and_cache)
-[![Gem Version](https://badge.fury.io/rb/redlock.svg)](http://badge.fury.io/rb/redlock)
+[![Gem Version](https://badge.fury.io/rb/lock_and_cache.svg)](http://badge.fury.io/rb/lock_and_cache)
 [![security](https://hakiri.io/github/seamusabshere/lock_and_cache/master.svg)](https://hakiri.io/github/seamusabshere/lock_and_cache/master)
 [![Inline docs](http://inch-ci.org/github/seamusabshere/lock_and_cache.svg?branch=master)](http://inch-ci.org/github/seamusabshere/lock_and_cache)
 

data/lib/lock_and_cache.rb

@@ -1,4 +1,5 @@
 require 'lock_and_cache/version'
+require 'timeout'
 require 'redis'
 require 'redlock'
 require 'hash_digest'
@@ -6,8 +7,11 @@ require 'active_support'
 require 'active_support/core_ext'
 
 module LockAndCache
-  DEFAULT_LOCK_EXPIRES = 60 * 60 * 24 * 3 * 1000 # 3 days in milliseconds
+  DEFAULT_LOCK_EXPIRES = 60 * 60 * 24 * 1 * 1000 # 1 day in milliseconds
   DEFAULT_LOCK_SPIN = 0.1
+  DEFAULT_MAX_LOCK_WAIT = 60 * 60 * 24 # 1 day in seconds
+
+  class TimeoutWaitingForLock < StandardError; end
 
   # @param redis_connection [Redis] A redis connection to be used for lock and cached value storage
   def LockAndCache.storage=(redis_connection)
@@ -53,6 +57,18 @@ module LockAndCache
     @lock_spin || DEFAULT_LOCK_SPIN
   end
 
+  # @param seconds [Numeric] Maximum wait time to get a lock
+  #
+  # @note Can be overridden by putting `max_lock_wait:` in your call to `#lock_and_cache`
+  def LockAndCache.max_lock_wait=(seconds)
+    @max_lock_wait = seconds.to_f
+  end
+
+  # @private
+  def LockAndCache.max_lock_wait
+    @max_lock_wait || DEFAULT_MAX_LOCK_WAIT
+  end
+
   # @private
   def LockAndCache.lock_manager
     @lock_manager
@@ -119,6 +135,7 @@ module LockAndCache
     expires = options['expires']
     lock_expires = options.fetch 'lock_expires', LockAndCache.lock_expires
     lock_spin = options.fetch 'lock_spin', LockAndCache.lock_spin
+    max_lock_wait = options.fetch 'max_lock_wait', LockAndCache.max_lock_wait
     key = LockAndCache::Key.new self, method_id, key_parts
     digest = key.digest
     storage = LockAndCache.storage
@@ -132,9 +149,11 @@ module LockAndCache
     lock_digest = 'lock/' + digest
     lock_info = nil
     begin
-      until lock_info = lock_manager.lock(lock_digest, lock_expires)
-        Thread.exclusive { $stderr.puts "[lock_and_cache] C1 #{key.debug}" } if debug
-        sleep lock_spin
+      Timeout.timeout(max_lock_wait, TimeoutWaitingForLock) do
+        until lock_info = lock_manager.lock(lock_digest, lock_expires)
+          Thread.exclusive { $stderr.puts "[lock_and_cache] C1 #{key.debug}" } if debug
+          sleep lock_spin
+        end
       end
       Thread.exclusive { $stderr.puts "[lock_and_cache] D1 #{key.debug}" } if debug
       if storage.exists digest
@@ -150,7 +169,7 @@ module LockAndCache
         end
       end
     ensure
-      lock_manager.unlock lock_info
+      lock_manager.unlock lock_info if lock_info
     end
     retval
   end

data/lib/lock_and_cache/version.rb

@@ -1,3 +1,3 @@
 module LockAndCache
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

data/spec/lock_and_cache_spec.rb

@@ -54,6 +54,12 @@ class Bar
     end
   end
 
+  def slow_click
+    lock_and_cache do
+      sleep 1
+    end
+  end
+
   def lock_and_cache_key
     @id
   end
@@ -142,6 +148,26 @@ describe LockAndCache do
       pool.shutdown
     end
 
+    it "can set a wait time" do
+      pool = Thread.pool 2
+      Thread::Pool.abort_on_exception = true
+      begin
+        old_max = LockAndCache.max_lock_wait
+        LockAndCache.max_lock_wait = 0.5
+        expect do
+          pool.process do
+            bar.slow_click
+          end
+          pool.process do
+            bar.slow_click
+          end
+          pool.shutdown
+        end.to raise_error(LockAndCache::TimeoutWaitingForLock)
+      ensure
+        LockAndCache.max_lock_wait = old_max
+      end
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'lock_and_cache'
 
+require 'timeout'
+
 require 'redis'
 LockAndCache.storage = Redis.new
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lock_and_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport