redis-semaphore 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by David Verhasselt (david@crowdway.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,7 @@
+task :default => :spec
+task :test    => :spec
+
+desc "Run specs"
+task :spec do
+  exec "rspec spec/redis_spec.rb"
+end

data/lib/redis-semaphore.rb

@@ -0,0 +1 @@
+require 'redis/semaphore'

data/lib/redis/semaphore.rb

@@ -0,0 +1,82 @@
+require 'redis'
+
+class Redis
+  class Semaphore
+    
+    attr_reader :resources
+    
+    # RedisSempahore.new(:my_semaphore, 5, myRedis)
+    # RedisSemaphore.new(:my_semaphore, myRedis)
+    # RedisSemaphore.new(:my_semaphore, :connection => "", :port => "")
+    # RedisSemaphore.new(:my_semaphore, :path => "bla")
+    def initialize(*args)
+      raise "Need at least two arguments" if args.size < 2
+      
+      @locked = false
+      @name = args.shift.to_s
+      @redis = args.pop
+      @redis = Redis.new(@redis) unless @redis.kind_of? Redis
+      @resources = args.pop || 1
+      
+    end
+    
+    def available
+      @redis.llen(list_name)
+    end
+    
+    def exists?
+      @redis.exists(exists_name)
+    end
+    
+    def delete!
+      @redis.del(list_name)
+      @redis.del(exists_name)
+    end
+    
+    def lock(timeout = 0)
+      exists_or_create!
+      
+      return false if @redis.blpop(list_name, timeout).nil?
+      
+      @locked = true
+      if block_given?
+        yield
+        unlock
+      end
+      
+      true
+    end
+    
+    def unlock
+      return false unless locked?
+      
+      @redis.rpush(list_name, 1)
+      @locked = false
+    end
+    
+    def locked?
+      @locked
+    end
+    
+    
+  private  
+    def list_name
+      "SEMAPHORE::#{@name}::LIST"
+    end
+    
+    def exists_name
+      "SEMAPHORE::#{@name}::EXISTS"
+    end
+    
+    def exists_or_create!
+      exists = @redis.getset(exists_name, 1)
+      
+      if "1" != exists
+        @resources.times do
+          @redis.lpush(list_name, 1)
+        end
+      end
+    end
+    
+  end
+end

data/spec/redis_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "redis" do
+  before(:all) do
+    # use database 15 for testing so we dont accidentally step on you real data
+    @redis = Redis.new :db => 15
+    @semaphore = Redis::Semaphore.new(:my_semaphore, @redis)
+  end
+
+  before(:each) do
+    @redis.flushdb
+  end
+
+  after(:each) do
+    @redis.flushdb
+  end
+
+  after(:all) do
+    @redis.quit
+  end
+  
+  it "should be unlocked from the start" do
+    @semaphore.locked?.should == false
+  end
+  
+  it "should lock and unlock" do
+    @semaphore.lock
+    @semaphore.locked?.should == true
+    @semaphore.unlock
+    @semaphore.locked?.should == false
+  end
+  
+  it "should not lock twice as a mutex" do
+    @semaphore.lock
+    @semaphore.lock(1).should == false
+  end
+  
+  it "should not lock three times when only two available" do
+    multisem = Redis::Semaphore.new(:my_semaphore2, 2, @redis)
+    multisem.lock.should == true
+    multisem.lock(1).should == true
+    multisem.lock(1).should == false
+  end
+  
+  it "should execute the given code block" do
+    code_executed = false
+    @semaphore.lock do
+      code_executed = true
+    end
+    code_executed.should == true    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'rspec'
+require 'redis'
+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

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: redis-semaphore
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Verhasselt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: |
+  Implements a distributed semaphore or mutex using Redis.
+
+email: david@crowdway.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/redis/semaphore.rb
+- lib/redis-semaphore.rb
+- spec/spec_helper.rb
+- spec/redis_spec.rb
+has_rdoc: true
+homepage: http://github.com/dv/redis-semaphore
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Implements a distributed semaphore or mutex using Redis.
+test_files: []
+