resque-batched-job 0.1.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Daniel Johnston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,33 @@
+Resque Batched Job
+==================
+
+A [Resque](http://github.com/defunkt/resque) plugin. Requires Resque 1.10.0
+
+TODO
+----
+	* Define a complete batch
+
+Example
+-------
+
+	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

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+$:.unshift(File.dirname(__FILE__))
+
+task :default => :test
+
+Rake::TestTask.new do |task|
+  task.libs << 'lib'
+  task.pattern = 'test/test_*.rb'
+  task.verbose = true
+end

data/lib/resque/plugins/batched_job.rb

@@ -0,0 +1,78 @@
+module Resque
+  
+  module Plugin
+    
+    #
+    # This hook is really the meaning of our adventure.
+    def after_batch_hooks(job)
+      job.methods.grep(/^after_batch/).sort
+    end
+    
+  end
+  
+  module Plugins
+    
+    module BatchedJob
+    
+      include Resque::Helpers
+
+      #
+      # Helper method used to generate the batch key.
+      def batch(id)
+        "batch:#{id}"
+      end
+
+      #
+      # Batch the job.  The first argument of a batched job, is the batch id.
+      def after_enqueue_batch(id, *args)
+        redis.sadd(batch(id), encode(args))
+      end
+      
+=begin
+  TODO: Determine if it's necessary to double check the jobs existance 
+    before performing it.  If so, do what?
+    
+      def before_perform_audit_batch(id, *args)
+        unless redis.sismember(batch(id), "#{encode(args)}")
+          raise Resque::Job::DontPerform.new("#{args} are not a member of #{batch(id)}")
+        end
+      end
+=end
+
+      # 
+      #   After every job, no matter in the event of success or failure, we need
+      # to remove the job from the batch set.
+      def around_perform_amend_batch(id, *args)
+        begin
+          yield
+        ensure
+          redis.srem(batch(id), "#{encode(args)}")
+        end
+      end
+
+      #
+      #   After each job is performed, check to see if the job is the last of
+      # the given batch.  If so, run after_batch hooks.
+      def after_perform_batch(id, *args)
+        if batch_complete?(id)
+          after_batch_hooks = Resque::Plugin.after_batch_hooks(self)
+          after_batch_hooks.each do |hook|
+            send(hook, id, *args)
+          end
+        end
+      end
+      
+      #
+      #   Checks to see if the batch key exists.  If the key does exist, is the 
+      # set empty?  The Redis srem command deletes the key when the last item 
+      # of a set is removed. Ah, go ahead and check the size.
+      def batch_complete?(id)
+        redis.scard(batch(id)) == 0
+      end
+      alias :batch_exist? :batch_complete? # => are they?
+      
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module BatchedJob
+      VERSION = '0.1.1'
+    end
+  end
+end

data/test/test_batched_job.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'test/unit'
+require 'rubygems'
+require 'resque'
+require 'resque/plugins/batched_job'
+
+class BatchedJobTest < Test::Unit::TestCase
+  
+  def test_list
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Plugins::BatchedJob)
+    end
+  end
+    
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: resque-batched-job
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Daniel Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-31 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 10
+        - 0
+        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"
+email: dan@dj-agiledev.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- README.markdown
+- lib/resque/plugins/batched_job.rb
+- lib/resque/plugins/batched_job/version.rb
+- test/test_batched_job.rb
+has_rdoc: true
+homepage: http://github.com/djohnston/resque-batched-job
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Resque plugin
+test_files: 
+- test/test_batched_job.rb