redis-mutex 0.9.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "redis-classy", "~> 0.9.0"
+
+group :development do
+  gem "rspec", "~> 2.5.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    redis (2.1.1)
+    redis-classy (0.9.0)
+      redis-namespace (~> 0.10.0)
+    redis-namespace (0.10.0)
+      redis (< 3.0.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  redis-classy (~> 0.9.0)
+  rspec (~> 2.5.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kenn Ejima
+
+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/README.rdoc

@@ -0,0 +1,56 @@
+= Redis Mutex
+
+Distrubuted non-blocking mutex in Ruby using Redis.
+
+The idea was taken from - http://redis.io/commands/setnx and http://gist.github.com/457269
+
+Requires the redis-classy gem.
+
+== Install
+
+ gem install redis-mutex
+
+== Usage
+
+In Gemfile:
+
+ gem "redis-mutex"
+
+In config/initializers/redis_mutex.rb:
+
+ Redis::Classy.db = Redis.new(:host => 'localhost')
+
+There are four methods - new, lock, unlock and sweep:
+
+ mutex = Redis::Classy::Mutex.new(some_object)
+ mutex.lock
+ mutex.unlock
+ Redis::Classy::Mutex.sweep
+
+It takes any Ruby objects that respond to :id, where the key is automatically set as "TheClass:id", or pass any string as a key.
+
+Here's a sample usage in a Rails app:
+
+ class RoomController < ApplicationController
+   def enter
+     @room = Room.find_by_id(params[:id])
+     
+     mutex = Redis::Classy::Mutex.new(@room)   # key => "Room:123"
+     
+     if mutex.lock    # return true when you successfully obtain the lock for the room 123
+       ...
+       do_something
+       ...
+       mutex.unlock   # exit the critical section ASAP
+     end
+   end
+ end
+
+The caveat is that the lock just returns false when it fails and do not block.
+
+If you take a closer look, you find that the actual key is structured in the following form:
+
+ Redis::Classy.keys
+ => ["Redis::Classy::Mutex:Room:123"]
+
+For more internal details, refer to https://github.com/kenn/redis-classy

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "redis-mutex"
+  gem.homepage = "http://github.com/kenn/redis-mutex"
+  gem.license = "MIT"
+  gem.summary = "Distrubuted non-blocking mutex in Ruby using Redis"
+  gem.description = "Distrubuted non-blocking mutex in Ruby using Redis"
+  gem.email = "kenn.ejima@gmail.com"
+  gem.authors = ["Kenn Ejima"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redis-mutex #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/redis-mutex.rb

@@ -0,0 +1,5 @@
+require 'redis-classy'
+
+class Redis::Classy
+  autoload :Mutex, 'redis/classy/mutex'
+end

data/lib/redis/classy/mutex.rb

@@ -0,0 +1,45 @@
+class Redis::Classy::Mutex < Redis::Classy
+
+  TIMEOUT = 10
+
+  def initialize(object, timeout=TIMEOUT)
+    @now = Time.now.to_i
+    @expires_at = @now + timeout
+    super(object.is_a?(String) ? object : "#{object.class.name}:#{object.id}")
+  end
+
+  def lock
+    return true   if self.setnx(@expires_at)  # Success, the lock was acquired
+    return false  if self.get.to_i > @now     # Failure, someone took the　lock and it is still effective
+
+    # The lock has expired but wasn't released... BAD!
+    return true   if self.getset(@expires_at).to_i <= @now   # Success, we acquired the previously expired lock!
+    return false  # Dammit, it seems that someone else was even faster than us to acquire this lock.
+  end
+
+  def unlock
+    self.del      if self.get.to_i == @expires_at   # Release the lock if it seems to be yours.
+    true
+  end
+
+  def self.sweep(timeout=TIMEOUT)
+    now = Time.now.to_i
+    keys = self.keys
+
+    return 0 if keys.empty?
+
+    values = self.mget(*keys)
+
+    expired_keys = [].tap do |array|
+      keys.each_with_index do |key, i|
+        array << key if !values[i].nil? and values[i].to_i <= now
+      end
+    end
+
+    expired_keys.each do |key|
+      self.del(key) if self.getset(key, now + timeout).to_i <= now # Make extra sure someone haven't released the lock yet.
+    end
+
+    expired_keys.size
+  end
+end

data/spec/redis-mutex_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RedisMutex" do
+  pending "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'redis-mutex'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: redis-mutex
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Kenn Ejima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-28 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis-classy
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Distrubuted non-blocking mutex in Ruby using Redis
+email: kenn.ejima@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redis-mutex.rb
+- lib/redis/classy/mutex.rb
+- spec/redis-mutex_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kenn/redis-mutex
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4175039287226783610
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Distrubuted non-blocking mutex in Ruby using Redis
+test_files: 
+- spec/redis-mutex_spec.rb
+- spec/spec_helper.rb