redis-semaphore 0.1.6 → 0.1.7

data/README.md

@@ -1,3 +1,5 @@
+[![Code Climate](https://codeclimate.com/github/dv/redis-semaphore.png)](https://codeclimate.com/github/dv/redis-semaphore)
+
 redis-semaphore
 ===============
 
@@ -99,16 +101,16 @@ To allow for clients to die, and the token returned to the list, a stale-check w
 There are two ways to take advantage of this. You can either define a :stale\_client\_timeout upon initialization. This will check for stale locks everytime your program wants to lock the semaphore:
 
 ```ruby
-s = Redis::Semaphore(:stale_semaphore, :redis = r, :stale_client_timeout => 1000) # in ms
+s = Redis::Semaphore.new(:stale_semaphore, :redis = r, :stale_client_timeout => 5) # in seconds
 ```
 
 Or you could start a different thread or program that frequently checks for stale locks. This has the advantage of unblocking blocking calls to Semaphore#lock as well:
 
 ```ruby
-normal_sem = Redis::Semaphore(:semaphore, :connection => "localhost")
+normal_sem = Redis::Semaphore.new(:semaphore, :connection => "localhost")
 
 Thread.new do
-  watchdog = Redis::Semaphore(:semaphore, :connection => "localhost", :stale_client_timeout => 1000)
+  watchdog = Redis::Semaphore.new(:semaphore, :connection => "localhost", :stale_client_timeout => 5)
   
   while(true) do
     watchdog.release_stale_locks!
@@ -172,9 +174,12 @@ Testing
 Changelog
 ---------
 
+###0.1.7 April 18, 2013
+- Fix bug where ```release\_stale\_locks!``` was not public (thanks scomma!).
+
 ###0.1.6 March 31, 2013
 - Add non-ownership of tokens
-- Add stale client timeout (thanks timgaleckas!)
+- Add stale client timeout (thanks timgaleckas!).
 
 ###0.1.5 October 1, 2012
 - Add detection of Redis::Namespace definition to avoid potential bug (thanks ruud!).
@@ -202,8 +207,9 @@ Author
 Contributors
 ------------
 
-Thanks to these awesome fellas for their contributions:
+Thanks to these awesome peeps for their contributions:
 
 - [Rimas Silkaitis](https://github.com/neovintage)
 - [Tim Galeckas](https://github.com/timgaleckas)
 - [Ruurd Pels](https://github.com/ruurd)
+- [Prathan Thananart](https://github.com/scomma)

data/lib/redis/semaphore.rb

@@ -112,6 +112,18 @@ class Redis
       end
     end
 
+    def release_stale_locks!
+      simple_mutex(:release_locks, 10) do
+        @redis.hgetall(grabbed_key).each do |token, locked_at|
+          timed_out_at = locked_at.to_f + @stale_client_timeout
+
+          if timed_out_at < Time.now.to_f
+            signal(token)
+          end
+        end
+      end
+    end
+
   private
     def simple_mutex(key_name, expires = nil)
       key_name = namespaced_key(key_name) if key_name.kind_of? Symbol
@@ -127,18 +139,6 @@ class Redis
       end
     end
 
-    def release_stale_locks!
-      simple_mutex(:release_locks, 10) do
-        @redis.hgetall(grabbed_key).each do |token, locked_at|
-          timed_out_at = locked_at.to_i + @stale_client_timeout
-
-          if timed_out_at < Time.now.to_i
-            signal(token)
-          end
-        end
-      end
-    end
-
     def create!
       @redis.expire(exists_key, 10)
 

data/spec/semaphore_spec.rb

@@ -118,6 +118,21 @@ describe "redis" do
 
       semaphore.available_count.should == 1
     end
+
+    it "can have stale locks released by a third process" do    
+      watchdog = Redis::Semaphore.new(:my_semaphore, :redis => @redis, :stale_client_timeout => 1)
+      semaphore.lock
+      
+      sleep 0.5
+
+      watchdog.release_stale_locks!
+      semaphore.locked?.should == true
+
+      sleep 0.6
+
+      watchdog.release_stale_locks!
+      semaphore.locked?.should == false
+    end
   end
 
   describe "semaphore with staleness checking" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-semaphore
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis