mega_mutex 0.2.0 → 0.2.1

data/README.markdown

@@ -1,5 +1,7 @@
 # mega_mutex
 
+A distributed mutex for Ruby.
+
 ## Why
 
 Sometimes I need to do this:
@@ -8,7 +10,7 @@ Sometimes I need to do this:
       make_more_things
     end
     
-Sometimes though, if I'm running lots of processes in parallel, I get a race condition that means two of the processes both think there are not enough things. So we go and make some more, even though we don't need to.
+If I'm running several processes in parallel, I can get a race condition that means two of the processes both think there are not enough things. So we go and make some more, even though we don't need to.
 
 ## How
 
@@ -18,7 +20,7 @@ Suppose you have a ThingMaker:
       include MegaMutex
       
       def ensure_just_enough_things  
-        with_cross_process_mutex("ThingMaker Mutex ID") do
+        with_distributed_mutex("ThingMaker Mutex ID") do
           unless enough_things?
             make_more_things
           end
@@ -28,7 +30,12 @@ Suppose you have a ThingMaker:
 
 Now, thanks to the magic of MegaMutex, you can be sure that all processes trying to run this code will wait their turn, so each one will have the chance to make exactly the right number of things, without anyone else poking their nose in.
 
-## Configuration
+## Install
+
+    sudo gem install mega_mutex
+
+
+## Configure
 
 MegaMutex uses [memcache-client](http://seattlerb.rubyforge.org/memcache-client/) to store the mutex, so your infrastructure must be set up to use memcache servers.
 
@@ -38,6 +45,10 @@ By default, MegaMutex will attempt to connect to a memcache on the local machine
       config.memcache_servers = ['mc1', 'mc2']
     end
 
+## Help
+
+MegaMutex was built by the [Songkick.com](http://www.songkick.com) development team. Come chat to us on [#songkick](irc://chat.freenode.net/#songkick) on freenode.net.
+
 ## Copyright
 
 Copyright (c) 2009 Songkick.com. See LICENSE for details.

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "mega_mutex"
-    gem.summary = %Q{Cross-process mutex using MemCache}
-    gem.description = %Q{Cross-process mutex using MemCache}
+    gem.summary = %Q{Distributed mutex for Ruby}
+    gem.description = %Q{Distributed mutex for Ruby}
     gem.email = "developers@songkick.com"
     gem.homepage = "http://github.com/songkick/mega_mutex"
     gem.authors = ["Matt Johnson", "Matt Wynne"]

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/mega_mutex/{cross_process_mutex.rb → distributed_mutex.rb}

@@ -4,7 +4,13 @@ require 'memcache'
 module MegaMutex
   class TimeoutError < Exception; end
 
-  class CrossProcessMutex
+  class DistributedMutex
+
+    class << self
+      def cache
+        @cache ||= MemCache.new MegaMutex.configuration.memcache_servers, :namespace => MegaMutex.configuration.namespace
+      end
+    end
 
     def initialize(key, timeout = nil)
       @key = key
@@ -17,7 +23,7 @@ module MegaMutex
 
     def run(&block)
       @start_time = Time.now
-      log "Attempting to lock cross-process mutex..."
+      log "Attempting to lock mutex..."
       lock!
       log "Locked. Running critical section..."
       yield
@@ -76,7 +82,7 @@ module MegaMutex
     end
 
     def cache
-      @cache ||= MemCache.new MegaMutex.configuration.memcache_servers, :namespace => MegaMutex.configuration.namespace
+      self.class.cache
     end
   end
-end
+end

data/lib/mega_mutex.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 $:.push File.expand_path(File.dirname(__FILE__)) unless $:.include?(File.expand_path(File.dirname(__FILE__)))
-require 'mega_mutex/cross_process_mutex'
+require 'mega_mutex/distributed_mutex'
 
 # == Why
 # 
@@ -10,7 +10,7 @@ require 'mega_mutex/cross_process_mutex'
 #       make_more_things
 #     end
 #     
-# Sometimes though, if I'm running lots of processes in parallel, I get a race condition that means two of the processes both think there are not enough things. So we go and make some more, even though we don't need to.
+# If I'm running several processes in parallel, I can get a race condition that means two of the processes both think there are not enough things. So we go and make some more, even though we don't need to.
 # 
 # == How
 # 
@@ -42,7 +42,7 @@ require 'mega_mutex/cross_process_mutex'
 module MegaMutex
   
   def self.get_current_lock(mutex_id)
-    CrossProcessMutex.new(mutex_id).current_lock
+    DistributedMutex.new(mutex_id).current_lock
   end
 
   ## 
@@ -53,22 +53,23 @@ module MegaMutex
   # You can optionally specify a :timeout to control how long to wait for the lock to be released
   # before raising a MegaMutex::TimeoutError
   #
-  #   with_cross_process_mutex('my_mutex_id_1234', :timeout => 20) do
+  #   with_distributed_mutex('my_mutex_id_1234', :timeout => 20) do
   #     do_something!
   #   end
-  def with_cross_process_mutex(mutex_id, options = {}, &block)
-    mutex = CrossProcessMutex.new(mutex_id, options[:timeout])
+  def with_distributed_mutex(mutex_id, options = {}, &block)
+    mutex = DistributedMutex.new(mutex_id, options[:timeout])
     begin
       mutex.run(&block)
     rescue Object => e
       mega_mutex_insert_into_backtrace(
         e, 
-        /mega_mutex\.rb.*with_cross_process_mutex/, 
+        /mega_mutex\.rb.*with_(distributed|cross_process)_mutex/, 
         "MegaMutex lock #{mutex_id}"
       )
       raise e
     end
   end
+  alias :with_cross_process_mutex :with_distributed_mutex
 
   # inserts a line into a backtrace at the correct location
   def mega_mutex_insert_into_backtrace(exception, re, newline)

data/mega_mutex.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mega_mutex}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   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-10-26}
-  s.description = %q{Cross-process mutex using MemCache}
+  s.date = %q{2010-02-07}
+  s.description = %q{Distributed mutex for Ruby}
   s.email = %q{developers@songkick.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/mega_mutex.rb",
-     "lib/mega_mutex/cross_process_mutex.rb",
+     "lib/mega_mutex/distributed_mutex.rb",
      "mega_mutex.gemspec",
      "spec/lib/mega_mutex_spec.rb",
      "spec/spec_helper.rb"
@@ -33,10 +33,10 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Cross-process mutex using MemCache}
+  s.summary = %q{Distributed mutex for Ruby}
   s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/lib/mega_mutex_spec.rb"
+    "spec/lib/mega_mutex_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/lib/mega_mutex_spec.rb

@@ -43,7 +43,7 @@ module MegaMutex
           describe "when #{n} blocks try to run at the same instant in the same process" do
             it "should run each in turn" do
               n.times do
-                threads << Thread.new{ with_cross_process_mutex(mutex_id, &@mutually_exclusive_block) }
+                threads << Thread.new{ with_distributed_mutex(mutex_id, &@mutually_exclusive_block) }
               end
               wait_for_threads_to_finish
               @errors.should be_empty
@@ -53,14 +53,14 @@ module MegaMutex
 
         describe "when the first block raises an exception" do
           before(:each) do
-            with_cross_process_mutex(mutex_id) do
+            with_distributed_mutex(mutex_id) do
               raise "Something went wrong in my code"
             end rescue nil
           end
 
           it "the second block should find that the lock is clear and it can run" do
             @success = nil
-            with_cross_process_mutex(mutex_id) do
+            with_distributed_mutex(mutex_id) do
               @success = true
             end
             @success.should be_true
@@ -86,8 +86,8 @@ module MegaMutex
 
           it "should run each in turn" do
             pids = []
-            pids << fork { with_cross_process_mutex(mutex_id, &@mutually_exclusive_block); Kernel.exit! }
-            pids << fork { with_cross_process_mutex(mutex_id, &@mutually_exclusive_block); Kernel.exit! }
+            pids << fork { with_distributed_mutex(mutex_id, &@mutually_exclusive_block); Kernel.exit! }
+            pids << fork { with_distributed_mutex(mutex_id, &@mutually_exclusive_block); Kernel.exit! }
             pids.each{ |p| Process.wait(p) }
             if File.exists?(@errors_file)
               raise "Expected no errors but found #{File.read(@errors_file)}"
@@ -105,7 +105,7 @@ module MegaMutex
         @exception = nil
         @first_thread_has_started = false
         threads << Thread.new do
-          with_cross_process_mutex('foo') do
+          with_distributed_mutex('foo') do
             @first_thread_has_started = true
             sleep 0.2
           end
@@ -113,7 +113,7 @@ module MegaMutex
         threads << Thread.new do
           sleep 0.1 until @first_thread_has_started
           begin
-            with_cross_process_mutex('foo', :timeout => 0.1 ) do
+            with_distributed_mutex('foo', :timeout => 0.1 ) do
               raise 'this code should never run'
             end
           rescue Exception => @exception

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mega_mutex
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Matt Johnson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-26 00:00:00 +00:00
+date: 2010-02-07 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.4
     version: 
-description: Cross-process mutex using MemCache
+description: Distributed mutex for Ruby
 email: developers@songkick.com
 executables: []
 
@@ -50,7 +50,7 @@ files:
 - Rakefile
 - VERSION
 - lib/mega_mutex.rb
-- lib/mega_mutex/cross_process_mutex.rb
+- lib/mega_mutex/distributed_mutex.rb
 - mega_mutex.gemspec
 - spec/lib/mega_mutex_spec.rb
 - spec/spec_helper.rb
@@ -81,7 +81,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Cross-process mutex using MemCache
+summary: Distributed mutex for Ruby
 test_files: 
-- spec/spec_helper.rb
 - spec/lib/mega_mutex_spec.rb
+- spec/spec_helper.rb