resque-workers-lock 1.0.0 → 1.0.1

data/README.md

@@ -6,7 +6,7 @@ gem 'resque-workers-lock'
 ```
 
 ## What does it do?
-If resque jobs have the same lock applied this means that those jobs cannot be processed simultaneously by two or more workers.
+If resque jobs have the same lock applied this means that those jobs cannot be processed simultaneously by two or more workers. When this situation occurs the second job gets pushed back to the queue.
 
 ## What is the default lock?
 By default the lock is the instance name + arguments (just like the classic resque-lock). Override this lock to lock on specific arguments.
@@ -19,18 +19,21 @@ This example shows how you can use the workers-lock to prevent two jobs with the
 ``` ruby
 require 'resque/plugins/workers/lock'
 
-class Scraper
+class Parser
   extend Resque::Plugins::Workers::Lock
 
-	def self.lock(domain)
+	# Lock method has the same arguments as the self.perform
+	def self.lock(domain, arg2, arg3)
 		return domain
 	end
 
-  def self.perform(domain)
+	# Perform method with some arguments
+  def self.perform(domain, arg2, arg3)
     # do the work
   end
 end
 ```
+In this example `domain` is used to specify certain types of jobs that are not allowed to run at the same time. For example: if you create three jobs with the domain argument google.com, google.com and yahoo.com, the two google.com jobs will never run at the same time.
 
 ## Requeue loop
 When a job is requeue'ed there is a small delay (1 second by default) before the worker places the job actually back in the queue. Let's say you have two jobs left, and one job is taking 15 seconds on the first worker and the other similar job is being blocked by the second worker. The second worker will continuously try to put the job back in the queue and it will try to process it again (racing for 15 seconds untill the other job has finished). This only happens when there are no other (not locked) jobs in the queue.

data/test/lock_test.rb

@@ -39,6 +39,7 @@ class LockTest < Test::Unit::TestCase
   end
   
   def test_lock
-    # TODO: test that two workers are not processing two jobs
+    # TODO: test that two workers are not processing two jobs with same locks
+    # This is pretty hard to do, contributors are welcome!
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-workers-lock
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2012-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -59,11 +59,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "A Resque plugin. If you want to prevent specific jobs to be processed
-  simultaneously, \nextend it with this module. It locks on the first argument in
-  the perform method.\n\nFor example:\n\n    class Scraper\n      extend Resque::Plugins::Workers::Lock\n\n
-  \       def self.lock(domain)\n            return domain\n        end\n\n      def
-  self.perform(domain)\n        # do the work\n      end\n    end\n"
+description: ! "A Resque plugin. Two or more jobs with the same lock cannot be processed
+  simultaneously by multiple workers. \nWhen this situation occurs the second job
+  gets pushed back to the queue.\n"
 email: bartolsthoorn@gmail.com
 executables: []
 extensions: []