boss_queue 0.5.0 → 0.5.1

data/README.md

@@ -67,10 +67,16 @@ Usage
     myobject = MyClass.new
     # default failure action is 'retry' which retries up to four times
     queue = BossQueue.new(:failure_action => 'none', :queue => 'emails')
+
     # or we can set up a callback method to be called on the enqueued class / object
     # when there is a failure
     queue = BossQueue.new(:failure_action => 'callback', :failure_callback => :method_to_execute_on_failure, :queue => 'emails')
 
+    # by default, BossQueue will record a failed job if the target cannot be found
+    # when the background job runs; the job can be deleted instead by including a
+    # :delete_if_target_missing => true option
+    queue = BossQueue.new(:delete_if_target_missing => true, :queue => 'emails')
+
     # can enqueue instance methods (assumes that objects have an id and a #find(id) method)
     queue.enqueue(myobject, :method_to_execute, arg1, arg2)
     # enqueue with a delay of up to 900 seconds (15 minutes)

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/boss_queue.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "boss_queue"
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Nelson"]

data/lib/boss_queue/boss_queue.rb

@@ -6,6 +6,7 @@ class BossQueue
   def initialize(options={})
     @failure_action = options[:failure_action] if options[:failure_action]
     @failure_callback = options[:failure_callback] if options[:failure_callback]
+    @delete_if_target_missing = options[:delete_if_target_missing] if options[:delete_if_target_missing]
     @queue_postfix = options[:queue] ? '_' + options[:queue] : ''
   end
 
@@ -21,6 +22,10 @@ class BossQueue
     @failure_callback
   end
 
+  def delete_if_target_missing
+    @delete_if_target_missing
+  end
+
   def table_name
     "#{BossQueue.queue_prefix}boss_queue_jobs"
   end
@@ -84,6 +89,7 @@ class BossQueue
     job.queue_name = queue_name
     job.failure_action = failure_action
     job.failure_callback = failure_callback.to_s if failure_action == 'callback' && failure_callback
+    job.delete_if_target_missing = delete_if_target_missing if delete_if_target_missing
     job.model_class_name = class_name
     job.model_id = instance_id unless instance_id.nil?
     job.callback = callback_method.to_s

data/spec/boss_queue_spec.rb

@@ -7,6 +7,7 @@ describe "BossQueue module" do
     BossQueue::Job.any_instance.stub(:queue_name=)
     BossQueue::Job.any_instance.stub(:failure_action=)
     BossQueue::Job.any_instance.stub(:failure_callback=)
+    BossQueue::Job.any_instance.stub(:delete_if_target_missing=)
     BossQueue::Job.any_instance.stub(:model_class_name=)
     BossQueue::Job.any_instance.stub(:model_id=)
     BossQueue::Job.any_instance.stub(:callback=)
@@ -182,6 +183,14 @@ describe "BossQueue module" do
       end
     end
 
+    context "when delete_if_target_missing option is true" do
+      it "should set delete_if_target_missing on the job" do
+        queue = BossQueue.new(:delete_if_target_missing => true)
+        BossQueue::Job.any_instance.should_receive(:delete_if_target_missing=).with(true)
+        queue.enqueue(TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+      end
+    end
+
   end
 
   describe "#enqueue_with_delay" do
@@ -228,6 +237,14 @@ describe "BossQueue module" do
       end
     end
 
+    context "when delete_if_target_missing option is true" do
+      it "should set delete_if_target_missing on the job" do
+        queue = BossQueue.new(:delete_if_target_missing => true)
+        BossQueue::Job.any_instance.should_receive(:delete_if_target_missing=).with(true)
+        queue.enqueue_with_delay(60, TestClass, :test_class_method, 'a', 'b', { 'c' => 2, 'd' => 1 })
+      end
+    end
+
   end
 
   describe "#work" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boss_queue
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3544343806450601850
+      hash: -3393921957837666108
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: