mega_mutex 0.1.0 → 0.2.0

data/Rakefile

@@ -19,6 +19,16 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
+namespace :github do
+  task :push do
+    remotes = `git remote`.split("\n")
+    unless remotes.include?('github')
+      sh('git remote add github git@github.com:songkick/mega_mutex.git')
+    end
+    sh('git push github master')
+  end
+end
+
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
@@ -33,7 +43,7 @@ end
 
 task :spec => :check_dependencies
 
-task :default => :spec
+task :default => [:spec, 'github:push', 'gemcutter:release']
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/mega_mutex/cross_process_mutex.rb

@@ -6,24 +6,6 @@ module MegaMutex
 
   class CrossProcessMutex
 
-    class Configuration
-      attr_accessor :memcache_servers
-
-      def initialize
-        @memcache_servers = 'localhost'
-      end
-    end
-
-    class << self
-      def configure
-        yield configuration
-      end
-
-      def configuration
-        @configuration ||= Configuration.new
-      end
-    end
-    
     def initialize(key, timeout = nil)
       @key = key
       @timeout = timeout
@@ -45,6 +27,10 @@ module MegaMutex
       log "Unlocking Mutex."
     end
     
+    def current_lock
+      cache.get(@key)
+    end
+    
   private
   
     def timeout?
@@ -81,10 +67,6 @@ module MegaMutex
       current_lock == my_lock_id
     end
     
-    def current_lock
-      cache.get(@key)
-    end
-    
     def set_current_lock(new_lock)
       cache.add(@key, my_lock_id)      
     end
@@ -94,7 +76,7 @@ module MegaMutex
     end
 
     def cache
-      @cache ||= MemCache.new self.class.configuration.memcache_servers, :namespace => 'mega_mutex'
+      @cache ||= MemCache.new MegaMutex.configuration.memcache_servers, :namespace => MegaMutex.configuration.namespace
     end
   end
 end

data/lib/mega_mutex.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
-$:.push File.expand_path(File.dirname(__FILE__))
-
+$:.push File.expand_path(File.dirname(__FILE__)) unless $:.include?(File.expand_path(File.dirname(__FILE__)))
 require 'mega_mutex/cross_process_mutex'
 
 # == Why
@@ -41,6 +40,10 @@ require 'mega_mutex/cross_process_mutex'
 #       config.memcache_servers = ['mc1', 'mc2']
 #     end
 module MegaMutex
+  
+  def self.get_current_lock(mutex_id)
+    CrossProcessMutex.new(mutex_id).current_lock
+  end
 
   ## 
   # Wraps code that should only be run when the mutex has been obtained.
@@ -55,7 +58,49 @@ module MegaMutex
   #   end
   def with_cross_process_mutex(mutex_id, options = {}, &block)
     mutex = CrossProcessMutex.new(mutex_id, options[:timeout])
-    mutex.run(&block)
+    begin
+      mutex.run(&block)
+    rescue Object => e
+      mega_mutex_insert_into_backtrace(
+        e, 
+        /mega_mutex\.rb.*with_cross_process_mutex/, 
+        "MegaMutex lock #{mutex_id}"
+      )
+      raise e
+    end
   end
 
+  # inserts a line into a backtrace at the correct location
+  def mega_mutex_insert_into_backtrace(exception, re, newline)
+    loc = nil
+    exception.backtrace.each_with_index do |line, index|
+      if line =~ re
+        loc = index
+        break
+      end
+    end
+    if loc
+      exception.backtrace.insert(loc, newline)
+    end
+  end
+  
+  class Configuration
+    attr_accessor :memcache_servers, :namespace
+
+    def initialize
+      @memcache_servers = 'localhost'
+      @namespace = 'mega_mutex'
+    end
+  end
+
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
 end
+

data/mega_mutex.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mega_mutex}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Johnson", "Matt Wynne"]
-  s.date = %q{2009-08-18}
+  s.date = %q{2009-10-26}
   s.description = %q{Cross-process mutex using MemCache}
   s.email = %q{developers@songkick.com}
   s.extra_rdoc_files = [
@@ -26,15 +26,17 @@ Gem::Specification.new do |s|
      "lib/mega_mutex.rb",
      "lib/mega_mutex/cross_process_mutex.rb",
      "mega_mutex.gemspec",
-     "spec/lib/mega_mutex_spec.rb"
+     "spec/lib/mega_mutex_spec.rb",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/songkick/mega_mutex}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Cross-process mutex using MemCache}
   s.test_files = [
-    "spec/lib/mega_mutex_spec.rb"
+    "spec/spec_helper.rb",
+     "spec/lib/mega_mutex_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/lib/mega_mutex_spec.rb

@@ -1,20 +1,12 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/mega_mutex')
-
-# Logging::Logger[:root].add_appenders(Logging::Appenders.stdout)
+require File.dirname(__FILE__) + '/../spec_helper'
 
 module MegaMutex
   describe MegaMutex do
     def logger
       Logging::Logger['Specs']
     end
-
-    before(:all) do
-      @old_abort_on_exception_value = Thread.abort_on_exception
-      Thread.abort_on_exception = true
-    end
-    after(:all) do
-      Thread.abort_on_exception = @old_abort_on_exception_value
-    end
+    
+    abort_on_thread_exceptions
 
     describe "two blocks, one fast, one slow" do
       before(:each) do
@@ -29,10 +21,9 @@ module MegaMutex
 
       describe "with no lock" do
         it "trying to run the block twice should raise an error" do
-          threads = []
           threads << Thread.new(&@mutually_exclusive_block)
           threads << Thread.new(&@mutually_exclusive_block)
-          threads.each{ |t| t.join }
+          wait_for_threads_to_finish
           @errors.should_not be_empty
         end
       end
@@ -51,11 +42,10 @@ module MegaMutex
         [2, 20].each do |n|
           describe "when #{n} blocks try to run at the same instant in the same process" do
             it "should run each in turn" do
-              threads = []
               n.times do
                 threads << Thread.new{ with_cross_process_mutex(mutex_id, &@mutually_exclusive_block) }
               end
-              threads.each{ |t| t.join }
+              wait_for_threads_to_finish
               @errors.should be_empty
             end
           end
@@ -110,19 +100,27 @@ module MegaMutex
   
     describe "with a timeout" do
       include MegaMutex
+
       it "should raise an error if the code blocks for longer than the timeout" do
-        @success = false
-        threads = []
-        threads << Thread.new{ with_cross_process_mutex('foo'){ sleep 2 } }
+        @exception = nil
+        @first_thread_has_started = false
         threads << Thread.new do
+          with_cross_process_mutex('foo') do
+            @first_thread_has_started = true
+            sleep 0.2
+          end
+        end
+        threads << Thread.new do
+          sleep 0.1 until @first_thread_has_started
           begin
-            with_cross_process_mutex('foo', :timeout => 1 ){ puts 'nobody will ever hear me scream' } 
-          rescue MegaMutex::TimeoutError
-            @success = true
+            with_cross_process_mutex('foo', :timeout => 0.1 ) do
+              raise 'this code should never run'
+            end
+          rescue Exception => @exception
           end
         end
-        threads.each{ |t| t.join }
-        @success.should be_true
+        wait_for_threads_to_finish
+        assert @exception.is_a?(MegaMutex::TimeoutError), "Expected TimeoutError to be raised, but wasn't"
       end
     end
   end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/mega_mutex')
+require 'test/unit/assertions'
+
+# Logging::Logger[:root].add_appenders(Logging::Appenders.stdout)
+
+module ThreadHelper
+  def abort_on_thread_exceptions
+    before(:all) do
+      @old_abort_on_exception_value = Thread.abort_on_exception
+      Thread.abort_on_exception = true
+    end
+    after(:all) do
+      Thread.abort_on_exception = @old_abort_on_exception_value
+    end
+  end
+end
+
+module ThreadExampleHelper
+  def threads
+    @threads ||= []
+  end
+  
+  def wait_for_threads_to_finish
+    threads.each{ |t| t.join }
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.extend ThreadHelper
+  config.include ThreadExampleHelper
+  config.include Test::Unit::Assertions
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mega_mutex
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Matt Johnson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-18 00:00:00 +01:00
+date: 2009-10-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ files:
 - lib/mega_mutex/cross_process_mutex.rb
 - mega_mutex.gemspec
 - spec/lib/mega_mutex_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/songkick/mega_mutex
 licenses: []
@@ -77,9 +78,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Cross-process mutex using MemCache
 test_files: 
+- spec/spec_helper.rb
 - spec/lib/mega_mutex_spec.rb