resque-batched-job 1.1.0 → 1.2.0

data/Rakefile

@@ -11,6 +11,14 @@ Rake::TestTask.new do |task|
   task.verbose = true
 end
 
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb', '-', 'README.md']
+  end
+rescue LoadError
+end
+
 desc "Publish RubyGem and source."
 task :publish => [:build, :tag] do
   sh "git push origin v#{Resque::Plugins::BatchedJob::VERSION}"
@@ -23,11 +31,16 @@ task :tag do
   sh "git tag v#{Resque::Plugins::BatchedJob::VERSION}"
 end
 
-desc "Build RubyGem."
+desc "Build resque-batched-job RubyGem."
 task :build do
   sh "gem build resque-batched-job.gemspec"
 end
 
+desc "Install current resque-batched-job RubyGem."
+task :install => :build do
+  sh "gem install --local resque-batched-job-#{Resque::Plugins::BatchedJob::VERSION}.gem"
+end
+
 desc "View changelog"
 task :changelog do
   tags = `git tag`.split("\n").reverse

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

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module BatchedJob
-      VERSION = '1.1.0'
+      VERSION = '1.2.0'
     end
   end
 end

data/lib/resque/plugins/batched_job.rb

@@ -16,11 +16,16 @@ module Resque
       include Resque::Helpers
 
       # Helper method used to generate the batch key.
+      #
+      # @param [Object, #to_s] id Batch identifier. Any Object that responds to #to_s
+      # @return [String] Used to identify batch Redis List key
       def batch(id)
         "batch:#{id}"
       end
 
-      # Batch the job.  The first argument of a batched job, is the batch id.
+      # Resque hook that handles batching the job. (closes #2)
+      #
+      # @param [Object, #to_s] id Batch identifier. Any Object that responds to #to_s
       def after_enqueue_batch(id, *args)
         mutex(id) do |bid|
           redis.rpush(bid, encode(:class => self.name, :args => args))
@@ -30,6 +35,8 @@ module Resque
       # After the job is performed, remove it from the batched job list.  If the
       # current job is the last in the batch to be performed, invoke the after_batch
       # hooks.
+      #
+      # @param id (see Resque::Plugins::BatchedJob#after_enqueue_batch)
       def after_perform_batch(id, *args)
         remove_batched_job(id, *args)
 
@@ -43,31 +50,45 @@ module Resque
 
       # Checks the size of the batched job list and returns true if the list is
       # empty or if the key does not exist.
+      #
+      # @param id (see Resque::Plugins::BatchedJob#batch)
       def batch_complete?(id)
         mutex(id) do |bid| 
           redis.llen(bid) == 0
         end
       end
 
+      # Check to see if the Redis key exists.
+      #
+      # @param id (see Resque::Plugins::BatchedJob#batch)
       def batch_exist?(id)
         mutex(id) do |bid| 
           redis.exists(bid)
         end
       end
 
-      # Remove a job from the batch list.
+      # Remove a job from the batch list. (closes #6)
+      #
+      # @param id (see Resque::Plugins::BatchedJob#after_enqueue_batch)
       def remove_batched_job(id, *args)
         mutex(id) do |bid|
           redis.lrem(bid, 1, encode(:class => self.name, :args => args))
         end
       end
 
+      # Remove a job from the batch list and run after hooks if necessary.
+      #
+      # @param id (see Resque::Plugins::BatchedJob#remove_batched_job)
+      def remove_batched_job!(id, *args)
+        after_perform_batch(id, *args)
+      end
+
       private
 
         # Lock a batch key before executing Redis commands.  This will ensure
         # no race conditions occur when modifying batch information.  Here is
         # an example of how this works.  See http://redis.io/commands/setnx for
-        # more information.
+        # more information. (fixes #4) (closes #5)
         # 
         # * Job2 sends SETNX batch:123:lock in order to aquire a lock.
         # * Job1 still has the key locked, so Job2 continues into the loop.

data/test/test_batched_job.rb

@@ -20,6 +20,14 @@ class BatchedJobTest < Test::Unit::TestCase
     end
   end
 
+  def test_encoding
+    Resque.enqueue(Job, @batch_id, 123)
+    Resque.enqueue(JobWithoutArgs, @batch_id)
+
+    assert_equal("{\"class\":\"Job\",\"args\":[123]}", redis.lindex(@batch, 0))
+    assert_equal("{\"class\":\"JobWithoutArgs\",\"args\":[]}", redis.lindex(@batch, 1))
+  end
+
   def test_batch_key
     assert_nothing_raised do
       Resque.enqueue(Job, @batch_id, 'foobar')
@@ -119,6 +127,26 @@ class BatchedJobTest < Test::Unit::TestCase
 
     assert_equal(x * y, Integer(redis.get(@batch)))
   end
+  
+  def test_remove_batched_job
+    Resque.enqueue(JobWithoutArgs, @batch_id)
+
+    assert_nothing_raised do
+      JobWithoutArgs.remove_batched_job(@batch_id)
+    end
+    assert(Job.batch_complete?(@batch_id))
+    assert_equal(false, Job.batch_exist?(@batch_id))
+    assert_equal(false, $batch_complete)
+
+    Resque.enqueue(JobWithoutArgs, @batch_id)
+    
+    assert_nothing_raised do
+      JobWithoutArgs.remove_batched_job!(@batch_id)
+    end
+    assert($batch_complete)
+    assert(Job.batch_complete?(@batch_id))
+    assert_equal(false, Job.batch_exist?(@batch_id))
+  end
 
   private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-batched-job
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000Z
+date: 2012-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70182550976360 !ruby/object:Gem::Requirement
+  requirement: &70323806805200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 1.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70182550976360
+  version_requirements: *70323806805200
 description: ! "  Resque plugin for batching jobs. When a batch/group of jobs are
   complete, \nadditional work can be performed usings batch hooks.\n"
 email: dan@dj-agiledev.com
@@ -65,3 +65,4 @@ summary: Resque plugin
 test_files:
 - test/test_batched_job.rb
 - test/test_helper.rb
+has_rdoc: