resque-status 0.2.1 → 0.2.2

data/lib/resque/job_with_status.rb

@@ -1,18 +1,18 @@
 require 'resque/status'
 
 module Resque
-  
+
   # JobWithStatus is a base class that you're jobs will inherit from.
-  # It provides helper methods for updating the status/etc from within an 
+  # It provides helper methods for updating the status/etc from within an
   # instance as well as class methods for creating and queuing the jobs.
-  # 
+  #
   # All you have to do to get this functionality is inherit from JobWithStatus
   # and then implement a <tt>perform<tt> method.
-  # 
+  #
   # For example:
-  # 
+  #
   #       class ExampleJob < Resque::JobWithStatus
-  #         
+  #
   #         def perform
   #           num = options['num']
   #           i = 0
@@ -22,62 +22,62 @@ module Resque
   #           end
   #           completed("Finished!")
   #         end
-  #         
+  #
   #       end
-  #       
+  #
   # This job would iterate num times updating the status as it goes. At the end
   # we update the status telling anyone listening to this job that its complete.
   class JobWithStatus
-    
+
     # The error class raised when a job is killed
     class Killed < RuntimeError; end
-    
+
     attr_reader :uuid, :options
-    
+
     # The default queue is :statused, this can be ovveridden in the specific job
     # class to put the jobs on a specific worker queue
     def self.queue
       :statused
     end
-    
+
     # used when displaying the Job in the resque-web UI and identifiyng the job
     # type by status. By default this is the name of the job class, but can be
-    # ovveridden in the specific job class to present a more user friendly job 
+    # ovveridden in the specific job class to present a more user friendly job
     # name
     def self.name
       self.to_s
     end
-    
-    # Create is the primary method for adding jobs to the queue. This would be 
+
+    # Create is the primary method for adding jobs to the queue. This would be
     # called on the job class to create a job of that type. Any options passed are
     # passed to the Job instance as a hash of options. It returns the UUID of the
     # job.
     #
     # == Example:
-    #       
+    #
     #       class ExampleJob < Resque::JobWithStatus
-    #         
+    #
     #         def perform
     #           set_status "Hey I'm a job num #{options['num']}"
     #         end
-    #         
+    #
     #       end
-    #       
+    #
     #       job_id = ExampleJob.create(:num => 100)
-    #       
+    #
     def self.create(options = {})
       self.enqueue(self, options)
     end
-    
+
     # Adds a job of type <tt>klass<tt> to the queue with <tt>options<tt>.
     # Returns the UUID of the job
     def self.enqueue(klass, options = {})
-      uuid = Resque::Status.create
+      uuid = Resque::Status.create :options => options
       Resque.enqueue(klass, uuid, options)
       uuid
     end
 
-    # This is the method called by Resque::Worker when processing jobs. It 
+    # This is the method called by Resque::Worker when processing jobs. It
     # creates a new instance of the job class and populates it with the uuid and
     # options.
     #
@@ -88,7 +88,7 @@ module Resque
       instance.safe_perform!
       instance
     end
-    
+
     # Wrapper API to forward a Resque::Job creation API call into a JobWithStatus call.
     # This is needed to be used with resque scheduler
     # http://github.com/bvandenbos/resque-scheduler
@@ -101,10 +101,10 @@ module Resque
       @uuid    = uuid
       @options = options
     end
-    
+
     # Run by the Resque::Worker when processing this job. It wraps the <tt>perform</tt>
     # method ensuring that the final status of the job is set regardless of error.
-    # If an error occurs within the job's work, it will set the status as failed and 
+    # If an error occurs within the job's work, it will set the status as failed and
     # re-raise the error.
     def safe_perform!
       set_status({'status' => 'working'})
@@ -135,14 +135,14 @@ module Resque
     def status=(new_status)
       Resque::Status.set(uuid, *new_status)
     end
-    
+
     # get the Resque::Status object for the current uuid
     def status
       Resque::Status.get(uuid)
     end
 
     def name
-      self.class.name
+      "#{self.class.name}(#{options unless options.empty?})"
     end
 
     # Checks against the kill list if this specific job instance should be killed
@@ -151,31 +151,31 @@ module Resque
       Resque::Status.should_kill?(uuid)
     end
 
-    # set the status of the job for the current itteration. <tt>num</tt> and 
-    # <tt>total</tt> are passed to the status as well as any messages. 
-    # This will kill the job if it has been added to the kill list with 
+    # set the status of the job for the current itteration. <tt>num</tt> and
+    # <tt>total</tt> are passed to the status as well as any messages.
+    # This will kill the job if it has been added to the kill list with
     # <tt>Resque::Status.kill()</tt>
     def at(num, total, *messages)
       tick({
-        'num' => num, 
+        'num' => num,
         'total' => total
       }, *messages)
     end
-    
-    # sets the status of the job for the current itteration. You should use 
+
+    # sets the status of the job for the current itteration. You should use
     # the <tt>at</tt> method if you have actual numbers to track the iteration count.
-    # This will kill the job if it has been added to the kill list with 
+    # This will kill the job if it has been added to the kill list with
     # <tt>Resque::Status.kill()</tt>
     def tick(*messages)
       kill! if should_kill?
       set_status({'status' => 'working'}, *messages)
     end
-    
+
     # set the status to 'failed' passing along any additional messages
     def failed(*messages)
       set_status({'status' => 'failed'}, *messages)
     end
-    
+
     # set the status to 'completed' passing along any addional messages
     def completed(*messages)
       set_status({
@@ -183,7 +183,7 @@ module Resque
         'message' => "Completed at #{Time.now}"
       }, *messages)
     end
-        
+
     # kill the current job, setting the status to 'killed' and raising <tt>Killed</tt>
     def kill!
       set_status({
@@ -192,11 +192,11 @@ module Resque
       })
       raise Killed
     end
-    
+
     private
     def set_status(*args)
       self.status = [status, {'name'  => self.name}, args].flatten
     end
-    
+
   end
-end
+end

data/lib/resque/status.rb

@@ -7,15 +7,15 @@ module Resque
   # the common status attributes. It also has a number of class methods for
   # creating/updating/retrieving status objects from Redis
   class Status < Hash
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
 
     extend Resque::Helpers
 
     # Create a status, generating a new UUID, passing the message to the status
     # Returns the UUID of the new status.
-    def self.create(message = nil)
+    def self.create(*messages)
       uuid = generate_uuid
-      set(uuid, message)
+      set(uuid, *messages)
       redis.zadd(set_key, Time.now.to_i, uuid)
       redis.zremrangebyscore(set_key, 0, Time.now.to_i - @expire_in) if @expire_in
       uuid
@@ -172,6 +172,7 @@ module Resque
     hash_accessor :status
     hash_accessor :message
     hash_accessor :time
+    hash_accessor :options
 
     hash_accessor :num
     hash_accessor :total

data/resque-status.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-status}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = %q{2011-01-14}
+  s.date = %q{2011-02-09}
   s.description = %q{resque-status is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Status class which can set/get the statuses of jobs and a Resque::JobWithStatus class that when subclassed provides easily trackable/killable jobs.}
   s.email = %q{aaron@quirkey.com}
   s.extra_rdoc_files = [

data/test/redis-test.conf

@@ -128,5 +128,3 @@ glueoutputbuf yes
 # WARNING: object sharing is experimental, don't enable this feature
 # in production before of Redis 1.0-stable. Still please try this feature in
 # your development environment so that we can test it better.
-shareobjects no
-shareobjectspoolsize 1024

data/test/test_resque-job_with_status.rb

@@ -1,87 +1,87 @@
 require 'test_helper'
 
 class TestResqueJobWithStatus < Test::Unit::TestCase
-  
+
   context "Resque::JobWithStatus" do
     setup do
       Resque.redis.flushall
     end
-    
+
     context ".create" do
       setup do
         @uuid = WorkingJob.create('num' => 100)
       end
-      
+
       should "add the job to the queue" do
         assert_equal 1, Resque.size(:statused)
       end
-      
+
       should "set the queued object to the current class" do
         job = Resque.pop(:statused)
         assert_equal @uuid, job['args'].first
         assert_equal "WorkingJob", job['class']
       end
-      
+
       should "add the uuid to the statuses" do
         assert_contains Resque::Status.status_ids, @uuid
       end
-      
+
       should "return a UUID" do
         assert_match(/^\w{32}$/, @uuid)
       end
-      
+
     end
-    
+
     context ".enqueue" do
       setup do
         @uuid = Resque::JobWithStatus.enqueue(WorkingJob, :num => 100)
         @payload = Resque.pop(:statused)
       end
-      
+
       should "add the job with the specific class to the queue" do
         assert_equal "WorkingJob", @payload['class']
       end
-      
+
       should "add the arguments to the options hash" do
         assert_equal @uuid, @payload['args'].first
       end
-      
+
       should "add the uuid to the statuses" do
         assert_contains Resque::Status.status_ids, @uuid
       end
-      
+
       should "return UUID" do
         assert_match(/^\w{32}$/, @uuid)
       end
-      
+
     end
-    
+
     context ".perform" do
       setup do
         @uuid      = WorkingJob.create(:num => 100)
         @payload   = Resque.pop(:statused)
         @performed = WorkingJob.perform(*@payload['args'])
       end
-      
+
       should "load load a new instance of the klass" do
         assert @performed.is_a?(WorkingJob)
       end
-      
+
       should "set the uuid" do
         assert_equal @uuid, @performed.uuid
       end
-      
+
       should "set the status" do
         assert @performed.status.is_a?(Resque::Status)
-        assert_equal 'WorkingJob', @performed.status.name
+        assert_equal 'WorkingJob({"num"=>100})', @performed.status.name
       end
-      
+
       before_should "call perform on the inherited class" do
         WorkingJob.any_instance.expects(:perform).once
       end
-      
+
     end
-    
+
     context "killing a job" do
       setup do
         @uuid      = KillableJob.create(:num => 100)
@@ -91,74 +91,74 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
         @performed = KillableJob.perform(*@payload['args'])
         @status = Resque::Status.get(@uuid)
       end
-      
+
       should "set the status to killed" do
         assert_equal 'killed', @status.status
         assert @status.killed?
         assert !@status.completed?
       end
-      
+
       should "only perform iterations up to kill" do
         assert_equal 1, Resque.redis.get("#{@uuid}:iterations").to_i
       end
-      
+
       should "not persist the kill key" do
         assert_does_not_contain Resque::Status.kill_ids, @uuid
       end
     end
-    
+
     context "with an invoked job" do
       setup do
         @job = WorkingJob.new('123', {'num' => 100})
       end
-            
+
       context "#at" do
         setup do
           @job.at(50, 100, "At 50%")
         end
-        
+
         should "calculate percent" do
           assert_equal 50, @job.status.pct_complete
         end
-        
+
         should "set status" do
           assert_equal 'working', @job.status.status
         end
-        
+
         should "save message" do
           assert_equal "At 50%", @job.status.message
         end
       end
-      
+
       context "#failed" do
         setup do
           @job.failed("OOOOPS!")
         end
-        
+
         should "set status" do
           assert_equal 'failed', @job.status.status
         end
-        
+
         should "set message" do
           assert_equal "OOOOPS!", @job.status.message
         end
       end
-      
+
       context "#completed" do
         setup do
           @job.completed
         end
-        
+
         should "set status" do
           assert_equal 'completed', @job.status.status
         end
-        
+
         should "set message" do
           assert_match(/complete/i, @job.status.message)
         end
-        
+
       end
-      
+
       context "#safe_perform!" do
         setup do
           @job = ErrorJob.new("123")
@@ -166,15 +166,15 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
             @job.safe_perform!
           end
         end
-                
+
         should "set status as failed" do
           assert_equal 'failed', @job.status.status
         end
-        
+
       end
-      
+
     end
-    
+
   end
-  
-end
+
+end

data/test/test_resque-status.rb

@@ -10,36 +10,36 @@ class TestResqueStatus < Test::Unit::TestCase
       Resque::Status.set(@uuid, "my status")
       @uuid_with_json = Resque::Status.create({"im" => "json"})
     end
-    
-    context ".get" do 
+
+    context ".get" do
       should "return the status as a Resque::Status for the uuid" do
         status = Resque::Status.get(@uuid)
         assert status.is_a?(Resque::Status)
         assert_equal 'my status', status.message
       end
-      
+
       should "return false if the status is not set" do
         assert !Resque::Status.get('whu')
       end
-      
+
       should "decode encoded json" do
         assert_equal("json", Resque::Status.get(@uuid_with_json)['im'])
       end
     end
-    
+
     context ".set" do
-        
+
       should "set the status for the uuid" do
         assert Resque::Status.set(@uuid, "updated")
         assert_equal "updated", Resque::Status.get(@uuid).message
       end
-      
+
       should "return the status" do
         assert Resque::Status.set(@uuid, "updated").is_a?(Resque::Status)
       end
-                  
+
     end
-    
+
     context ".create" do
       should "add an item to a key set" do
         before = Resque::Status.status_ids.length
@@ -47,18 +47,18 @@ class TestResqueStatus < Test::Unit::TestCase
         after = Resque::Status.status_ids.length
         assert_equal 1, after - before
       end
-      
+
       should "return a uuid" do
        assert_match(/^\w{32}$/, Resque::Status.create)
       end
-      
+
       should "store any status passed" do
         uuid = Resque::Status.create("initial status")
         status = Resque::Status.get(uuid)
         assert status.is_a?(Resque::Status)
         assert_equal "initial status", status.message
       end
-      
+
       should "expire keys if expire_in is set" do
         Resque::Status.expire_in = 1
         uuid = Resque::Status.create("new status")
@@ -69,77 +69,85 @@ class TestResqueStatus < Test::Unit::TestCase
         assert_does_not_contain Resque::Status.status_ids, uuid
         assert_nil Resque::Status.get(uuid)
       end
+
+      should "store the options for the job created" do
+        uuid = Resque::Status.create("new", :options => {'test' => '123'})
+        assert uuid
+        status = Resque::Status.get(uuid)
+        assert status.is_a?(Resque::Status)
+        assert_equal '123', status.options['test']
+      end
     end
-    
+
     context ".clear" do
       setup do
         Resque::Status.clear
       end
-      
+
       should "clear any statuses" do
         assert_nil Resque::Status.get(@uuid)
       end
-      
+
       should "clear any recent statuses" do
         assert Resque::Status.status_ids.empty?
       end
-      
+
     end
-    
+
     context ".status_ids" do
-      
+
       setup do
         @uuids = []
         30.times{ Resque::Status.create }
       end
-    
+
       should "return an array of job ids" do
         assert Resque::Status.status_ids.is_a?(Array)
         assert_equal 32, Resque::Status.status_ids.size # 30 + 2
       end
-      
+
       should "let you paginate through the statuses" do
         assert_equal Resque::Status.status_ids.reverse[0, 10], Resque::Status.status_ids(0, 10)
         assert_equal Resque::Status.status_ids.reverse[9, 10], Resque::Status.status_ids(10, 20)
         # assert_equal Resque::Status.status_ids.reverse[0, 10], Resque::Status.status_ids(0, 10)
       end
     end
-    
+
     context ".statuses" do
-      
+
       should "return an array status objects" do
         statuses = Resque::Status.statuses
         assert statuses.is_a?(Array)
         assert_same_elements [@uuid_with_json, @uuid], statuses.collect {|s| s.uuid }
       end
-      
+
     end
-    
+
     # context ".count" do
-    #   
+    #
     #   should "return a count of statuses" do
     #     statuses = Resque::Status.statuses
     #     assert_equal 2, statuses.size
     #     assert_equal statuses.size, Resque::Status.count
     #   end
-    #   
+    #
     # end
-    
+
     context ".logger" do
       setup do
         @logger = Resque::Status.logger(@uuid)
       end
-      
+
       should "return a redisk logger" do
         assert @logger.is_a?(Redisk::Logger)
       end
-      
+
       should "scope the logger to a key" do
         assert_match(/#{@uuid}/, @logger.name)
       end
-      
+
     end
-    
+
   end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Aaron Quint
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-14 00:00:00 -08:00
+date: 2011-02-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency