dalliance 0.6.0 → 0.9.0

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
@@ -114,6 +115,123 @@ RSpec.describe DallianceModel do
     end
   end
 
+  context 'reprocess' 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
+
+    before do
+      subject.dalliance_process
+      subject.reload
+    end
+
+    it 'successfully runs the dalliance_reprocess method' do
+      Resque::Stat.clear(:processed)
+      Resque::Stat.clear(:failed)
+
+      subject.dalliance_background_reprocess
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      aggregate_failures do
+        expect(subject).to be_successful
+        expect(Resque.size(:dalliance)).to eq(0)
+        expect(Resque::Stat[:processed]).to eq(1)
+        expect(Resque::Stat[:failed]).to eq(0)
+        expect(subject.reprocessed_count).to eq(1)
+      end
+    end
+
+    it 'increases the total processing time counter' do
+      original_duration = subject.dalliance_duration
+      subject.dalliance_background_reprocess
+      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')
+
+      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
     before(:all) do
       DallianceModel.dalliance_options[:dalliance_method] = :dalliance_error_method

data/spec/dalliance/dalliance_spec.rb

@@ -9,19 +9,21 @@ 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
 
   context "human_attribute_name" do
     it "should display the correct locale" do
-      expect(DallianceModel.human_attribute_name(:dalliance_status)).to eq ('Status')
+      expect(DallianceModel.human_attribute_name(:dalliance_status)).to eq('Status')
     end
   end
 
@@ -44,7 +46,7 @@ RSpec.describe 'Dalliance' do
       end
 
       context "w/ args" do
-        let(:queue) { Proc.new{ |a,b,c| 'dalliance_2' } }
+        let(:queue) { Proc.new{ |_a,_b,_c| 'dalliance_2' } }
 
         specify{ expect(subject.processing_queue).to eq(queue.call) }
       end

data/spec/dalliance/synchronous_spec.rb

@@ -35,6 +35,61 @@ RSpec.describe DallianceModel do
     end
   end
 
+  context 'reprocess' do
+    context 'without having already processed' do
+      it 'raises an error' do
+        expect { subject.dalliance_background_reprocess }
+          .to raise_error(
+            StateMachine::InvalidTransition,
+            /^Cannot transition dalliance_status via :reprocess_dalliance from :pending.*/
+          )
+      end
+    end
+
+    context 'when the model has already processed' do
+      before do
+        DallianceModel.dalliance_options[:dalliance_method] = :dalliance_success_method
+        subject.dalliance_background_process
+        subject.reload
+      end
+
+      it 'calls the dalliance_reprocess method' do
+        expect { subject.dalliance_background_reprocess }
+          .to change(subject, :reprocessed_count)
+          .from(0)
+          .to(1)
+      end
+
+      it 'can call the dalliance_reprocess method many times in succession' do
+        expect { 10.times { subject.dalliance_background_reprocess } }
+          .to change(subject, :reprocessed_count)
+          .from(0)
+          .to(10)
+      end
+
+      it 'sets the dalliance_status to completed' do
+        expect { subject.dalliance_background_reprocess }
+          .not_to change { subject.reload.dalliance_status }
+          .from('completed')
+      end
+
+      it 'sets the dalliance_progress to 100' do
+        expect { subject.dalliance_background_reprocess }
+          .not_to change { subject.reload.dalliance_progress }
+          .from(100)
+      end
+
+      it 'increases the total processing time counter' do
+        original_duration = subject.dalliance_duration
+        subject.dalliance_background_reprocess
+        Delayed::Worker.new(:queues => [:dalliance]).work_off
+        subject.reload
+
+        expect(subject.dalliance_duration).to be_between(original_duration, Float::INFINITY)
+      end
+    end
+  end
+
   context "raise error" do
     before(:all) do
       DallianceModel.dalliance_options[:dalliance_method] = :dalliance_error_method
@@ -121,17 +176,19 @@ RSpec.describe DallianceModel do
     end
   end
 
-   context "destroy" do
+  context "destroy" 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/spec_helper.rb

@@ -4,10 +4,12 @@ require 'bundler/setup'
 #Automatically included in a rails app...
 require 'active_support'
 
+# rubocop:disable Lint/SuppressedException
 begin
   require 'active_job'
 rescue LoadError
 end
+# rubocop:enable Lint/SuppressedException
 
 require 'state_machine'
 require 'byebug'

data/spec/support/active_record.rb

@@ -35,9 +35,10 @@ ActiveRecord::Schema.define do
   create_table :dalliance_models, :force => true do |t|
     t.text    :dalliance_error_hash
     t.string  :dalliance_status, :string, :null => false, :default => 'pending'
-    t.integer :dalliance_duration
+    t.decimal :dalliance_duration
 
     t.boolean :successful, :default => false
+    t.integer :reprocessed_count, default: 0
   end
 end
 
@@ -47,12 +48,24 @@ class DallianceModel < ActiveRecord::Base
   include Dalliance::Glue
 
   dalliance :dalliance_success_method,
+            reprocess_method: :dalliance_reprocess_method,
             :logger => nil
 
   def dalliance_success_method
     update_attribute(:successful, true)
   end
 
+  def dalliance_reprocess_method
+    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.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Eric Sullivan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: state_machine
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " Background processing for ActiveRecord using a 'delayable' worker and
   a state_machine "
 email:
@@ -122,6 +164,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - Appraisals
@@ -131,14 +174,16 @@ files:
 - Rakefile
 - config/locales/en.yml
 - dalliance.gemspec
-- gemfiles/rails_4.2.gemfile
-- gemfiles/rails_4.2.gemfile.lock
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.0.gemfile.lock
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.1.gemfile.lock
 - gemfiles/rails_5.2.gemfile
 - 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
@@ -161,7 +206,7 @@ files:
 homepage: https://github.com/annkissam/dalliance
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,9 +221,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: dalliance
+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:

data/gemfiles/rails_4.2.gemfile.lock

@@ -1,165 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    dalliance (0.5.1)
-      rails (>= 3.2, < 5.3)
-      state_machine
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (4.2.9)
-      actionpack (= 4.2.9)
-      actionview (= 4.2.9)
-      activejob (= 4.2.9)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.9)
-      actionview (= 4.2.9)
-      activesupport (= 4.2.9)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.9)
-      activesupport (= 4.2.9)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (4.2.9)
-      activesupport (= 4.2.9)
-      globalid (>= 0.3.0)
-    activemodel (4.2.9)
-      activesupport (= 4.2.9)
-      builder (~> 3.1)
-    activerecord (4.2.9)
-      activemodel (= 4.2.9)
-      activesupport (= 4.2.9)
-      arel (~> 6.0)
-    activesupport (4.2.9)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (6.0.4)
-    builder (3.2.3)
-    byebug (10.0.2)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    delayed_job (4.1.5)
-      activesupport (>= 3.0, < 5.3)
-    delayed_job_active_record (4.1.3)
-      activerecord (>= 3.0, < 5.3)
-      delayed_job (>= 3.0, < 5)
-    diff-lcs (1.3)
-    erubis (2.7.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    mini_mime (1.0.1)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    mono_logger (1.1.0)
-    multi_json (1.13.1)
-    nokogiri (1.10.3)
-      mini_portile2 (~> 2.4.0)
-    rack (1.6.8)
-    rack-protection (1.5.3)
-      rack
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.9)
-      actionmailer (= 4.2.9)
-      actionpack (= 4.2.9)
-      actionview (= 4.2.9)
-      activejob (= 4.2.9)
-      activemodel (= 4.2.9)
-      activerecord (= 4.2.9)
-      activesupport (= 4.2.9)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.9)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.9)
-      activesupport (>= 4.2.0, < 5.0)
-      nokogiri (~> 1.6)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (4.2.9)
-      actionpack (= 4.2.9)
-      activesupport (= 4.2.9)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (12.3.2)
-    redis (4.1.0)
-    redis-namespace (1.6.0)
-      redis (>= 3.0.4)
-    resque (2.0.0)
-      mono_logger (~> 1.0)
-      multi_json (~> 1.0)
-      redis-namespace (~> 1.6)
-      sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sinatra (1.4.8)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    sprockets (3.7.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.3.13)
-    state_machine (1.2.0)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tilt (2.0.9)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    vegas (0.1.11)
-      rack (>= 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal
-  byebug
-  dalliance!
-  delayed_job (>= 3.0.0)
-  delayed_job_active_record
-  rails (~> 4.2.0)
-  resque
-  rspec (>= 3.0.0)
-  sqlite3
-
-BUNDLED WITH
-   1.17.3