distributed_mutex 1.0.1 → 1.0.2

data/README.rdoc

@@ -18,6 +18,14 @@ framework.
 
   script/plugin install git://github.com/birkirb/distributed_mutex.git
 
+== Gem Install
+
+  gem install distributed_mutex
+
+To add the plugin to your rails project, add the following to your config/environments.rb:
+
+  config.gem(:distributed_mutex)
+
 == Copyright
 
 Author::    Birkir A. Barkarson <birkirb@stoicviking.net>

data/Rakefile

@@ -5,12 +5,12 @@ begin
   Jeweler::Tasks.new do |s|
     s.name = %q{distributed_mutex}
     s.authors = ["Birkir A. Barkarson"]
-    s.description = %q{Framework for using a distributed mutex. Implementation of a mutex stored on a MySQL database.}
-    s.summary = s.description
+    s.description = %q{Framework for using a distributed mutex along with an implementation of a mutex stored on a MySQL database.}
+    s.summary = %q{API for using a unique mutex across all instances of your application.}
     s.email = %q{birkirb@stoicviking.net}
     s.has_rdoc = true
     s.homepage = %q{http://github.com/birkirb/distributed_mutex}
-    s.add_dependency(%q<activerecord>, [">= 1.2"])
+  # s.add_dependency(%q<activerecord>, ["> 1.2"])
   end
 rescue LoadError
   puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/mysql_mutex.rb

@@ -3,6 +3,8 @@ require 'distributed_mutex'
 
 class MySQLMutex < DistributedMutex
 
+  @active_locks = Hash.new
+
   def initialize(key, timeout = DEFAULT_TIMEOUT, exception_on_timeout = DEFAULT_EXCEPTION_ON_TIMEOUT, connection = ActiveRecord::Base.connection)
     @connection = connection
     @lock_was_free = false
@@ -11,9 +13,15 @@ class MySQLMutex < DistributedMutex
     super(key, timeout, exception_on_timeout)
   end
 
+  def self.active_locks
+    @active_locks
+  end
+
   def self.synchronize(key, timeout = DEFAULT_TIMEOUT, exception_on_timeout = DEFAULT_TIMEOUT, con = ActiveRecord::Base.connection, &block)
     mutex = new(key, timeout, exception_on_timeout, con)
+    @active_locks[key] = timeout
     mutex.synchronize(&block)
+    @active_locks.delete(key)
   end
 
   private
@@ -33,3 +41,20 @@ class MySQLMutex < DistributedMutex
   end
 
 end
+
+at_exit do
+  locks = MySQLMutex.active_locks
+  if locks.size > 0
+    if defined?(Rails)
+      Rails.logger.error("MySQLMutex: Locks still active! - #{locks.inspect}")
+    else
+      STDERR.puts("MySQLMutex: Locks still active! - #{locks.inspect}")
+    end
+  else
+    if defined?(Rails)
+      Rails.logger.debug("MySQLMutex: All locks released.")
+    else
+      STDERR.puts("MySQLMutex: All locks released.")
+    end
+  end
+end

data/spec/mysql_mutex_spec.rb

@@ -133,4 +133,89 @@ describe MySQLMutex, 'with a lock on an open mysql connection' do
 
     sub_thread_executed.should == true
   end
+
+  it 'should released nested synchronized locks and block a second thread which times out' do
+    sub_thread_executed = false
+    main_thread_completed = false
+    final_thread_completed = false
+
+    begin
+      thread_2 = Thread.new do
+        con = ActiveRecord::Base.mysql_connection(ActiveRecord::Base.configurations['test'])
+        sleep 0.1
+        MySQLMutex.synchronize('test', 1, true, con) do
+          sub_thread_executed = true
+        end
+      end
+
+      thread_1 = Thread.new do
+        con = ActiveRecord::Base.mysql_connection(ActiveRecord::Base.configurations['test'])
+        MySQLMutex.synchronize('test', 1, true, con) do
+          MySQLMutex.synchronize('test', 1, true, con) do
+            sleep 3
+            main_thread_completed = true
+          end
+        end
+      end
+
+      lambda do
+        thread_2.join
+      end.should raise_error(MutexLockTimeout)
+
+      thread_1.join
+
+      con = ActiveRecord::Base.mysql_connection(ActiveRecord::Base.configurations['test'])
+      MySQLMutex.synchronize('test', 1, true, con) do
+        final_thread_completed = true
+      end
+    rescue => err
+      fail(err)
+    end
+
+    sub_thread_executed.should == false
+    main_thread_completed.should == true
+    final_thread_completed.should == true
+  end
+
+  it 'should released nested synchronized locks throwing an error and block a second accessing before the error' do
+    final_thread_completed = false
+
+    begin
+      thread_2 = Thread.new do
+        con = ActiveRecord::Base.mysql_connection(ActiveRecord::Base.configurations['test'])
+        sleep 0.1
+        MySQLMutex.synchronize('test', 1, true, con) do
+          raise 'Boom 2!'
+        end
+      end
+
+      thread_1 = Thread.new do
+        con = ActiveRecord::Base.mysql_connection(ActiveRecord::Base.configurations['test'])
+        MySQLMutex.synchronize('test', 1, true, con) do
+          MySQLMutex.synchronize('test', 1, true, con) do
+            sleep 3
+            raise 'Boom 1!'
+          end
+        end
+      end
+
+      lambda do
+        thread_2.join
+      end.should raise_error(MutexLockTimeout)
+
+      lambda do
+        thread_1.join
+      end.should raise_error(RuntimeError, 'Boom 1!')
+
+      con = ActiveRecord::Base.mysql_connection(ActiveRecord::Base.configurations['test'])
+      MySQLMutex.synchronize('test', 1, true, con) do
+        final_thread_completed = true
+      end
+    rescue => err
+      fail(err)
+    end
+
+    final_thread_completed.should == true
+  end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Birkir A. Barkarson
@@ -14,23 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-05 00:00:00 +09:00
+date: 2010-12-06 00:00:00 +09:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        version: "1.2"
-  type: :runtime
-  version_requirements: *id001
-description: Framework for using a distributed mutex. Implementation of a mutex stored on a MySQL database.
+dependencies: []
+
+description: Framework for using a distributed mutex along with an implementation of a mutex stored on a MySQL database.
 email: birkirb@stoicviking.net
 executables: []
 
@@ -39,7 +27,6 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .gitignore
 - README.rdoc
 - Rakefile
 - VERSION
@@ -58,8 +45,8 @@ homepage: http://github.com/birkirb/distributed_mutex
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -82,8 +69,8 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Framework for using a distributed mutex. Implementation of a mutex stored on a MySQL database.
+summary: API for using a unique mutex across all instances of your application.
 test_files: 
-- spec/spec_helper.rb
-- spec/mysql_mutex_spec.rb
 - spec/global_mutex_spec.rb
+- spec/mysql_mutex_spec.rb
+- spec/spec_helper.rb

data/.gitignore

@@ -1 +0,0 @@
-spec/config/database.yml