ruby_redis_lock 0.1.0

data/lib/ruby_redis_lock.rb

@@ -0,0 +1,9 @@
+require 'redis'
+
+require File.expand_path('../ruby_redis_lock/ruby_redis_lock', __FILE__)
+
+
+class Redis
+  include RubyRedisLock
+  
+end

data/lib/ruby_redis_lock/ruby_redis_lock.rb

@@ -0,0 +1,66 @@
+module RubyRedisLock
+  
+
+  def lock(lock_name, processing_timeout=60, acquiring_timout=10)
+    acquire_lock(lock_name, processing_timeout, acquiring_timout)
+    yield
+  ensure
+    release_lock(lock_name, processing_timeout)
+  end
+  
+  
+  private
+    def acquire_lock(lock_name, processing_timeout=60, acquiring_timeout=10)
+      
+      start_time = Time.now.to_i
+      
+      while !try_acquire_lock(lock_name, processing_timeout)
+      
+        sleep(rand(100).to_f/100.0)
+      
+        if (Time.now.to_i - start_time) > acquiring_timeout
+          raise Exception, "Acquiring lock timeout > #{acquiring_timeout} seconds"
+        end
+        
+      end
+      
+      return true
+    
+    end
+  
+    def try_acquire_lock(lock_name, processing_timeout=60)
+      
+      ret = self.setnx(ruby_redis_lock_key(lock_name), "#{Time.now.to_i + processing_timeout}")
+      return true if ret == true
+      
+      expiration = self.get(ruby_redis_lock_key(lock_name)).to_i
+      return false if Time.now.to_i < expiration
+
+      previous_expiration = self.getset(ruby_redis_lock_key(lock_name), "#{Time.now.to_i + processing_timeout}").to_i
+      return true if expiration == previous_expiration
+      
+      return false
+      
+    end
+    
+    def release_lock(lock_name, processing_timeout=60)
+      
+      expiration = self.get(ruby_redis_lock_key(lock_name)).to_i
+      return false if Time.now.to_i > expiration
+      
+      previous_expiration = self.getset(ruby_redis_lock_key(lock_name), "#{Time.now.to_i + processing_timeout}").to_i
+      
+      if expiration == previous_expiration # it still owns the lock
+        self.del(ruby_redis_lock_key(lock_name))
+        return true
+      end
+      
+      return false
+    end
+  
+    def ruby_redis_lock_key(lock_name)
+      "RubyRedisLock:#{lock_name}"
+    end
+  
+
+end

data/redis_test.bat

@@ -0,0 +1,2 @@
+"C:\redis\redis-server" test.conf
+pause

data/ruby_redis_lock.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "ruby_redis_lock"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tanin Na Nakorn"]
+  s.email       = ["tanin47@yahoo.com"]
+  s.homepage    = "http://github.com/tanin47/ruby_redis_lock"
+  s.summary     = %q{RubyRedisLock is a distributed lock for Ruby (using Redis)}
+  s.description = %q{distributed lock for Ruby (using Redis)}
+
+  s.rubyforge_project = "ruby_redis_lock"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {coverage,spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end

data/ruby_redis_lock.rdb

@@ -0,0 +1 @@
+REDIS0001�

data/spec/acquire_lock_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'acquire_lock' do
+  
+  it "acquires the lock if it does not exist" do
+    @redis.send(:acquire_lock, "test").should == true
+  end
+  
+  it "acquires the lock if it is expired" do
+    
+    @redis.send(:acquire_lock, "test", 0.1).should == true
+    
+    sleep(1)
+    @redis.send(:acquire_lock, "test").should == true
+    
+  end
+  
+  it "raise errors when acquiring the lock takes too long" do
+    
+    @redis.send(:acquire_lock, "test", 60, 60).should == true
+    
+    lambda { @redis.send(:acquire_lock, "test", 60, 1) }.should raise_error
+    
+  end
+  
+  it "waits until the other thread finishes and acquire lock" do
+    
+    start_time = Time.now.to_i
+    @redis.send(:acquire_lock, "test", 60, 60).should == true
+    
+    Thread.new { 
+      Thread.current.join(1)
+      sleep(5)
+      @redis.send(:release_lock, "test", 60).should == true
+    }
+    
+    Thread.current.join(1)
+    @redis.send(:acquire_lock, "test", 60, 20).should == true
+    
+    (Time.now.to_i - start_time).should be > 4
+    
+  end
+  
+end

data/spec/lock_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'lock' do
+  
+  it "acquires the lock if it does not exist" do
+    
+    @redis.lock("test") { }
+    
+  end
+  
+  it "waits and acquire lock" do
+    
+    start_time = Time.now.to_i
+    
+    Thread.new {
+      @redis.lock("test") { 
+        Thread.current.join(1)
+        sleep(5) 
+      }
+    }
+    
+    Thread.current.join(1)
+    
+    @redis.lock("test") { }
+    
+    (Time.now.to_i - start_time).should be > 4
+    
+  end
+  
+  it "waits and acquire expired lock" do
+    
+    start_time = Time.now.to_i
+    
+    Thread.new {
+      @redis.send(:acquire_lock, "test", 5, 10).should == true
+    }
+    
+    Thread.current.join(0.1)
+    
+    @redis.lock("test") { }
+    
+    (Time.now.to_i - start_time).should be > 4
+    
+  end
+  
+  it "fails to acquire lock" do
+    
+    Thread.new {
+      @redis.lock("test") { 
+        Thread.current.join(1)
+        sleep(5) 
+      }
+    }
+    
+    Thread.current.join(1)
+    lambda { @redis.lock("test", 10, 2) {  } }.should raise_error
+    
+  end
+  
+  it "correctly release the lock when error is raised" do
+    
+    begin
+      @redis.lock("test") { 
+        raise 'some error'
+      }
+    rescue
+    end
+    
+    @redis.get(@redis.send(:ruby_redis_lock_key, "test")).should == nil
+    
+  end
+  
+end

data/spec/release_lock_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'release_lock' do
+  
+  it "release lock when the lock is not expired" do
+    
+    @redis.send(:acquire_lock, "test", 69).should == true
+    
+    @redis.send(:release_lock, "test").should == true
+    
+  end
+  
+  it "does not release lock if the lock is already expired" do
+    
+    @redis.send(:acquire_lock, "test", 0.1).should == true
+    
+    sleep(1)
+    @redis.send(:release_lock, "test").should == false
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'simplecov'
+SimpleCov.start do
+  coverage_dir("coverage") 
+end
+
+require 'rspec'
+
+require File.expand_path("../../lib/ruby_redis_lock",__FILE__)
+
+RSpec.configure do |config|
+  
+  config.mock_with :rspec
+  
+  config.before(:each) do
+    @redis = Redis.new
+    @redis.flushall
+  end
+  
+end

data/spec/try_acquire_lock_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'try_acquire_lock' do
+  
+  it "acquires lock when the lock does not exist" do
+    
+    @redis.send(:try_acquire_lock, "test").should == true
+    
+  end
+  
+  it "does not acquire lock when the lock is alive" do
+    
+    @redis.send(:try_acquire_lock, "test").should == true
+    @redis.send(:try_acquire_lock, "test").should == false
+    
+  end
+  
+  it "acquires lock when the lock is expired" do
+    
+    @redis.send(:try_acquire_lock, "test", 0.1).should == true
+    
+    sleep(1)
+    @redis.send(:try_acquire_lock, "test").should == true
+    
+  end
+  
+  it "does not acquire lock when the lock is expired but somebody else already successfully acquire the same lock" do
+    
+  end
+  
+end

data/test.conf

@@ -0,0 +1 @@
+dbfilename ruby_redis_lock.rdb

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ruby_redis_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tanin Na Nakorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-29 00:00:00.000000000Z
+dependencies: []
+description: distributed lock for Ruby (using Redis)
+email:
+- tanin47@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .loadpath
+- .project
+- Gemfile
+- Gemfile.lock
+- Readme.md
+- coverage/.resultset.json
+- coverage/assets/0.5.3/app.js
+- coverage/assets/0.5.3/fancybox/blank.gif
+- coverage/assets/0.5.3/fancybox/fancy_close.png
+- coverage/assets/0.5.3/fancybox/fancy_loading.png
+- coverage/assets/0.5.3/fancybox/fancy_nav_left.png
+- coverage/assets/0.5.3/fancybox/fancy_nav_right.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_e.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_n.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_ne.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_nw.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_s.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_se.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_sw.png
+- coverage/assets/0.5.3/fancybox/fancy_shadow_w.png
+- coverage/assets/0.5.3/fancybox/fancy_title_left.png
+- coverage/assets/0.5.3/fancybox/fancy_title_main.png
+- coverage/assets/0.5.3/fancybox/fancy_title_over.png
+- coverage/assets/0.5.3/fancybox/fancy_title_right.png
+- coverage/assets/0.5.3/fancybox/fancybox-x.png
+- coverage/assets/0.5.3/fancybox/fancybox-y.png
+- coverage/assets/0.5.3/fancybox/fancybox.png
+- coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css
+- coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.pack.js
+- coverage/assets/0.5.3/favicon_green.png
+- coverage/assets/0.5.3/favicon_red.png
+- coverage/assets/0.5.3/favicon_yellow.png
+- coverage/assets/0.5.3/highlight.css
+- coverage/assets/0.5.3/highlight.pack.js
+- coverage/assets/0.5.3/jquery-1.6.2.min.js
+- coverage/assets/0.5.3/jquery.dataTables.min.js
+- coverage/assets/0.5.3/jquery.timeago.js
+- coverage/assets/0.5.3/jquery.url.js
+- coverage/assets/0.5.3/loading.gif
+- coverage/assets/0.5.3/magnify.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.5.3/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_222222_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_454545_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_888888_256x240.png
+- coverage/assets/0.5.3/smoothness/images/ui-icons_cd0a0a_256x240.png
+- coverage/assets/0.5.3/smoothness/jquery-ui-1.8.4.custom.css
+- coverage/assets/0.5.3/stylesheet.css
+- coverage/index.html
+- lib/ruby_redis_lock.rb
+- lib/ruby_redis_lock/ruby_redis_lock.rb
+- redis_test.bat
+- ruby_redis_lock.gemspec
+- ruby_redis_lock.rdb
+- spec/acquire_lock_spec.rb
+- spec/lock_spec.rb
+- spec/release_lock_spec.rb
+- spec/spec_helper.rb
+- spec/try_acquire_lock_spec.rb
+- test.conf
+homepage: http://github.com/tanin47/ruby_redis_lock
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ruby_redis_lock
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: RubyRedisLock is a distributed lock for Ruby (using Redis)
+test_files: []