batch_processor 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa414c8ed1a57723e070fa4e497f204f3e35ca710072053fe81c2e6911fe3a06
-  data.tar.gz: fab54cef458cfe173082f2d86223bb7ce42471639658a500abe69c5fc9579278
+  metadata.gz: f4a9d68e36cd3f56abfaadd71b82a4740c38bb3aed87d97b0ba6f9e651944039
+  data.tar.gz: 4a9b585d163ee2bd7f3166658388a6de879ce788d31cb5f7de37cdeba6359f2c
 SHA512:
-  metadata.gz: c0f97d5f687336adf312cd3232c731e7557dcc004a0990ab2862abfa13ce6c786951d5359b8b1bd918a1e2c39a46c0ff60311fc1ad1278ed52703699caaffaa8
-  data.tar.gz: 297022cb0bb636267316576598d362b45d9dd3cf42c948e3912e070c86d15fee71e5378f600405c86969d8fdc4a07c55563ae194efaf946b93448d72e6d49d5f
+  metadata.gz: c97251745907fbe425b802b478a996dfefd2f7caaadbb31ef7299727c748ad19116f3cb8e69299df9ca9ec073334dc2eb751d6c7ec3a0895f81063fe3b13f62b
+  data.tar.gz: 3aba5c37b18e45a6fc02ce7bdbd335c004e74fd678ba465360487aa3acf2c149177ed4ebb7ee1d578743ac784c2209b01fdaf06acfebe31834412b74ae94f995

data/lib/batch_processor.rb

@@ -4,6 +4,20 @@ require "active_support"
 require "active_job"
 
 require "spicery"
+require "malfunction"
+
+require "batch_processor/malfunction/base"
+require "batch_processor/malfunction/collection_empty"
+require "batch_processor/malfunction/collection_invalid"
+require "batch_processor/malfunction/already_started"
+require "batch_processor/malfunction/already_enqueued"
+require "batch_processor/malfunction/already_finished"
+require "batch_processor/malfunction/already_aborted"
+require "batch_processor/malfunction/already_cleared"
+require "batch_processor/malfunction/still_processing"
+require "batch_processor/malfunction/not_processing"
+require "batch_processor/malfunction/not_aborted"
+require "batch_processor/malfunction/not_started"
 
 require "batch_processor/version"
 require "batch_processor/batch_job"
@@ -15,13 +29,16 @@ require "batch_processor/collection"
 require "batch_processor/batch_base"
 
 module BatchProcessor
-  class Error < StandardError; end
+  class Error < StandardError
+    include Conjunction::Junction
+    prefixed_with "BatchProcessor::"
+    suffixed_with "Error"
+  end
 
   class NotFoundError < Error; end
   class ClassMissingError < Error; end
   class CollectionEmptyError < Error; end
   class CollectionInvalidError < Error; end
-  class AlreadyExistsError < Error; end
   class AlreadyStartedError < Error; end
   class AlreadyEnqueuedError < Error; end
   class AlreadyFinishedError < Error; end

data/lib/batch_processor/batch/malfunction.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Batch
+    module Malfunction
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :malfunction
+      end
+
+      private
+
+      def build_malfunction(malfunction_class, context = nil)
+        @malfunction = malfunction_class.build(context)
+      end
+    end
+  end
+end

data/lib/batch_processor/batch/predicates.rb

@@ -18,6 +18,10 @@ module BatchProcessor
         started? && !aborted? && !finished?
       end
 
+      def malfunction?
+        malfunction.present?
+      end
+
       class_methods do
         private
 

data/lib/batch_processor/batch/processor.rb

@@ -62,10 +62,23 @@ module BatchProcessor
 
       def process
         process!
-      rescue StandardError => exception
-        error :process_error, exception: exception
+      rescue BatchProcessor::Error => exception
+        handle_exception(exception)
         self
       end
+
+      private
+
+      def handle_exception(exception)
+        malfunction_class = exception.try(:conjugate, BatchProcessor::Malfunction::Base)
+        error :process_error, exception: exception and return if malfunction_class.nil?
+
+        if malfunction_class <= BatchProcessor::Malfunction::CollectionInvalid
+          build_malfunction malfunction_class, collection
+        else
+          build_malfunction malfunction_class
+        end
+      end
     end
   end
 end

data/lib/batch_processor/batch_base.rb

@@ -2,6 +2,7 @@
 
 require_relative "batch/core"
 require_relative "batch/job"
+require_relative "batch/malfunction"
 require_relative "batch/processor"
 require_relative "batch/predicates"
 require_relative "batch/controller"
@@ -18,6 +19,7 @@ module BatchProcessor
 
     include BatchProcessor::Batch::Core
     include BatchProcessor::Batch::Job
+    include BatchProcessor::Batch::Malfunction
     include BatchProcessor::Batch::Processor
     include BatchProcessor::Batch::Predicates
     include BatchProcessor::Batch::Controller

data/lib/batch_processor/malfunction/already_aborted.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class AlreadyAborted < Base; end
+  end
+end

data/lib/batch_processor/malfunction/already_cleared.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class AlreadyCleared < Base; end
+  end
+end

data/lib/batch_processor/malfunction/already_enqueued.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class AlreadyEnqueued < Base; end
+  end
+end

data/lib/batch_processor/malfunction/already_finished.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class AlreadyFinished < Base; end
+  end
+end

data/lib/batch_processor/malfunction/already_started.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class AlreadyStarted < Base; end
+  end
+end

data/lib/batch_processor/malfunction/base.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class Base < ::Malfunction::MalfunctionBase
+      prefixed_with "BatchProcessor::Malfunction::"
+      suffixed_with nil
+    end
+  end
+end

data/lib/batch_processor/malfunction/collection_empty.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class CollectionEmpty < Base; end
+  end
+end

data/lib/batch_processor/malfunction/collection_invalid.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class CollectionInvalid < Base
+      uses_attribute_errors
+      contextualize :collection
+      delegate :errors, to: :collection, prefix: true
+
+      on_build do
+        collection_errors.details.each do |attribute_name, error_details|
+          attribute_messages = collection_errors.messages[attribute_name]
+
+          error_details.each_with_index do |error_detail, index|
+            add_attribute_error(attribute_name, error_detail[:error], attribute_messages[index])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/batch_processor/malfunction/not_aborted.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class NotAborted < Base; end
+  end
+end

data/lib/batch_processor/malfunction/not_processing.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class NotProcessing < Base; end
+  end
+end

data/lib/batch_processor/malfunction/not_started.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class NotStarted < Base; end
+  end
+end

data/lib/batch_processor/malfunction/still_processing.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BatchProcessor
+  module Malfunction
+    class StillProcessing < Base; end
+  end
+end

data/lib/batch_processor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BatchProcessor
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batch_processor
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Eric Garside
@@ -72,6 +72,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: malfunction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -211,12 +231,25 @@ files:
 - lib/batch_processor/batch/core.rb
 - lib/batch_processor/batch/job.rb
 - lib/batch_processor/batch/job_controller.rb
+- lib/batch_processor/batch/malfunction.rb
 - lib/batch_processor/batch/predicates.rb
 - lib/batch_processor/batch/processor.rb
 - lib/batch_processor/batch_base.rb
 - lib/batch_processor/batch_details.rb
 - lib/batch_processor/batch_job.rb
 - lib/batch_processor/collection.rb
+- lib/batch_processor/malfunction/already_aborted.rb
+- lib/batch_processor/malfunction/already_cleared.rb
+- lib/batch_processor/malfunction/already_enqueued.rb
+- lib/batch_processor/malfunction/already_finished.rb
+- lib/batch_processor/malfunction/already_started.rb
+- lib/batch_processor/malfunction/base.rb
+- lib/batch_processor/malfunction/collection_empty.rb
+- lib/batch_processor/malfunction/collection_invalid.rb
+- lib/batch_processor/malfunction/not_aborted.rb
+- lib/batch_processor/malfunction/not_processing.rb
+- lib/batch_processor/malfunction/not_started.rb
+- lib/batch_processor/malfunction/still_processing.rb
 - lib/batch_processor/processor/execute.rb
 - lib/batch_processor/processor/process.rb
 - lib/batch_processor/processor_base.rb