resque-status 0.3.2 → 0.3.3

data/README.rdoc

@@ -65,7 +65,7 @@ Resque::Plugins::Status module. An example job would look something like:
   
   end
 
-One major difference is that intead of implementing <tt>perform</tt> as a 
+One major difference is that instead of implementing <tt>perform</tt> as a 
 class method, we do our job implementation within instances of the job class.
 
 In order to queue a SleepJob up, we also won't use <tt>Resque.enqueue</tt>, instead

data/lib/resque/plugins/status.rb

@@ -28,7 +28,7 @@ module Resque
     # 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.
     module Status
-      VERSION = '0.3.2'
+      VERSION = '0.3.3'
 
       autoload :Hash, 'resque/plugins/status/hash'
 
@@ -80,11 +80,17 @@ module Resque
         end
 
         # Adds a job of type <tt>klass<tt> to the queue with <tt>options<tt>.
-        # Returns the UUID of the job
+        #
+        # Returns the UUID of the job if the job was queued, or nil if the job was
+        # rejected by a before_enqueue hook.
         def enqueue(klass, options = {})
-          uuid = Resque::Plugins::Status::Hash.create :options => options
-          Resque.enqueue(klass, uuid, options)
-          uuid
+          uuid = Resque::Plugins::Status::Hash.generate_uuid
+          if Resque.enqueue(klass, uuid, options)
+            Resque::Plugins::Status::Hash.create uuid, :options => options
+            uuid
+          else
+            nil
+          end
         end
 
         # This is the method called by Resque::Worker when processing jobs. It

data/lib/resque/plugins/status/hash.rb

@@ -11,8 +11,7 @@ module Resque
 
         # Create a status, generating a new UUID, passing the message to the status
         # Returns the UUID of the new status.
-        def self.create(*messages)
-          uuid = generate_uuid
+        def self.create(uuid, *messages)
           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
@@ -40,11 +39,22 @@ module Resque
         # about ranges
         def self.clear(range_start = nil, range_end = nil)
           status_ids(range_start, range_end).each do |id|
-            redis.del(status_key(id))
-            redis.zrem(set_key, id)
+            remove(id)
           end
         end
-
+        
+        def self.clear_completed(range_start = nil, range_end = nil)
+          status_ids(range_start, range_end).select do |id|
+            get(id).completed?
+          end.each do |id|
+            remove(id)
+          end
+        end
+        
+        def self.remove(uuid)
+          redis.del(status_key(uuid))
+          redis.zrem(set_key, uuid)
+        end
         # returns a Redisk::Logger scoped to the UUID. Any options passed are passed
         # to the logger initialization.
         #

data/lib/resque/server/views/status.erb

@@ -10,6 +10,19 @@
   </div>
   <div class="status-message"><%= @status.message %></div>
   <div class="status-time"><%= @status.time? ? @status.time : 'Not started' %></div>
+  <h2>Details</h2>
+  <div class="status-details">
+    <table>
+      <thead>
+        <tr>
+          <th>Key</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody class="status-details-body">
+      </tbody>
+    </table>
+  </div>
 </div>
 
 <script type="text/javascript" charset="utf-8">
@@ -43,6 +56,15 @@
           if (json.time) {
             $status.find('.status-time').text(new Date(json.time * 1000).toString())
           }
+
+          var $details = $status.find('.status-details-body');
+          $details.empty();
+
+          for (key in json) {
+            var $row = $("<tr>").appendTo($details);
+            $("<td>").text(key).appendTo($row);
+            $("<td>").text(printValue(key, json[key])).appendTo($row);
+          }
         };
         var status = $status.attr('rel');
         if (status == 'working' || status == 'queued' || status == "") {
@@ -53,5 +75,15 @@
       });
     };
 
+    function printValue(key, value) {
+      if (/(^|_)time$/.test(key) && typeof value == 'number') {
+        var time = new Date();
+        time.setTime(value * 1000);
+        return time.toUTCString();
+      } else {
+        return JSON.stringify(value);
+      }
+    }
+
   });
 </script>

data/lib/resque/status_server.rb

@@ -38,7 +38,7 @@ module Resque
       end
 
       app.post '/statuses/clear/completed' do
-        Resque::Status.clear_completed
+        Resque::Plugins::Status::Hash.clear_completed
         redirect u(:statuses)
       end
 

data/resque-status.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "resque-status"
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = "2012-02-03"
+  s.date = "2012-04-09"
   s.description = "resque-status is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Plugins::Status::Hash class which can set/get the statuses of jobs and a Resque::Plugins::Status class that when included provides easily trackable/killable jobs."
   s.email = "aaron@quirkey.com"
   s.extra_rdoc_files = [
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/quirkey/resque-status"
   s.require_paths = ["lib"]
   s.rubyforge_project = "quirkey"
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.16"
   s.summary = "resque-status is an extension to the resque queue system that provides simple trackable jobs."
 
   if s.respond_to? :specification_version then

data/test/test_helper.rb

@@ -98,3 +98,15 @@ class FailureJob
     failed("I'm such a failure")
   end
 end
+
+class NeverQueuedJob
+  include Resque::Plugins::Status
+
+  def self.before_enqueue(*args)
+    false
+  end
+
+  def perform
+    # will never get called
+  end
+end

data/test/test_resque_plugins_status.rb

@@ -32,6 +32,26 @@ class TestResquePluginsStatus < Test::Unit::TestCase
 
     end
 
+    context ".create with a failing before_enqueue hook" do
+      setup do
+        @size = Resque.size(:statused)
+        @status_ids_size = Resque::Plugins::Status::Hash.status_ids.length
+        @res = NeverQueuedJob.create(:num => 100)
+      end
+
+      should "return nil" do
+        assert_equal nil, @res
+      end
+
+      should "not create a status" do
+        assert_equal @size, Resque.size(:statused)
+      end
+
+      should "not add the uuid to the statuses" do
+        assert_equal @status_ids_size, Resque::Plugins::Status::Hash.status_ids.length
+      end
+    end
+
     context ".scheduled" do
       setup do
         @job_args = {'num' => 100}

data/test/test_resque_plugins_status_hash.rb

@@ -6,9 +6,9 @@ class TestResquePluginsStatusHash < Test::Unit::TestCase
     setup do
       Resque.redis.flushall
       Resque::Plugins::Status::Hash.expire_in = nil
-      @uuid = Resque::Plugins::Status::Hash.create
+      @uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
       Resque::Plugins::Status::Hash.set(@uuid, "my status")
-      @uuid_with_json = Resque::Plugins::Status::Hash.create({"im" => "json"})
+      @uuid_with_json = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, {"im" => "json"})
     end
 
     context ".get" do
@@ -43,17 +43,17 @@ class TestResquePluginsStatusHash < Test::Unit::TestCase
     context ".create" do
       should "add an item to a key set" do
         before = Resque::Plugins::Status::Hash.status_ids.length
-        Resque::Plugins::Status::Hash.create
+        Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
         after = Resque::Plugins::Status::Hash.status_ids.length
         assert_equal 1, after - before
       end
 
       should "return a uuid" do
-       assert_match(/^\w{32}$/, Resque::Plugins::Status::Hash.create)
+        assert_match(/^\w{32}$/, Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid))
       end
 
       should "store any status passed" do
-        uuid = Resque::Plugins::Status::Hash.create("initial status")
+        uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, "initial status")
         status = Resque::Plugins::Status::Hash.get(uuid)
         assert status.is_a?(Resque::Plugins::Status::Hash)
         assert_equal "initial status", status.message
@@ -61,17 +61,17 @@ class TestResquePluginsStatusHash < Test::Unit::TestCase
 
       should "expire keys if expire_in is set" do
         Resque::Plugins::Status::Hash.expire_in = 1
-        uuid = Resque::Plugins::Status::Hash.create("new status")
+        uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, "new status")
         assert_contains Resque::Plugins::Status::Hash.status_ids, uuid
         assert_equal "new status", Resque::Plugins::Status::Hash.get(uuid).message
         sleep 2
-        Resque::Plugins::Status::Hash.create
+        Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
         assert_does_not_contain Resque::Plugins::Status::Hash.status_ids, uuid
         assert_nil Resque::Plugins::Status::Hash.get(uuid)
       end
 
       should "store the options for the job created" do
-        uuid = Resque::Plugins::Status::Hash.create("new", :options => {'test' => '123'})
+        uuid = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, "new", :options => {'test' => '123'})
         assert uuid
         status = Resque::Plugins::Status::Hash.get(uuid)
         assert status.is_a?(Resque::Plugins::Status::Hash)
@@ -94,11 +94,38 @@ class TestResquePluginsStatusHash < Test::Unit::TestCase
 
     end
 
+    context ".clear_completed" do
+      setup do
+        @completed_status_id = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid, {'status' => "completed"})
+        @not_completed_status_id = Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid)
+        Resque::Plugins::Status::Hash.clear_completed
+      end
+      
+      should "clear completed status" do
+        assert_nil Resque::Plugins::Status::Hash.get(@completed_status_id)
+      end
+      
+      should "not clear not-completed status" do
+        status = Resque::Plugins::Status::Hash.get(@not_completed_status_id)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+      end
+    end
+    
+    context ".remove" do
+      setup do
+        Resque::Plugins::Status::Hash.remove(@uuid)
+      end
+      
+      should "clear specify status" do
+        assert_nil Resque::Plugins::Status::Hash.get(@uuid)
+      end
+    end
+
     context ".status_ids" do
 
       setup do
         @uuids = []
-        30.times{ Resque::Plugins::Status::Hash.create }
+        30.times{ Resque::Plugins::Status::Hash.create(Resque::Plugins::Status::Hash.generate_uuid) }
       end
 
       should "return an array of job ids" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-status
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-03 00:00:00.000000000Z
+date: 2012-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redisk
-  requirement: &70279646686820 !ruby/object:Gem::Requirement
+  requirement: &70186170509920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70279646686820
+  version_requirements: *70186170509920
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70279646686000 !ruby/object:Gem::Requirement
+  requirement: &70186170509260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.19'
   type: :runtime
   prerelease: false
-  version_requirements: *70279646686000
+  version_requirements: *70186170509260
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70279646685180 !ruby/object:Gem::Requirement
+  requirement: &70186170508780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70279646685180
+  version_requirements: *70186170508780
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70279646684320 !ruby/object:Gem::Requirement
+  requirement: &70186170508220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279646684320
+  version_requirements: *70186170508220
 description: resque-status is an extension to the resque queue system that provides
   simple trackable jobs. It provides a Resque::Plugins::Status::Hash class which can
   set/get the statuses of jobs and a Resque::Plugins::Status class that when included
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: quirkey
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: resque-status is an extension to the resque queue system that provides simple