redis-semaphore 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,89 @@
+redis-semaphore
+===============
+
+Implements a mutex and semaphore using Redis and the neat BLPOP command.
+
+The mutex and semaphore is blocking, not polling, and has a fair queue serving processes on a first-come, first-serve basis.
+
+For more info see [Wikipedia](http://en.wikipedia.org/wiki/Semaphore_(programming\)).
+
+Usage
+-----
+
+First let's see how to create a mutex:
+
+```ruby
+s = Redis::Semaphore.new(:semaphore_name, :connection => "localhost")
+s.lock do
+  # We're now in a mutex protected area
+  # No matter how many processes are running this program,
+  # there will be only one running this code block at a time.
+  do_something_speshiul()
+end
+```
+
+While our application is inside the code block given to ```s.lock```, other calls to use the mutex with the same name will block until our code block is finished. Once our mutex unlocks, the next process will unblock and be able to execute the code block. The blocking processes get unblocked in order of arrival, creating a fair queue.
+
+You can also allow a set number of processes inside the semaphore-protected block:
+
+```ruby
+s = Redis::Semaphore.new(:semaphore_name, 5, :connection => "localhost")
+s.lock do
+  # Up to five processes at a time will be able to get inside this code
+  # block simultaneously.
+  do_something_less_speshiul()
+end
+```
+
+You don't need to use code blocks, you can also use linear code:
+
+```ruby
+s = Redis::Semaphore.new(:semaphore_name, :connection => "localhost")
+s.lock
+do_something_speshiul()
+s.unlock  # Don't forget this, or the mutex will be locked forever!
+```
+
+If you don't want to wait forever until the mutex or semaphore release, you can use a timeout, in seconds:
+
+```ruby
+if s.lock(5) # This will only block for at most 5 seconds if the mutex stays locked.
+  do_something_speshiul()
+  s.unlock
+else
+  puts "Aborted."
+end
+```
+
+You can check if the mutex or semaphore already exists, or how many resources are left in the semaphore:
+
+```ruby
+puts "Someone already initialized this mutex or semaphore!" if s.exists?
+puts "There are #{s.available} resources available right now."
+```
+
+In the constructor you can pass in any arguments that you would pass to a regular Redis constructor. You can even pass in your custom Redis client:
+
+```ruby
+r = Redis.new(:connection => "localhost", :db => 222)
+s = Redis::Semaphore.new(:another_name, r)
+#...
+```
+
+
+
+Installation
+------------
+
+    $ gem install redis-semaphore
+
+Testing
+-------
+
+    $ bundle install
+    $ rake
+
+Author
+------
+
+[David Verhasselt](http://davidverhasselt.com) - david@crowdway.com

data/lib/redis/semaphore.rb

@@ -40,8 +40,11 @@ class Redis
       
       @locked = true
       if block_given?
-        yield
-        unlock
+        begin
+          yield
+        ensure
+          unlock
+        end
       end
       
       true

data/spec/redis_spec.rb

@@ -49,5 +49,22 @@ describe "redis" do
     end
     code_executed.should == true    
   end
-  
-end
+
+  it "should pass an exception right through" do
+    lambda do
+      @semaphore.lock do
+        raise Exception, "redis semaphore exception"
+      end
+    end.should raise_error(Exception, "redis semaphore exception")
+  end
+
+  it "should not leave the semaphore locked after raising an exception" do
+    lambda do 
+      @semaphore.lock do
+        raise Exception
+      end
+    end.should raise_error
+    
+    @semaphore.locked?.should == false
+  end
+end

data/spec/spec_helper.rb

@@ -10,9 +10,3 @@ require 'logger'
 $TESTING=true
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'redis/semaphore'
-
-RSpec::Matchers.define :have_key do |expected|
-  match do |redis|
-    redis.exists(expected)
-  end
-end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - David Verhasselt
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-05 00:00:00 +02:00
+date: 2011-09-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency