resque-status 0.2.4 → 0.3.0

data/test/test_helper.rb

@@ -6,8 +6,7 @@ require 'rubygems'
 require 'shoulda'
 require 'mocha'
 
-require 'resque/status'
-require 'resque/job_with_status'
+require 'resque-status'
 
 class Test::Unit::TestCase
 end
@@ -45,12 +44,14 @@ end
 
 puts "Starting redis for testing at localhost:9736..."
 `redis-server #{dir}/redis-test.conf`
-Resque.redis = 'localhost:9736'
-Redisk.redis = 'localhost:9736'
+Resque.redis = 'localhost:9736/1'
+Redisk.redis = 'localhost:9736/1'
 
 #### Fixtures
 
-class WorkingJob < Resque::JobWithStatus
+class WorkingJob
+
+  include Resque::Plugins::Status
 
   def perform
     total = options['num']
@@ -61,7 +62,9 @@ class WorkingJob < Resque::JobWithStatus
 
 end
 
-class ErrorJob < Resque::JobWithStatus
+class ErrorJob
+
+  include Resque::Plugins::Status
 
   def perform
     raise "I'm a bad little job"
@@ -69,7 +72,9 @@ class ErrorJob < Resque::JobWithStatus
 
 end
 
-class KillableJob < Resque::JobWithStatus
+class KillableJob
+
+  include Resque::Plugins::Status
 
   def perform
     Resque.redis.set("#{uuid}:iterations", 0)
@@ -80,3 +85,7 @@ class KillableJob < Resque::JobWithStatus
   end
 
 end
+
+class BasicJob
+  include Resque::Plugins::Status
+end

data/test/{test_resque-job_with_status.rb → test_resque_plugins_status.rb}

@@ -1,8 +1,8 @@
 require 'test_helper'
 
-class TestResqueJobWithStatus < Test::Unit::TestCase
+class TestResquePluginsStatus < Test::Unit::TestCase
 
-  context "Resque::JobWithStatus" do
+  context "Resque::Plugins::Status" do
     setup do
       Resque.redis.flushall
     end
@@ -23,7 +23,7 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
       end
 
       should "add the uuid to the statuses" do
-        assert_contains Resque::Status.status_ids, @uuid
+        assert_contains Resque::Plugins::Status::Hash.status_ids, @uuid
       end
 
       should "return a UUID" do
@@ -48,7 +48,7 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
 
     context ".enqueue" do
       setup do
-        @uuid = Resque::JobWithStatus.enqueue(WorkingJob, :num => 100)
+        @uuid = BasicJob.enqueue(WorkingJob, :num => 100)
         @payload = Resque.pop(:statused)
       end
 
@@ -61,7 +61,7 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
       end
 
       should "add the uuid to the statuses" do
-        assert_contains Resque::Status.status_ids, @uuid
+        assert_contains Resque::Plugins::Status::Hash.status_ids, @uuid
       end
 
       should "return UUID" do
@@ -86,7 +86,7 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
       end
 
       should "set the status" do
-        assert @performed.status.is_a?(Resque::Status)
+        assert @performed.status.is_a?(Resque::Plugins::Status::Hash)
         assert_equal 'WorkingJob({"num"=>100})', @performed.status.name
       end
 
@@ -100,10 +100,10 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
       setup do
         @uuid      = KillableJob.create(:num => 100)
         @payload   = Resque.pop(:statused)
-        Resque::Status.kill(@uuid)
-        assert_contains Resque::Status.kill_ids, @uuid
+        Resque::Plugins::Status::Hash.kill(@uuid)
+        assert_contains Resque::Plugins::Status::Hash.kill_ids, @uuid
         @performed = KillableJob.perform(*@payload['args'])
-        @status = Resque::Status.get(@uuid)
+        @status = Resque::Plugins::Status::Hash.get(@uuid)
       end
 
       should "set the status to killed" do
@@ -117,10 +117,94 @@ class TestResqueJobWithStatus < Test::Unit::TestCase
       end
 
       should "not persist the kill key" do
-        assert_does_not_contain Resque::Status.kill_ids, @uuid
+        assert_does_not_contain Resque::Plugins::Status::Hash.kill_ids, @uuid
       end
     end
 
+    context "killing all jobs" do
+      setup do
+        @uuid1    = KillableJob.create(:num => 100)
+        @uuid2    = KillableJob.create(:num => 100)
+
+        Resque::Status.killall
+
+        assert_contains Resque::Status.kill_ids, @uuid1
+        assert_contains Resque::Status.kill_ids, @uuid2
+
+        @payload1   = Resque.pop(:statused)
+        @payload2   = Resque.pop(:statused)
+
+        @performed = KillableJob.perform(*@payload1['args'])
+        @performed = KillableJob.perform(*@payload2['args'])
+
+        @status1 = Resque::Status.get(@uuid1)
+        @status2 = Resque::Status.get(@uuid2)
+      end
+
+      should "set the status to killed" do
+        assert_equal 'killed', @status1.status
+        assert @status1.killed?
+        assert !@status1.completed?
+
+        assert_equal 'killed', @status2.status
+        assert @status2.killed?
+        assert !@status2.completed?
+      end
+
+      should "only perform iterations up to kill" do
+        assert_equal 1, Resque.redis.get("#{@uuid1}:iterations").to_i
+        assert_equal 1, Resque.redis.get("#{@uuid2}:iterations").to_i
+      end
+
+      should "not persist the kill key" do
+        assert_does_not_contain Resque::Status.kill_ids, @uuid1
+        assert_does_not_contain Resque::Status.kill_ids, @uuid2
+      end
+
+    end
+
+    context "invoking killall jobs to kill a range" do
+      setup do
+        @uuid1    = KillableJob.create(:num => 100)
+        @uuid2    = KillableJob.create(:num => 100)
+
+        Resque::Status.killall(0,0) # only @uuid2 should be killed
+
+        assert_does_not_contain Resque::Status.kill_ids, @uuid1
+        assert_contains Resque::Status.kill_ids, @uuid2
+
+        @payload1   = Resque.pop(:statused)
+        @payload2   = Resque.pop(:statused)
+
+        @performed = KillableJob.perform(*@payload1['args'])
+        @performed = KillableJob.perform(*@payload2['args'])
+
+        @status1 = Resque::Status.get(@uuid1)
+        @status2 = Resque::Status.get(@uuid2)
+      end
+
+      should "set the status to killed" do
+        assert_equal 'completed', @status1.status
+        assert !@status1.killed?
+        assert @status1.completed?
+
+        assert_equal 'killed', @status2.status
+        assert @status2.killed?
+        assert !@status2.completed?
+      end
+
+      should "only perform iterations up to kill" do
+        assert_equal 100, Resque.redis.get("#{@uuid1}:iterations").to_i
+        assert_equal 1, Resque.redis.get("#{@uuid2}:iterations").to_i
+      end
+
+      should "not persist the kill key" do
+        assert_does_not_contain Resque::Status.kill_ids, @uuid1
+        assert_does_not_contain Resque::Status.kill_ids, @uuid2
+      end
+
+    end
+
     context "with an invoked job" do
       setup do
         @job = WorkingJob.new('123', {'num' => 100})

data/test/test_resque_plugins_status_hash.rb

@@ -0,0 +1,153 @@
+require 'test_helper'
+
+class TestResquePluginsStatusHash < Test::Unit::TestCase
+
+  context "Resque::Plugins::Status::Hash" do
+    setup do
+      Resque.redis.flushall
+      Resque::Plugins::Status::Hash.expire_in = nil
+      @uuid = Resque::Plugins::Status::Hash.create
+      Resque::Plugins::Status::Hash.set(@uuid, "my status")
+      @uuid_with_json = Resque::Plugins::Status::Hash.create({"im" => "json"})
+    end
+
+    context ".get" do
+      should "return the status as a Resque::Plugins::Status::Hash for the uuid" do
+        status = Resque::Plugins::Status::Hash.get(@uuid)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal 'my status', status.message
+      end
+
+      should "return false if the status is not set" do
+        assert !Resque::Plugins::Status::Hash.get('whu')
+      end
+
+      should "decode encoded json" do
+        assert_equal("json", Resque::Plugins::Status::Hash.get(@uuid_with_json)['im'])
+      end
+    end
+
+    context ".set" do
+
+      should "set the status for the uuid" do
+        assert Resque::Plugins::Status::Hash.set(@uuid, "updated")
+        assert_equal "updated", Resque::Plugins::Status::Hash.get(@uuid).message
+      end
+
+      should "return the status" do
+        assert Resque::Plugins::Status::Hash.set(@uuid, "updated").is_a?(Resque::Plugins::Status::Hash)
+      end
+
+    end
+
+    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
+        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)
+      end
+
+      should "store any status passed" do
+        uuid = Resque::Plugins::Status::Hash.create("initial status")
+        status = Resque::Plugins::Status::Hash.get(uuid)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal "initial status", status.message
+      end
+
+      should "expire keys if expire_in is set" do
+        Resque::Plugins::Status::Hash.expire_in = 1
+        uuid = Resque::Plugins::Status::Hash.create("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
+        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'})
+        assert uuid
+        status = Resque::Plugins::Status::Hash.get(uuid)
+        assert status.is_a?(Resque::Plugins::Status::Hash)
+        assert_equal '123', status.options['test']
+      end
+    end
+
+    context ".clear" do
+      setup do
+        Resque::Plugins::Status::Hash.clear
+      end
+
+      should "clear any statuses" do
+        assert_nil Resque::Plugins::Status::Hash.get(@uuid)
+      end
+
+      should "clear any recent statuses" do
+        assert Resque::Plugins::Status::Hash.status_ids.empty?
+      end
+
+    end
+
+    context ".status_ids" do
+
+      setup do
+        @uuids = []
+        30.times{ Resque::Plugins::Status::Hash.create }
+      end
+
+      should "return an array of job ids" do
+        assert Resque::Plugins::Status::Hash.status_ids.is_a?(Array)
+        assert_equal 32, Resque::Plugins::Status::Hash.status_ids.size # 30 + 2
+      end
+
+      should "let you paginate through the statuses" do
+        assert_equal Resque::Plugins::Status::Hash.status_ids[0, 10], Resque::Plugins::Status::Hash.status_ids(0, 9)
+        assert_equal Resque::Plugins::Status::Hash.status_ids[10, 10], Resque::Plugins::Status::Hash.status_ids(10, 19)
+        # assert_equal Resque::Plugins::Status::Hash.status_ids.reverse[0, 10], Resque::Plugins::Status::Hash.status_ids(0, 10)
+      end
+    end
+
+    context ".statuses" do
+
+      should "return an array status objects" do
+        statuses = Resque::Plugins::Status::Hash.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::Plugins::Status::Hash.statuses
+    #     assert_equal 2, statuses.size
+    #     assert_equal statuses.size, Resque::Plugins::Status::Hash.count
+    #   end
+    #
+    # end
+
+    context ".logger" do
+      setup do
+        @logger = Resque::Plugins::Status::Hash.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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-status
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,77 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-10 00:00:00.000000000 -07:00
-default_executable: 
+date: 2012-01-22 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redisk
+  requirement: &70167507502960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167507502960
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70167507502380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167507502380
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: &70167507501840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167507501840
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70167507501300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167507501300
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70167507500760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167507500760
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70167507500200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167507500200
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &2169498020 !ruby/object:Gem::Requirement
+  requirement: &70167507499640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +87,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2169498020
+  version_requirements: *70167507499640
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &2169496540 !ruby/object:Gem::Requirement
+  requirement: &70167507499060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +98,10 @@ dependencies:
         version: 1.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *2169496540
+  version_requirements: *70167507499060
 - !ruby/object:Gem::Dependency
   name: redisk
-  requirement: &2169495360 !ruby/object:Gem::Requirement
+  requirement: &70167507496920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +109,10 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2169495360
+  version_requirements: *70167507496920
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2169493900 !ruby/object:Gem::Requirement
+  requirement: &70167507496200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +120,10 @@ dependencies:
         version: 2.10.2
   type: :development
   prerelease: false
-  version_requirements: *2169493900
+  version_requirements: *70167507496200
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2169493000 !ruby/object:Gem::Requirement
+  requirement: &70167507495300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,11 +131,11 @@ dependencies:
         version: 0.9.8
   type: :development
   prerelease: false
-  version_requirements: *2169493000
+  version_requirements: *70167507495300
 description: 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.
+  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.
 email: aaron@quirkey.com
 executables: []
 extensions: []
@@ -79,12 +144,17 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
 - examples/sleep_job.rb
 - init.rb
+- lib/resque-status.rb
 - lib/resque/job_with_status.rb
+- lib/resque/plugins/status.rb
+- lib/resque/plugins/status/hash.rb
 - lib/resque/server/views/status.erb
 - lib/resque/server/views/status_styles.erb
 - lib/resque/server/views/statuses.erb
@@ -93,9 +163,8 @@ files:
 - resque-status.gemspec
 - test/redis-test.conf
 - test/test_helper.rb
-- test/test_resque-job_with_status.rb
-- test/test_resque-status.rb
-has_rdoc: true
+- test/test_resque_plugins_status.rb
+- test/test_resque_plugins_status_hash.rb
 homepage: http://github.com/quirkey/resque-status
 licenses: []
 post_install_message: 
@@ -116,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: quirkey
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: resque-status is an extension to the resque queue system that provides simple