resque-batched-job 0.1.2 → 0.1.3

data/README.markdown

@@ -3,31 +3,27 @@ Resque Batched Job
 
 A [Resque](http://github.com/defunkt/resque) plugin. Requires Resque 1.10.0
 
-TODO
-----
-	* Define a complete batch
+This plugin adds the ability to batch jobs and run additional hooks after the last job in a batch is performed.  Using the 'after_enqueue' hook, the jobs 
+arguments are stored in a Redis set identified by the batch id provided.  By default, the batch keys look like 'batch:<id>'.  After each job is performed, its arguments are removed from the set.  If the last job performed happens to be the last in a set, additional hooks are executed.  These hooks are prefixed with 'after_batch'.
 
+
+Installation
+------------
+	gem install resque-batched-job
+	
 Example
 -------
+	
+	module Job
+	
+		extend Resque::Plugins::BatchedJob
+	
+		def self.perform(id, *args)
+			prime(id, args)
+		end
+		
+		def self.after_batch_heavy_lifting(id, *args)
+			heavy_lifting(id)
+		end
 
-	class Job
-  
-	  extend Resque::Plugins::BatchedJob
-  
-	  @queue = :example
-  
-	  def self.before_perform_clean_up(place, name)
-	    puts "#{name} straightening up desk"
-	  end
-  
-	  def self.perform(place, name)
-	    puts "#{name} leaving the #{place}"
-	    sleep 1
-	  end
-  
-	  def self.after_batch_turn_lights_out(place, name)
-	    puts "#{name} turing the lights out in the #{place}."
-	    sleep 1
-	  end
-  
 	end

data/Rakefile

@@ -17,7 +17,7 @@ task :publish => :build do
   require 'lib/resque/plugins/batched_job/version'
   sh "gem push resque-batched-job-#{Resque::Plugins::BatchedJob::VERSION}.gem"
   sh "git tag v#{Resque::Plugins::BatchedJob::VERSION}"
-  sh "git put origin v#{Resque::Plugins::BatchedJob::VERSION}"
+  sh "git push origin v#{Resque::Plugins::BatchedJob::VERSION}"
   sh "git push origin master"
 end
 

data/lib/resque/plugins/batched_job/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module BatchedJob
-      VERSION = '0.1.2'
+      VERSION = '0.1.3'
     end
   end
 end

data/lib/resque/plugins/batched_job.rb

@@ -21,6 +21,26 @@ module Resque
       def batch(id)
         "batch:#{id}"
       end
+      
+      #
+      #   Use this method to configure batch locking.  By default, all jobs lock
+      # the batch they belong to.  Use 
+      # def lock_batch=(true_or_false)
+      #   @@_lock = true_or_false
+      # end
+      
+      #
+      #   Create the batch lock.  This ensures only one worker is processing a
+      # batch at any given time.
+      def lock(id)
+        "lock:batch:#{id}"
+      end
+            
+      #
+      #
+      def lock!(id)
+        redis.setnx(lock(id))
+      end
 
       #
       # Batch the job.  The first argument of a batched job, is the batch id.
@@ -41,12 +61,16 @@ module Resque
 
       # 
       #   After every job, no matter in the event of success or failure, we need
-      # to remove the job from the batch set.
+      # to remove the job from the batch set.  If batch locking is enabled, remove
+      # the lock key after each job.  This will allow others jobs in a batch to
+      # be processed.
       def around_perform_amend_batch(id, *args)
+        return unless redis.setnx(lock(id), true)
         begin
           yield
         ensure
           redis.srem(batch(id), "#{encode(args)}")
+          redis.del(lock(id))
         end
       end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Daniel Johnston
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 -06:00
+date: 2010-12-11 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,8 +32,8 @@ dependencies:
         version: 1.10.0
   type: :runtime
   version_requirements: *id001
-description: "  Resque plugin for batching jobs. When a batch/group of jobs are complete, \n\
-  additional work can be performed usings batch hooks.\n"
+description: "  Resque plugin that understands individual jobs can belong to something bigger \n\
+  than themselves.\n"
 email: dan@dj-agiledev.com
 executables: []