Add custom classes support for raise (#86)

lib/service_actor/base.rb

@@ -6,6 +6,7 @@ module ServiceActor::Base
   def self.included(base)
     # Essential mechanics
     base.include(ServiceActor::Core)
+    base.include(ServiceActor::Raisable)
     base.include(ServiceActor::Attributable)
     base.include(ServiceActor::Playable)
 

lib/service_actor/core.rb

@@ -21,7 +21,7 @@ def call(result = nil, **arguments)
     #   CreateUser.result(name: "Joe")
     def result(result = nil, **arguments)
       call(result, **arguments)
-    rescue ServiceActor::Failure => e
+    rescue failure_class => e
       e.result
     end
   end
@@ -52,7 +52,7 @@ def _call
 
   # Can be called from inside an actor to stop execution and mark as failed.
   def fail!(**arguments)
-    result.fail!(**arguments)
+    result.fail!(self.class.failure_class, **arguments)
   end
 
   private
@@ -61,6 +61,6 @@ def fail!(**arguments)
   def raise_error_with(message, **arguments)
     message = message.call(**arguments) if message.is_a?(Proc)
 
-    raise ServiceActor::ArgumentError, message
+    raise self.class.argument_error_class, message
   end
 end

lib/service_actor/playable.rb

@@ -37,7 +37,7 @@ def call
 
         options[:actors].each { |actor| play_actor(actor) }
       end
-    rescue ServiceActor::Failure
+    rescue self.class.failure_class
       rollback
       raise
     end

lib/service_actor/raisable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ServiceActor::Raisable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def inherited(child)
+      super
+
+      child.argument_error_class =
+        argument_error_class || ServiceActor::ArgumentError
+
+      child.failure_class = failure_class || ServiceActor::Failure
+    end
+
+    attr_accessor :argument_error_class, :failure_class
+  end
+end

lib/service_actor/result.rb

@@ -15,11 +15,11 @@ def inspect
     "<#{self.class.name} #{to_h}>"
   end
 
-  def fail!(result = {})
+  def fail!(failure_class, result = {})
     merge!(result)
     merge!(failure?: true)
 
-    raise ServiceActor::Failure, self
+    raise failure_class, self
   end
 
   def success?

spec/actor_spec.rb

@@ -15,6 +15,13 @@
         expect { FailWithError.call }
           .to raise_error(ServiceActor::Failure, "Ouch")
       end
+
+      context "when a custom class is specified" do
+        it "raises the error message" do
+          expect { FailWithErrorWithCustomFailureClass.call }
+            .to raise_error(MyCustomFailure, "Ouch")
+        end
+      end
     end
 
     context "when an actor updates the context" do
@@ -258,7 +265,7 @@
     context "when called with the wrong type of argument" do
       let(:expected_message) do
         "The \"name\" input on \"SetNameToDowncase\" must be of " \
-          "type \"String\" but was \"#{1.class.name}\""
+          "type \"String\" but was \"Integer\""
       end
 
       it "raises" do
@@ -308,7 +315,7 @@
       context "when normal mode" do
         let(:expected_message) do
           "The \"name\" output on \"SetWrongTypeOfOutput\" must " \
-            "be of type \"String\" but was \"#{1.class.name}\""
+            "be of type \"String\" but was \"Integer\""
         end
 
         it "raises" do
@@ -327,6 +334,19 @@
             .to raise_error(ServiceActor::ArgumentError, expected_message)
         end
       end
+
+      context "when a custom class is specified" do
+        let(:expected_message) do
+          "The \"name\" output on " \
+            "\"SetWrongTypeOfOutputWithCustomArgumentErrorClass\" must " \
+              "be of type \"String\" but was \"Integer\""
+        end
+
+        it "raises" do
+          expect { SetWrongTypeOfOutputWithCustomArgumentErrorClass.call }
+            .to raise_error(MyCustomArgumentError, expected_message)
+        end
+      end
     end
 
     context "when using an output called display" do

spec/examples/fail_with_error_with_custom_failure_class.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class FailWithErrorWithCustomFailureClass < Actor
+  self.failure_class = MyCustomFailure
+
+  def call
+    fail!(error: "Ouch", some_other_key: 42)
+  end
+end

spec/examples/my_custom_argument_error.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class MyCustomArgumentError < ServiceActor::ArgumentError; end

spec/examples/my_custom_failure.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class MyCustomFailure < ServiceActor::Failure; end

spec/examples/set_wrong_type_of_output_with_custom_argument_error_class.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class SetWrongTypeOfOutputWithCustomArgumentErrorClass < Actor
+  self.argument_error_class = MyCustomArgumentError
+
+  output :name, type: String
+
+  def call
+    self.name = 42
+  end
+end