dalliance 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44670798d69664a8f7aeffb94d263c695dba015a2104fbad66897fc9ac4cad43
-  data.tar.gz: 9e0c8a2cedbc449b693646332bb0cc6fc7dde070049d1baebaca6d2212f858e1
+  metadata.gz: 17d8f3041b798bd3d9ecffe845c0448716006fa138b2f287e2b6bf9d23398de6
+  data.tar.gz: 93e622fd2d04e5bca69d186921e7c37c458a7939a7264737ecb025949af2f61a
 SHA512:
-  metadata.gz: c4017905c2346ffd4356a459ed24b0ab434285b5e20e001cb4f03c3a8775647b37afbbf67dd29820e92976b4f4293d36f6eb05bd1a3d3f98feca21f0b6684074
-  data.tar.gz: b8a209af9448798a5d32210b7d9cfaa9c6395bea5ec579b0792ffc0fe4e8f04fbfa688c763f5d4f59e781d0b4b1efcbac6139d5cf3e412a54229c79589e2900c
+  metadata.gz: 5c6c450cce286913f4ff051ebe7cbdc2f3d6f7fc3035609e3feb83d86dc3b6e3c1d05156016ca60106e9f6ed9186735081e6ed0808c7d4908c3970277a529e54
+  data.tar.gz: 1538a6fdc3c75bb24e13ab63e2da7135c40ec74295e15b827b3045c966e5e97acf2e7d1d4db92af7c1ada1e969c54a32740d178c0ef8d80817386640fcc5b590

data/Appraisals

@@ -12,4 +12,8 @@ end
 
 appraise "rails-6.0" do
   gem "rails", "~> 6.0.0"
+end
+
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1.0"
 end

data/config/locales/en.yml

@@ -8,6 +8,8 @@ en:
           validation_error: Validation Error
           processing_error: Processing Error
           completed: Completed
+          cancel_requested: Cancellation Requested
+          cancelled: Cancelled
   attributes:
     dalliance_status: Status
     dalliance_error_hash: Errors

data/dalliance.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency('rails', '>= 5.0', "< 6.1")
+  s.add_dependency('rails', '>= 5.0', "< 6.2")
 
   s.add_dependency('state_machine')
 

data/gemfiles/rails_5.0.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    dalliance (0.7.0)
-      rails (>= 5.0, < 6.1)
+    dalliance (0.8.1)
+      rails (>= 5.0, < 6.2)
       state_machine
 
 GEM

data/gemfiles/rails_5.1.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    dalliance (0.7.0)
-      rails (>= 5.0, < 6.1)
+    dalliance (0.8.1)
+      rails (>= 5.0, < 6.2)
       state_machine
 
 GEM

data/gemfiles/rails_5.2.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    dalliance (0.7.0)
-      rails (>= 5.0, < 6.1)
+    dalliance (0.8.1)
+      rails (>= 5.0, < 6.2)
       state_machine
 
 GEM

data/gemfiles/rails_6.0.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ..
   specs:
-    dalliance (0.7.0)
-      rails (>= 5.0, < 6.1)
+    dalliance (0.8.1)
+      rails (>= 5.0, < 6.2)
       state_machine
 
 GEM

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 6.1.0"
+
+group :development, :test do
+  gem "byebug"
+end
+
+gemspec path: "../"

data/gemfiles/rails_6.1.gemfile.lock

@@ -0,0 +1,233 @@
+PATH
+  remote: ..
+  specs:
+    dalliance (0.8.1)
+      rails (>= 5.0, < 6.2)
+      state_machine
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activestorage (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      actionview (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.2.1)
+      actionview (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activestorage (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.2.1)
+      activesupport (= 6.1.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.2.1)
+      activesupport (= 6.1.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.2.1)
+      activesupport (= 6.1.2.1)
+    activerecord (6.1.2.1)
+      activemodel (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+    activestorage (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    bundler-audit (0.7.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (>= 0.18, < 2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    delayed_job (4.1.9)
+      activesupport (>= 3.0, < 6.2)
+    delayed_job_active_record (4.1.5)
+      activerecord (>= 3.0, < 6.2)
+      delayed_job (>= 3.0, < 5)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.8)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    mono_logger (1.1.0)
+    multi_json (1.15.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.5)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.2.1)
+      actioncable (= 6.1.2.1)
+      actionmailbox (= 6.1.2.1)
+      actionmailer (= 6.1.2.1)
+      actionpack (= 6.1.2.1)
+      actiontext (= 6.1.2.1)
+      actionview (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activemodel (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activestorage (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    redis (4.2.5)
+    redis-namespace (1.8.1)
+      redis (>= 3.0.4)
+    regexp_parser (2.0.3)
+    resque (2.0.0)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.6)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    state_machine (1.2.0)
+    thor (1.1.0)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler-audit
+  byebug
+  dalliance!
+  delayed_job (>= 3.0.0)
+  delayed_job_active_record
+  rails (~> 6.1.0)
+  resque
+  rspec (>= 3.0.0)
+  rspec_junit_formatter
+  rubocop (~> 0.78)
+  sqlite3
+
+BUNDLED WITH
+   1.17.3

data/lib/dalliance/version.rb

@@ -1,7 +1,7 @@
 module Dalliance
   module VERSION
     MAJOR = 0
-    MINOR = 8
+    MINOR = 10
     TINY  = 0
     PRE   = nil
 

data/lib/dalliance/workers/delayed_job.rb

@@ -10,6 +10,22 @@ module Dalliance
             .perform_later(instance.class.name, instance.id, perform_method.to_s)
         end
 
+        def self.dequeue(_instance)
+          # NOP
+        end
+
+        def self.queued?(instance, queue)
+          queued_jobs =
+            Delayed::Job.where(queue: queue)
+              .pluck(:handler)
+              .map(&YAML.method(:load))
+
+          queued_jobs.any? do |job_wrapper|
+            job_wrapper.job_data['arguments'].first(2) ==
+              [instance.class.name, instance.id]
+          end
+        end
+
         def perform(instance_klass, instance_id, perform_method)
           instance_klass
             .constantize
@@ -31,6 +47,22 @@ module Dalliance
           )
         end
 
+        def self.dequeue(_instance)
+          # NOP
+        end
+
+        def self.queued?(instance, queue)
+          queued_jobs =
+            Delayed::Job.where(queue: queue)
+              .pluck(:handler)
+              .map(&YAML.method(:load))
+
+          queued_jobs.any? do |job_wrapper|
+            job_wrapper.job_data['arguments'].first(2) ==
+              [instance.class.name, instance.id]
+          end
+        end
+
         def perform
           instance_klass
             .constantize

data/lib/dalliance/workers/resque.rb

@@ -10,6 +10,41 @@ module Dalliance
             .perform_later(instance.class.name, instance.id, perform_method.to_s)
         end
 
+        def self.dequeue(instance)
+          redis = ::Resque.redis
+          queue = instance.processing_queue
+
+          redis.everything_in_queue(queue).each do |string|
+            # Structure looks like, e.g.
+            # { 'class' => 'ActiveJob::...', 'args' => [{ 'arguments' => ['SomeClass', 123, 'dalliance_process'] }] }
+            data = ::Resque.decode(string)
+            dalliance_args = data['args'][0]['arguments']
+
+            if dalliance_args == [instance.class.name, instance.id, 'dalliance_process'] ||
+               dalliance_args == [instance.class.name, instance.id, 'dalliance_reprocess']
+              redis.remove_from_queue(queue, string)
+            end
+          end
+        end
+
+        def self.queued?(instance, queue_name)
+          # All current jobs in the queue
+          queued_jobs =
+            ::Resque.redis.everything_in_queue(queue_name)
+              .map(&::Resque.method(:decode))
+
+          queued_jobs.any? do |job_info_hash|
+            args = job_info_hash['args']
+            next unless args.is_a?(Array)
+
+            arg = args[0]
+            next unless arg.is_a?(Hash)
+
+            arg.fetch('arguments', []).first(2) ==
+              [instance.class.name, instance.id]
+          end
+        end
+
         def perform(instance_klass, instance_id, perform_method)
           instance_klass
             .constantize
@@ -28,6 +63,41 @@ module Dalliance
           ::Resque.enqueue_to(queue, self, instance.class.name, instance.id, perform_method.to_s)
         end
 
+        def self.dequeue(instance)
+          redis = ::Resque.redis
+          queue = instance.processing_queue
+
+          redis.everything_in_queue(queue).each do |string|
+            # Structure looks like, e.g.
+            # { 'class' => 'ActiveJob::...', 'args' => [{ 'arguments' => ['SomeClass', 123, 'dalliance_process'] }] }
+            data = ::Resque.decode(string)
+            dalliance_args = data['args'][0]['arguments']
+
+            if dalliance_args == [instance.class.name, instance.id, 'dalliance_process'] ||
+               dalliance_args == [instance.class.name, instance.id, 'dalliance_reprocess']
+              redis.remove_from_queue(queue, string)
+            end
+          end
+        end
+
+        def self.queued?(instance, queue_name)
+          # All current jobs in the queue
+          queued_jobs =
+            ::Resque.redis.everything_in_queue(queue_name)
+              .map(&::Resque.method(:decode))
+
+          queued_jobs.any? do |job_info_hash|
+            args = job_info_hash['args']
+            next unless args.is_a?(Array)
+
+            arg = args[0]
+            next unless arg.is_a?(Hash)
+
+            arg.fetch('arguments', []).first(2) ==
+              [instance.class.name, instance.id]
+          end
+        end
+
         def self.perform(instance_klass, instance_id, perform_method)
           instance_klass
             .constantize

data/lib/dalliance.rb

@@ -91,6 +91,8 @@ module Dalliance
     scope :validation_error, -> { where(:dalliance_status => 'validation_error') }
     scope :processing_error, -> { where(:dalliance_status => 'processing_error') }
     scope :completed, -> { where(:dalliance_status => 'completed') }
+    scope :cancel_requested, -> { where(:dalliance_status => 'cancel_requested') }
+    scope :cancelled, -> { where(:dalliance_status => 'cancelled') }
 
     state_machine :dalliance_status, :initial => :pending do
       state :pending
@@ -98,6 +100,8 @@ module Dalliance
       state :validation_error
       state :processing_error
       state :completed
+      state :cancel_requested
+      state :cancelled
 
       #event :queue_dalliance do
       #  transition :processing_error => :pending
@@ -116,12 +120,23 @@ module Dalliance
       end
 
       event :finish_dalliance do
-        transition :processing => :completed
+        transition [:processing, :cancel_requested] => :completed
       end
 
       event :reprocess_dalliance do
         transition [:validation_error, :processing_error, :completed] => :pending
       end
+
+      # Requests the record to stop processing. This does NOT cause processing
+      # to stop!  Each model is required to handle cancellation on its own by
+      # periodically checking the dalliance status
+      event :request_cancel_dalliance do
+        transition [:pending, :processing] => :cancel_requested
+      end
+
+      event :cancelled_dalliance do
+        transition [:cancel_requested] => :cancelled
+      end
     end
     #END state_machine(s)
 
@@ -191,12 +206,34 @@ module Dalliance
   end
 
   def error_or_completed?
-    validation_error? || processing_error? || completed?
+    validation_error? || processing_error? || completed? || cancelled?
+  end
+
+  # Cancels the job and removes it from the queue if has not already been taken
+  # by a worker.  If the job is processing, it is up to the job implementation
+  # to stop and do any necessary cleanup.  If the job does not honor the
+  # cancellation request, it will finish processing as normal and finish with a
+  # dalliance_status of 'completed'.
+  #
+  # Jobs can currently only be removed from Resque queues.  DelayedJob jobs will
+  # not be dequeued, but will immediately exit once taken by a worker.
+  def cancel_and_dequeue_dalliance!
+    should_dequeue = pending?
+
+    request_cancel_dalliance!
+
+    if should_dequeue
+      self.dalliance_options[:worker_class].dequeue(self)
+      dalliance_log("[dalliance] #{self.class.name}(#{id}) - #{dalliance_status} - Removed from #{processing_queue} queue")
+      cancelled_dalliance!
+    end
+
+    true
   end
 
   def validate_dalliance_status
     unless error_or_completed?
-      errors.add(:dalliance_status, :invalid)
+      errors.add(:dalliance_status, "Processing must be finished or cancelled, but status is '#{dalliance_status}'")
       if defined?(Rails)
         throw(:abort)
       else
@@ -219,6 +256,19 @@ module Dalliance
     end
   end
 
+  # Is a job queued to the given processing queue for this record?
+  #
+  # @param queue_name [String]
+  #   the name of the queue to check for jobs.  Defaults to the configured
+  #   processing queue
+  #
+  # @return [Boolean]
+  def queued?(queue_name: processing_queue)
+
+    worker_class = self.class.dalliance_options[:worker_class]
+    worker_class.queued?(self, queue_name)
+  end
+
   #Force background_processing w/ true
   def dalliance_background_process(background_processing = nil)
     if background_processing || (background_processing.nil? && self.class.dalliance_options[:background_processing])
@@ -236,23 +286,29 @@ module Dalliance
   end
 
   def dalliance_background_reprocess(background_processing = nil)
+    # Reset state to 'pending' before queueing up
+    # Otherwise the model will stay on completed/processing_error until the job
+    # is taken by a worker, which could be a long time after this method is
+    # called.
+    reprocess_dalliance!
     if background_processing || (background_processing.nil? && self.class.dalliance_options[:background_processing])
-      self.class.dalliance_options[:worker_class].enqueue(self, processing_queue, :dalliance_reprocess)
+      self.class.dalliance_options[:worker_class].enqueue(self, processing_queue, :do_dalliance_reprocess)
     else
-      dalliance_reprocess(false)
+      do_dalliance_reprocess(false)
     end
   end
 
   def dalliance_reprocess(background_processing = false)
     reprocess_dalliance!
-
-    do_dalliance_process(
-      perform_method: self.class.dalliance_options[:reprocess_method],
-      background_processing: background_processing
-    )
+    do_dalliance_reprocess(background_processing)
   end
 
   def do_dalliance_process(perform_method:, background_processing: false)
+    # The job might have been cancelled after it was queued, but before
+    # processing started.  Check for that up front before doing any processing.
+    cancelled_dalliance! if cancel_requested?
+    return if cancelled? # method generated from AASM
+
     start_time = Time.now
 
     begin
@@ -264,7 +320,7 @@ module Dalliance
 
       self.send(perform_method)
 
-      finish_dalliance! unless validation_error?
+      finish_dalliance! unless validation_error? || cancelled?
     rescue StandardError => e
       #Save the error for future analysis...
       self.dalliance_error_hash = {:error => e.class.name, :message => e.message, :backtrace => e.backtrace}
@@ -339,6 +395,19 @@ module Dalliance
     end
   end
 
+  private
+
+  # Executes the reprocessing method defined in the model's dalliance options.
+  #
+  # @param [Boolean] background_processing
+  #   flag if this is called from a background worker. Defaults to false.
+  def do_dalliance_reprocess(background_processing = false)
+    do_dalliance_process(
+      perform_method: self.class.dalliance_options[:reprocess_method],
+      background_processing: background_processing
+    )
+  end
+
   module Glue
     extend ActiveSupport::Concern
 

data/spec/dalliance/asynchronous_delayed_job_spec.rb

@@ -44,6 +44,7 @@ RSpec.describe DallianceModel do
 
     it "should call the dalliance_method w/ a Delayed::Worker" do
       subject.dalliance_background_process
+      expect(subject).to be_queued
       Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
@@ -53,6 +54,7 @@ RSpec.describe DallianceModel do
 
     it "should set the dalliance_status to completed" do
       subject.dalliance_background_process
+      expect(subject).to be_queued
       Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
@@ -61,6 +63,7 @@ RSpec.describe DallianceModel do
 
     it "should set the dalliance_progress to 100" do
       subject.dalliance_background_process
+      expect(subject).to be_queued
       Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
@@ -71,6 +74,7 @@ RSpec.describe DallianceModel do
       expect(subject.dalliance_duration).to eq(nil)
 
       subject.dalliance_background_process
+      expect(subject).to be_queued
       Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
@@ -91,6 +95,7 @@ RSpec.describe DallianceModel do
 
       it 'successfully runs the dalliance_reprocess method' do
         subject.dalliance_background_reprocess
+        expect(subject).to be_queued
         Delayed::Worker.new(:queues => [:dalliance]).work_off
         subject.reload
 
@@ -102,11 +107,22 @@ RSpec.describe DallianceModel do
       it 'increases the total processing time counter' do
         original_duration = subject.dalliance_duration
         subject.dalliance_background_reprocess
+        expect(subject).to be_queued
         Delayed::Worker.new(:queues => [:dalliance]).work_off
         subject.reload
 
         expect(subject.dalliance_duration).to be_between(original_duration, Float::INFINITY)
       end
+
+      it "resets the dalliance_status to 'pending'" do
+        subject.update_column(:dalliance_status, 'processing_error')
+        expect { subject.dalliance_background_reprocess }
+          .to change(subject, :dalliance_status)
+          .to('pending')
+
+        Delayed::Worker.new(:queues => [:dalliance]).work_off
+        expect(subject).to be_successful
+      end
     end
 
     context "another_queue" do
@@ -118,6 +134,8 @@ RSpec.describe DallianceModel do
 
       it "should NOT call the dalliance_method w/ a Delayed::Worker (different queue)" do
         subject.dalliance_background_process
+        expect(subject).not_to be_queued(queue_name: 'dalliance')
+        expect(subject).to be_queued(queue_name: queue)
         Delayed::Worker.new(:queues => [:dalliance]).work_off
         subject.reload
 

data/spec/dalliance/asynchronous_resque_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe DallianceModel do
 
   before do
     Resque.remove_queue(:dalliance)
+    Resque.remove_queue(:notaqueue)
   end
 
   context "no worker_class" do
@@ -96,6 +97,9 @@ RSpec.describe DallianceModel do
 
       it "should NOT call the dalliance_method w/ a Delayed::Worker (different queue)" do
         subject.dalliance_background_process
+
+        expect(subject).to be_queued
+
         Resque::Worker.new(:dalliance).process
         subject.reload
 
@@ -105,6 +109,9 @@ RSpec.describe DallianceModel do
 
       it "should call the dalliance_method w/ a Delayed::Worker (same queue)" do
         subject.dalliance_background_process
+
+        expect(subject).to be_queued
+
         Resque::Worker.new(queue).process
         subject.reload
 
@@ -131,6 +138,9 @@ RSpec.describe DallianceModel do
       Resque::Stat.clear(:failed)
 
       subject.dalliance_background_reprocess
+
+      expect(subject).to be_queued
+
       Resque::Worker.new(:dalliance).process
       subject.reload
 
@@ -140,6 +150,7 @@ RSpec.describe DallianceModel do
         expect(Resque::Stat[:processed]).to eq(1)
         expect(Resque::Stat[:failed]).to eq(0)
         expect(subject.reprocessed_count).to eq(1)
+        expect(subject).not_to be_queued
       end
     end
 
@@ -151,6 +162,84 @@ RSpec.describe DallianceModel do
 
       expect(subject.dalliance_duration).to be_between(original_duration, Float::INFINITY)
     end
+
+    it "resets the dalliance_status to 'pending'" do
+      subject.update_column(:dalliance_status, 'processing_error')
+
+      Resque::Stat.clear(:processed)
+      Resque::Stat.clear(:failed)
+
+      expect { subject.dalliance_background_reprocess }
+        .to change(subject, :dalliance_status)
+        .to('pending')
+
+      Resque::Worker.new(:dalliance).process
+
+      expect(subject).to be_successful
+    end
+  end
+
+  context 'cancelling' do
+    before(:all) do
+      DallianceModel.dalliance_options[:dalliance_method] = :dalliance_success_method
+      DallianceModel.dalliance_options[:worker_class] = Dalliance::Workers::Resque
+      DallianceModel.dalliance_options[:queue] = 'dalliance'
+    end
+
+    it 'can be cancelled after being queued' do
+      subject.dalliance_background_process
+      expect { subject.request_cancel_dalliance! and subject.cancelled_dalliance! }
+        .to change { subject.dalliance_status }
+        .from('pending')
+        .to('cancelled')
+    end
+
+    it 'dequeues the job' do
+      expect { subject.dalliance_background_process }
+        .to change { Resque.size('dalliance') }
+        .from(0)
+        .to(1)
+
+      expect { subject.cancel_and_dequeue_dalliance! }
+        .to change { Resque.size('dalliance') }
+        .from(1)
+        .to(0)
+        .and change { subject.dalliance_status }
+        .from('pending')
+        .to('cancelled')
+    end
+
+    it 'sets dalliance_status to "cancelled" if cancellation was requested' do
+      subject.dalliance_background_process
+      subject.request_cancel_dalliance!
+
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      expect(subject.dalliance_status).to eq 'cancelled'
+    end
+
+    it 'runs normally if the job does not honor the cancellation request' do
+      DallianceModel.dalliance_options[:dalliance_method] = :dalliance_ignore_cancellation_method
+
+      subject.dalliance_background_process
+
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      expect(subject.successful).to eq true
+      expect(subject.dalliance_status).to eq 'completed'
+    end
+
+    it 'does not process' do
+      subject.request_cancel_dalliance!
+      subject.dalliance_background_process
+
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      expect(subject.successful).to eq false
+    end
   end
 
   context "raise error" do

data/spec/dalliance/dalliance_spec.rb

@@ -9,13 +9,15 @@ RSpec.describe 'Dalliance' do
 
   context "self#dalliance_status_in_load_select_array" do
     it "should return [state, human_name]" do
-      expect(DallianceModel.dalliance_status_in_load_select_array).to eq([
+      expect(DallianceModel.dalliance_status_in_load_select_array).to contain_exactly(
         ["Completed", "completed"],
         ["Pending", "pending"],
         ["Processing", "processing"],
         ["Processing Error", "processing_error"],
-        ["Validation Error", "validation_error"]
-      ])
+        ["Validation Error", "validation_error"],
+        ["Cancellation Requested", "cancel_requested"],
+        ['Cancelled', 'cancelled']
+      )
     end
   end
 

data/spec/dalliance/synchronous_spec.rb

@@ -180,13 +180,15 @@ RSpec.describe DallianceModel do
     it "should return false when pending?" do
       subject.update_column(:dalliance_status, 'pending')
       expect(subject.destroy).to be_falsey
-      expect(subject.errors[:dalliance_status]).to eq(['is invalid'])
+      expect(subject.errors[:dalliance_status])
+        .to eq(["Processing must be finished or cancelled, but status is 'pending'"])
     end
 
     it "should return false when processing?" do
       subject.update_column(:dalliance_status, 'processing')
       expect(subject.destroy).to be_falsey
-      expect(subject.errors[:dalliance_status]).to eq(['is invalid'])
+      expect(subject.errors[:dalliance_status])
+        .to eq(["Processing must be finished or cancelled, but status is 'processing'"])
     end
 
     it "should return true when validation_error?" do

data/spec/support/active_record.rb

@@ -59,6 +59,13 @@ class DallianceModel < ActiveRecord::Base
     update_attribute(:reprocessed_count, self.reprocessed_count + 1)
   end
 
+  # Pretends that an external action requested processing to be cancelled, but
+  # ignores the request and finishes anyway.
+  def dalliance_ignore_cancellation_method
+    request_cancel_dalliance!
+    update_attribute(:successful, true)
+  end
+
   def dalliance_error_method
     raise RuntimeError
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dalliance
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Eric Sullivan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: state_machine
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +182,8 @@ files:
 - gemfiles/rails_5.2.gemfile.lock
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.0.gemfile.lock
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_6.1.gemfile.lock
 - lib/dalliance.rb
 - lib/dalliance/engine.rb
 - lib/dalliance/progress_meter.rb
@@ -204,7 +206,7 @@ files:
 homepage: https://github.com/annkissam/dalliance
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -219,9 +221,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Wrapper for an ActiveRecord model with a single ascynhronous method
 test_files: