dalliance 0.5.0 → 0.8.1

data/gemfiles/{rails_4.0.gemfile → rails_6.0.gemfile}

@@ -1,9 +1,9 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 4.0.0"
+gem "rails", "~> 6.0.0"
 
 group :development, :test do
   gem "byebug"

data/gemfiles/rails_6.0.gemfile.lock

@@ -0,0 +1,225 @@
+PATH
+  remote: ..
+  specs:
+    dalliance (0.7.0)
+      rails (>= 5.0, < 6.1)
+      state_machine
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activestorage (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    builder (3.2.4)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    byebug (11.1.1)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    delayed_job (4.1.8)
+      activesupport (>= 3.0, < 6.1)
+    delayed_job_active_record (4.1.4)
+      activerecord (>= 3.0, < 6.1)
+      delayed_job (>= 3.0, < 5)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    loofah (2.4.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 (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    mono_logger (1.1.0)
+    multi_json (1.14.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.0.3)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.1)
+      actioncable (= 6.0.2.1)
+      actionmailbox (= 6.0.2.1)
+      actionmailer (= 6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actiontext (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.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.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    redis (4.1.3)
+    redis-namespace (1.7.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)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    sinatra (2.0.8.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.8.1)
+      tilt (~> 2.0)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    state_machine (1.2.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler-audit
+  byebug
+  dalliance!
+  delayed_job (>= 3.0.0)
+  delayed_job_active_record
+  rails (~> 6.0.0)
+  resque
+  rspec (>= 3.0.0)
+  rspec_junit_formatter
+  rubocop (~> 0.78)
+  sqlite3
+
+BUNDLED WITH
+   1.17.3

data/lib/dalliance.rb

@@ -118,6 +118,10 @@ module Dalliance
       event :finish_dalliance do
         transition :processing => :completed
       end
+
+      event :reprocess_dalliance do
+        transition [:validation_error, :processing_error, :completed] => :pending
+      end
     end
     #END state_machine(s)
 
@@ -175,7 +179,9 @@ module Dalliance
         else
           self.class.where(id: self.id).update_all(dalliance_status: dalliance_status, dalliance_error_hash: dalliance_error_hash.to_yaml )
         end
+      # rubocop:disable Lint/SuppressedException
       rescue
+      # rubocop:enable Lint/SuppressedException
       end
     end
   end
@@ -191,7 +197,7 @@ module Dalliance
   def validate_dalliance_status
     unless error_or_completed?
       errors.add(:dalliance_status, :invalid)
-      if defined?(Rails) && ::Rails::VERSION::MAJOR == 5 && ::Rails::VERSION::MINOR >= 0
+      if defined?(Rails)
         throw(:abort)
       else
         return false
@@ -213,17 +219,41 @@ module Dalliance
     end
   end
 
-  #Force backgound_processing w/ true
-  def dalliance_background_process(backgound_processing = nil)
-    if backgound_processing || (backgound_processing.nil? && self.class.dalliance_options[:background_processing])
-      self.class.dalliance_options[:worker_class].enqueue(self, processing_queue)
+  #Force background_processing w/ true
+  def dalliance_background_process(background_processing = nil)
+    if background_processing || (background_processing.nil? && self.class.dalliance_options[:background_processing])
+      self.class.dalliance_options[:worker_class].enqueue(self, processing_queue, :dalliance_process)
     else
       dalliance_process(false)
     end
   end
 
-  #backgound_processing == false will re-raise any exceptions
-  def dalliance_process(backgound_processing = false)
+  def dalliance_process(background_processing = false)
+    do_dalliance_process(
+      perform_method: self.class.dalliance_options[:dalliance_method],
+      background_processing: background_processing
+    )
+  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, :do_dalliance_reprocess)
+    else
+      do_dalliance_reprocess(false)
+    end
+  end
+
+  def dalliance_reprocess(background_processing = false)
+    reprocess_dalliance!
+    do_dalliance_reprocess(background_processing)
+  end
+
+  def do_dalliance_process(perform_method:, background_processing: false)
     start_time = Time.now
 
     begin
@@ -233,7 +263,7 @@ module Dalliance
         build_dalliance_progress_meter(:total_count => calculate_dalliance_progress_meter_total_count).save!
       end
 
-      self.send(self.class.dalliance_options[:dalliance_method])
+      self.send(perform_method)
 
       finish_dalliance! unless validation_error?
     rescue StandardError => e
@@ -255,14 +285,16 @@ module Dalliance
           else
             self.class.where(id: self.id).update_all(dalliance_status: dalliance_status, dalliance_error_hash: dalliance_error_hash.to_yaml )
           end
+        # rubocop:disable Lint/SuppressedException
         rescue
+        # rubocop:enable Lint/SuppressedException
         end
       end
 
       error_notifier.call(e)
 
-      #Don't raise the error if we're backgound_processing...
-      raise e unless backgound_processing && self.class.dalliance_options[:worker_class].rescue_error?
+      # Don't raise the error if we're background processing...
+      raise e unless background_processing && self.class.dalliance_options[:worker_class].rescue_error?
     ensure
       if self.class.dalliance_options[:dalliance_progress_meter] && dalliance_progress_meter
         #Works with optimistic locking...
@@ -274,8 +306,11 @@ module Dalliance
 
       dalliance_log("[dalliance] #{self.class.name}(#{id}) - #{dalliance_status} #{duration.to_i}")
 
-      if self.class.dalliance_options[:duration_column]
-        self.class.where(id: self.id).update_all(self.class.dalliance_options[:duration_column] => duration.to_i)
+      duration_column = self.class.dalliance_options[:duration_column]
+      if duration_column.present?
+        current_duration = self.send(duration_column) || 0
+        self.class.where(id: self.id)
+          .update_all(duration_column => current_duration + duration.to_f)
       end
     end
   end
@@ -305,6 +340,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
 
@@ -313,15 +361,28 @@ module Dalliance
     end
 
     module ClassMethods
-      def dalliance(*args)
-        options = args.last.is_a?(Hash) ? Dalliance.options.merge(args.pop) : Dalliance.options
-
-        case args.length
-        when 1
-          options[:dalliance_method] = args[0]
-        else
-          raise ArgumentError, "Incorrect number of Arguements provided"
-        end
+      # Enables dalliance processing for this class.
+      #
+      # @param [Symbol|String] dalliance_method
+      #   the name of the method to call when processing the model in dalliance
+      # @param [Hash] options
+      #   an optional hash of options for dalliance processing
+      # @option options [Symbol] :reprocess_method
+      #   the name of the method to use to reprocess the model in dalliance
+      # @option options [Boolean] :dalliance_process_meter
+      #   whether or not to display a progress meter
+      # @option options [String] :queue
+      #   the name of the worker queue to use. Default 'dalliance'
+      # @option options [String] :duration_column
+      #   the name of the table column that stores the dalliance processing time. Default 'dalliance_duration'
+      # @option options [Object] :logger
+      #   the logger object to use. Can be nil
+      # @option options [Proc] :error_notifier
+      #   A proc that accepts an error object. Default is a NOP
+      def dalliance(dalliance_method, options = {})
+        opts = Dalliance.options.merge(options)
+
+        opts[:dalliance_method] = dalliance_method
 
         if dalliance_options.nil?
           self.dalliance_options = {}
@@ -329,7 +390,7 @@ module Dalliance
           self.dalliance_options = self.dalliance_options.dup
         end
 
-        self.dalliance_options.merge!(options)
+        self.dalliance_options.merge!(opts)
 
         include Dalliance
       end

data/lib/dalliance/engine.rb

@@ -7,7 +7,7 @@ module Dalliance
       ActiveSupport.on_load :active_record do
         include Dalliance::Glue
 
-        ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Dalliance::Schema)
+        ActiveRecord::ConnectionAdapters::TableDefinition.include Dalliance::Schema
       end
     end
   end

data/lib/dalliance/progress_meter.rb

@@ -46,20 +46,20 @@ module Dalliance
     #TODO: This is just a stopgap until I fix increment! to be thread-safe
     def progress
       begin
-        _progress = (current_count.to_f / total_count.to_f * 100).to_i
+        current_progress = (current_count.to_f / total_count.to_f * 100).to_i
 
         #Handle an incorrect total_count...
-        _progress = 100 if _progress > 100
+        current_progress = 100 if current_progress > 100
       rescue
         #what, are you diving by zero?
-        _progress = 0
+        current_progress = 0
       end
 
-      _progress
+      current_progress
     end
 
     def increment!
       Dalliance::ProgressMeter.increment_counter(:current_count, self.id)
     end
   end
-end
+end