interaktor 0.2.0 → 0.3.0

data/lib/interaktor/error/attribute_error.rb

@@ -10,7 +10,9 @@ class Interaktor::Error::AttributeError < Interaktor::Error::Base
     @attributes = attributes
   end
 
+  # @return [String]
+  # @abstract
   def message
-    raise NotImplementedError
+    raise NoMethodError
   end
 end

data/lib/interaktor/error/attribute_schema_validation_error.rb

@@ -0,0 +1,54 @@
+class Interaktor::Error::AttributeSchemaValidationError < Interaktor::Error::Base
+  # @return [Hash{Symbol=>Array<String>}]
+  attr_reader :validation_errors
+
+  # @param interaktor [Class]
+  # @param validation_errors [Hash{Symbol=>Array<String>}]
+  def initialize(interaktor, validation_errors)
+    super(interaktor)
+
+    @validation_errors = validation_errors
+  end
+
+  # @return [String]
+  # @abstract
+  def message
+    "Interaktor attribute schema failed validation:\n  #{error_list}"
+  end
+
+  private
+
+  # @return [String]
+  def error_list
+    result = ""
+
+    validation_errors.each do |attribute, errors|
+      result << error_entry(attribute, errors)
+    end
+
+    result
+  end
+
+  def error_entry(key, value, depth = 0)
+    result = " " * depth * 2
+
+    case value
+    when Hash
+      result << "#{key}:\n"
+      value.each do |sub_key, sub_value|
+        result << "  "
+        result << error_entry(sub_key, sub_value, depth + 1)
+      end
+    when Array
+      result << "#{key}:\n"
+      value.each do |error_message|
+        result << "  "
+        result << error_entry(nil, error_message, depth + 1)
+      end
+    else
+      result << "- #{value}\n"
+    end
+
+    result
+  end
+end

data/lib/interaktor/error/missing_explicit_success_error.rb

@@ -0,0 +1,5 @@
+class Interaktor::Error::MissingExplicitSuccessError < Interaktor::Error::AttributeError
+  def message
+    "#{interaktor} interaktor execution finished successfully but requires one or more success parameters to have been provided: #{attributes.join(", ")}"
+  end
+end

data/lib/interaktor/error/option_error.rb

@@ -10,7 +10,9 @@ class Interaktor::Error::OptionError < Interaktor::Error::Base
     @options = options
   end
 
+  # @return [String]
+  # @abstract
   def message
-    raise NotImplementedError
+    raise NoMethodError
   end
 end

data/lib/interaktor/error/organizer_missing_passed_attribute_error.rb

@@ -0,0 +1,21 @@
+class Interaktor::Error::OrganizerMissingPassedAttributeError < Interaktor::Error::AttributeError
+  # @return [Symbol]
+  attr_reader :attribute
+
+  # @param next_interaktor [Class]
+  # @param attribute [Symbol]
+  def initialize(interaktor, attribute)
+    super(interaktor, [attribute])
+
+    @attribute = attribute
+  end
+
+  def message
+    <<~MESSAGE.strip.tr("\n", "")
+      An organized #{interaktor} interaktor requires a '#{attribute}' input
+      attribute, but none of the interaktors that come before it in the
+      organizer list it as a success attribute, and the organizer does not list
+      it as a required attribute.
+    MESSAGE
+  end
+end

data/lib/interaktor/error/organizer_success_attribute_missing_error.rb

@@ -0,0 +1,20 @@
+class Interaktor::Error::OrganizerSuccessAttributeMissingError < Interaktor::Error::AttributeError
+  # @return [Symbol]
+  attr_reader :attribute
+
+  # @param interaktor [Class]
+  # @param attribute [Symbol]
+  def initialize(interaktor, attribute)
+    super(interaktor, [attribute])
+
+    @attribute = attribute
+  end
+
+  def message
+    <<~MESSAGE.strip.tr("\n", "")
+      A #{interaktor} organizer requires a '#{attribute}' success attribute,
+      but none of the success attributes provided by any of the organized
+      interaktors list it.
+    MESSAGE
+  end
+end

data/lib/interaktor/organizer.rb

@@ -39,16 +39,42 @@ module Interaktor::Organizer
     #
     # @return [void]
     def call
-      self.class.organized.each do |interaktor|
-        # Take the context that is being passed to each interaktor and remove
-        # any attributes from it that are not required by the interactor.
-        @context.to_h
-                .keys
-                .reject { |attr| interaktor.input_attributes.include?(attr) }
-                .each { |attr| @context.delete_field(attr) }
+      check_attribute_flow_valid
 
+      self.class.organized.each do |interaktor|
         catch(:early_return) { interaktor.call!(@context) }
       end
     end
+
+    private
+
+    # @return [void]
+    def check_attribute_flow_valid
+      interaktors = self.class.organized
+
+      # @type [Array<Symbol>]
+      success_attributes_so_far = []
+
+      success_attributes_so_far += self.class.required_input_attributes
+
+      # @param interaktor [Class]
+      interaktors.each do |interaktor|
+        interaktor.required_input_attributes.each do |required_attr|
+          unless success_attributes_so_far.include?(required_attr)
+            raise Interaktor::Error::OrganizerMissingPassedAttributeError.new(interaktor, required_attr)
+          end
+        end
+
+        success_attributes_so_far += interaktor.success_attributes
+
+        next unless interaktor == interaktors.last
+
+        self.class.success_attributes.each do |success_attr|
+          unless success_attributes_so_far.include?(success_attr)
+            raise Interaktor::Error::OrganizerSuccessAttributeMissingError.new(interaktor, success_attr)
+          end
+        end
+      end
+    end
   end
 end

data/spec/integration_spec.rb

@@ -3,37 +3,7 @@
 # rubocop:disable RSpec/ScatteredSetup
 # rubocop:disable Style/DocumentationMethod
 
-describe "Integration" do
-  def build_interaktor(&block)
-    Class.new.tap do |interaktor|
-      interaktor.send(:include, Interaktor)
-      interaktor.class_eval(&block) if block
-      interaktor.class_eval do
-        optional :steps
-
-        def unexpected_error!
-          raise "foo"
-        end
-      end
-    end
-  end
-
-  def build_organizer(options = {}, &block)
-    Class.new.tap do |organizer|
-      organizer.send(:include, Interaktor::Organizer)
-
-      organizer.organize(options[:organize]) if options[:organize]
-      organizer.class_eval(&block) if block
-      organizer.class_eval do
-        optional :steps
-
-        def unexpected_error!
-          raise "foo"
-        end
-      end
-    end
-  end
-
+RSpec.describe "Integration" do
   # rubocop:disable Style/AsciiComments
   #
   # organizer
@@ -52,7 +22,10 @@ describe "Integration" do
 
   let(:organizer) {
     interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-    build_organizer(organize: interaktors) do
+
+    FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+      organize(interaktors)
+
       around do |interaktor|
         @context.steps << :around_before
         interaktor.call
@@ -70,7 +43,11 @@ describe "Integration" do
   }
 
   let(:organizer2) {
-    build_organizer(organize: [interaktor2a, interaktor2b, interaktor2c]) do
+    interaktors = [interaktor2a, interaktor2b, interaktor2c]
+
+    FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+      organize(interaktors)
+
       around do |interaktor|
         @context.steps << :around_before2
         interaktor.call
@@ -88,7 +65,7 @@ describe "Integration" do
   }
 
   let(:interaktor2a) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before2a
         interaktor.call
@@ -114,7 +91,7 @@ describe "Integration" do
   }
 
   let(:interaktor2b) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before2b
         interaktor.call
@@ -140,7 +117,7 @@ describe "Integration" do
   }
 
   let(:interaktor2c) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before2c
         interaktor.call
@@ -166,7 +143,7 @@ describe "Integration" do
   }
 
   let(:interaktor3) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before3
         interaktor.call
@@ -192,7 +169,11 @@ describe "Integration" do
   }
 
   let(:organizer4) {
-    build_organizer(organize: [interaktor4a, interaktor4b, interaktor4c]) do
+    interaktors = [interaktor4a, interaktor4b, interaktor4c]
+
+    FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+      organize(interaktors)
+
       around do |interaktor|
         @context.steps << :around_before4
         interaktor.call
@@ -210,7 +191,7 @@ describe "Integration" do
   }
 
   let(:interaktor4a) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before4a
         interaktor.call
@@ -236,7 +217,7 @@ describe "Integration" do
   }
 
   let(:interaktor4b) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before4b
         interaktor.call
@@ -262,7 +243,7 @@ describe "Integration" do
   }
 
   let(:interaktor4c) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before4c
         interaktor.call
@@ -288,7 +269,7 @@ describe "Integration" do
   }
 
   let(:interaktor5) {
-    build_interaktor do
+    FakeInteraktor.build_interaktor do
       around do |interaktor|
         @context.steps << :around_before5
         interaktor.call
@@ -341,7 +322,10 @@ describe "Integration" do
   context "when an around hook fails early" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           @context.fail!
           @context.steps << :around_before
@@ -370,7 +354,10 @@ describe "Integration" do
   context "when an around hook errors early" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           unexpected_error!
           @context.steps << :around_before
@@ -386,6 +373,10 @@ describe "Integration" do
         after do
           @context.steps << :after
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -409,7 +400,10 @@ describe "Integration" do
   context "when a before hook fails" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           @context.steps << :around_before
           interaktor.call
@@ -439,7 +433,10 @@ describe "Integration" do
   context "when a before hook errors" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           @context.steps << :around_before
           interaktor.call
@@ -454,6 +451,10 @@ describe "Integration" do
         after do
           @context.steps << :after
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -479,7 +480,10 @@ describe "Integration" do
   context "when an after hook fails" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           @context.steps << :around_before
           interaktor.call
@@ -529,7 +533,10 @@ describe "Integration" do
   context "when an after hook errors" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           @context.steps << :around_before
           interaktor.call
@@ -544,6 +551,10 @@ describe "Integration" do
           unexpected_error!
           @context.steps << :after
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -589,7 +600,10 @@ describe "Integration" do
   context "when an around hook fails late" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           @context.steps << :around_before
           interaktor.call
@@ -640,7 +654,10 @@ describe "Integration" do
   context "when an around hook errors late" do
     let(:organizer) {
       interaktors = [organizer2, interaktor3, organizer4, interaktor5]
-      build_organizer(organize: interaktors) do
+
+      FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
         around do |interaktor|
           @context.steps << :around_before
           interaktor.call
@@ -655,6 +672,10 @@ describe "Integration" do
         after do
           @context.steps << :after
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -700,7 +721,7 @@ describe "Integration" do
 
   context "when a nested around hook fails early" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.fail!
           @context.steps << :around_before3
@@ -745,7 +766,7 @@ describe "Integration" do
 
   context "when a nested around hook errors early" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           unexpected_error!
           @context.steps << :around_before3
@@ -768,6 +789,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback3
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -800,7 +825,7 @@ describe "Integration" do
 
   context "when a nested before hook fails" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -846,7 +871,7 @@ describe "Integration" do
 
   context "when a nested before hook errors" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -869,6 +894,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback3
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -902,7 +931,7 @@ describe "Integration" do
 
   context "when a nested call fails" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -948,7 +977,7 @@ describe "Integration" do
 
   context "when a nested call errors" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -971,6 +1000,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback3
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1004,7 +1037,7 @@ describe "Integration" do
 
   context "when a nested after hook fails" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -1051,7 +1084,7 @@ describe "Integration" do
 
   context "when a nested after hook errors" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -1074,6 +1107,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback3
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1108,7 +1145,7 @@ describe "Integration" do
 
   context "when a nested around hook fails late" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -1155,7 +1192,7 @@ describe "Integration" do
 
   context "when a nested around hook errors late" do
     let(:interaktor3) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before3
           interaktor.call
@@ -1178,6 +1215,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback3
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1212,7 +1253,7 @@ describe "Integration" do
 
   context "when a deeply nested around hook fails early" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.fail!
           @context.steps << :around_before4b
@@ -1262,7 +1303,7 @@ describe "Integration" do
 
   context "when a deeply nested around hook errors early" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           unexpected_error!
           @context.steps << :around_before4b
@@ -1285,6 +1326,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback4b
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1322,7 +1367,7 @@ describe "Integration" do
 
   context "when a deeply nested before hook fails" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1373,7 +1418,7 @@ describe "Integration" do
 
   context "when a deeply nested before hook errors" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1396,6 +1441,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback4b
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1434,7 +1483,7 @@ describe "Integration" do
 
   context "when a deeply nested call fails" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1485,7 +1534,7 @@ describe "Integration" do
 
   context "when a deeply nested call errors" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1508,6 +1557,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback4b
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1546,7 +1599,7 @@ describe "Integration" do
 
   context "when a deeply nested after hook fails" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1598,7 +1651,7 @@ describe "Integration" do
 
   context "when a deeply nested after hook errors" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1621,6 +1674,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback4b
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1660,7 +1717,7 @@ describe "Integration" do
 
   context "when a deeply nested around hook fails late" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1712,7 +1769,7 @@ describe "Integration" do
 
   context "when a deeply nested around hook errors late" do
     let(:interaktor4b) {
-      build_interaktor do
+      FakeInteraktor.build_interaktor do
         around do |interaktor|
           @context.steps << :around_before4b
           interaktor.call
@@ -1735,6 +1792,10 @@ describe "Integration" do
         def rollback
           @context.steps << :rollback4b
         end
+
+        def unexpected_error!
+          raise "foo"
+        end
       end
     }
 
@@ -1774,7 +1835,17 @@ describe "Integration" do
 
   context "when there are multiple organize calls" do
     it "runs all passed interaktors in correct order" do
-      organizer = build_organizer(organize: [organizer2, interaktor3])
+      # organizer = build_organizer(organize: [organizer2, interaktor3])
+      interaktors = ([organizer2, interaktor3])
+
+      organizer = FakeInteraktor.build_interaktor(type: Interaktor::Organizer) do
+        organize(interaktors)
+
+        def unexpected_error!
+          raise "foo"
+        end
+      end
+
       organizer.organize(organizer4, interaktor5)
 
       expect {