interaktor 0.5.1 → 0.6.0.pre

data/lib/interaktor/error/attribute_error.rb

@@ -1,9 +1,9 @@
 class Interaktor::Error::AttributeError < Interaktor::Error::Base
-  # @return [Array<Symbol>]
+  # @return [Array<String>]
   attr_reader :attributes
 
   # @param interaktor [Class]
-  # @param attributes [Array<Symbol>]
+  # @param attributes [Array<String>]
   def initialize(interaktor, attributes)
     super(interaktor)
 

data/lib/interaktor/error/attribute_validation_error.rb

@@ -0,0 +1,20 @@
+class Interaktor::Error::AttributeValidationError < Interaktor::Error::Base
+  attr_reader :model
+
+  # @param model [Object]
+  def initialize(interaktor, model)
+    super(interaktor)
+
+    @model = model
+  end
+
+  # @return [Hash{Symbol=>Array<String>}]
+  def validation_errors
+    model.errors.messages
+  end
+
+  # @return [String]
+  def message
+    "Interaktor attributes failed validation:\n  #{model.errors.full_messages.join("\n  ")}"
+  end
+end

data/lib/interaktor/error/missing_explicit_success_error.rb

@@ -1,5 +1,10 @@
-class Interaktor::Error::MissingExplicitSuccessError < Interaktor::Error::AttributeError
+class Interaktor::Error::MissingExplicitSuccessError < Interaktor::Error::Base
   def message
-    "#{interaktor} interaktor execution finished successfully but requires one or more success parameters to have been provided: #{attributes.join(", ")}"
+    <<~MSG.gsub(/\s+/, " ")
+      #{interaktor} interaktor execution finished successfully, but the
+      interaktor definition includes a `success` attribute definition, and as a
+      result the interaktor must call the `success!` method with the appropriate
+      attributes.
+    MSG
   end
 end

data/lib/interaktor/error/organizer_missing_passed_attribute_error.rb

@@ -1,21 +1,21 @@
 class Interaktor::Error::OrganizerMissingPassedAttributeError < Interaktor::Error::AttributeError
-  # @return [Symbol]
+  # @return [String]
   attr_reader :attribute
 
   # @param next_interaktor [Class]
-  # @param attribute [Symbol]
+  # @param attribute [Symbol, String]
   def initialize(interaktor, attribute)
-    super(interaktor, [attribute])
+    super(interaktor, [attribute.to_s])
 
-    @attribute = attribute
+    @attribute = attribute.to_s
   end
 
   def message
     <<~MESSAGE.strip.tr("\n", " ")
-      An organized #{interaktor} interaktor requires a '#{attribute}' input
+      An organized #{interaktor} interaktor defines 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.
+      organizer list it as a success attribute, and the organizer does not
+      define it as an input attribute.
     MESSAGE
   end
 end

data/lib/interaktor/error/organizer_success_attribute_missing_error.rb

@@ -1,13 +1,13 @@
 class Interaktor::Error::OrganizerSuccessAttributeMissingError < Interaktor::Error::AttributeError
-  # @return [Symbol]
+  # @return [String]
   attr_reader :attribute
 
   # @param interaktor [Class]
-  # @param attribute [Symbol]
+  # @param attribute [Symbol, String]
   def initialize(interaktor, attribute)
-    super(interaktor, [attribute])
+    super(interaktor, [attribute.to_s])
 
-    @attribute = attribute
+    @attribute = attribute.to_s
   end
 
   def message

data/lib/interaktor/error/unknown_attribute_error.rb

@@ -1,13 +1,13 @@
 class Interaktor::Error::UnknownAttributeError < Interaktor::Error::AttributeError
-  # @return [Symbol]
+  # @return [String]
   attr_reader :attribute
 
   # @param interaktor [Class]
-  # @param attribute [Symbol]
+  # @param attribute [Symbol, String]
   def initialize(interaktor, attribute)
-    super(interaktor, [attribute])
+    super(interaktor, [attribute.to_s])
 
-    @attribute = attribute
+    @attribute = attribute.to_s
   end
 
   def message

data/lib/interaktor/interaction.rb

@@ -1,6 +1,15 @@
+require "active_model"
+
 module Interaktor
   class Interaction
-    attr_reader :input_args, :success_args, :failure_args
+    # @return [InputAttributesModel, nil]
+    attr_reader :input_object
+
+    # @return [SuccessAttributesModel, nil]
+    attr_reader :success_object
+
+    # @return [FailureAttributesModel, nil]
+    attr_reader :failure_object
 
     # @param interaktor [Interaktor]
     # @param input [Hash, Interaction]
@@ -10,16 +19,36 @@ module Interaktor
       @failed = false
       @rolled_back = false
 
-      @input_args = case input
-      when Hash
-        input.transform_keys(&:to_sym)
-      when Interaction
-        input
-          .input_args
-          .merge(input.success_args || {})
-          .slice(*(interaktor.class.input_attributes || []))
-      else
-        raise ArgumentError, "Invalid input type: #{input.class}"
+      @input_object = if defined?(interaktor.class::InputAttributesModel)
+        result = interaktor.class::InputAttributesModel.new
+
+        case input
+        when Hash
+          input.each do |k, v|
+            result.send("#{k}=", v)
+          rescue NoMethodError => e
+            if e.receiver == result
+              raise Interaktor::Error::UnknownAttributeError.new(interaktor, k)
+            else
+              raise e
+            end
+          end
+        when Interaction
+          (input.input_object&.attributes || {})
+            .merge(input.success_object&.attributes || {})
+            .slice(*result.attribute_names)
+            .each { |k, v| result.send("#{k}=", v) }
+        else
+          raise ArgumentError, "Invalid input type: #{input.class}"
+        end
+
+        if !result.valid?
+          raise Interaktor::Error::AttributeValidationError.new(@interaktor, result)
+        end
+
+        result
+      elsif input.is_a?(Hash) && !input.empty?
+        raise Interaktor::Error::UnknownAttributeError.new(interaktor, input.keys.first)
       end
     end
 
@@ -60,7 +89,23 @@ module Interaktor
 
       @executed = true
       @failed = true
-      @failure_args = args.transform_keys(&:to_sym)
+
+      if defined?(@interaktor.class::FailureAttributesModel)
+        @failure_object = @interaktor.class::FailureAttributesModel.new.tap do |obj|
+          args.each do |k, v|
+            obj.send("#{k}=", v)
+          rescue NoMethodError
+            raise Interaktor::Error::UnknownAttributeError.new(@interaktor, k)
+          end
+
+          if !obj.valid?
+            raise Interaktor::Error::AttributeValidationError.new(@interaktor, obj)
+          end
+        end
+      elsif args.any?
+        raise Interaktor::Error::UnknownAttributeError.new(@interaktor, args.keys.first)
+      end
+
       raise Interaktor::Failure, self
     end
 
@@ -74,16 +119,24 @@ module Interaktor
       end
 
       @executed = true
-      @success_args = args.transform_keys(&:to_sym)
-      early_return!
-    end
 
-    def allowable_success_attributes
-      @interaktor.class.success_attributes
-    end
+      if defined?(@interaktor.class::SuccessAttributesModel)
+        @success_object = @interaktor.class::SuccessAttributesModel.new.tap do |obj|
+          args.each do |k, v|
+            obj.send("#{k}=", v)
+          rescue NoMethodError
+            raise Interaktor::Error::UnknownAttributeError.new(@interaktor, k)
+          end
+
+          if !obj.valid?
+            raise Interaktor::Error::AttributeValidationError.new(@interaktor, obj)
+          end
+        end
+      elsif args.any?
+        raise Interaktor::Error::UnknownAttributeError.new(@interaktor, args.keys.first)
+      end
 
-    def allowable_failure_attributes
-      @interaktor.class.failure_attributes
+      early_return!
     end
 
     # Only allow access to arguments when appropriate. Input arguments should be
@@ -91,21 +144,22 @@ module Interaktor
     # execution is complete, either the success or failure arguments should be
     # accessible, depending on the outcome.
     def method_missing(method_name, *args, &block)
-      if !@executed && @interaktor.class.input_attributes.include?(method_name)
-        input_args[method_name]
-      elsif @executed && success? && allowable_success_attributes.include?(method_name)
-        success_args[method_name]
-      elsif @executed && failure? && allowable_failure_attributes.include?(method_name)
-        failure_args[method_name]
+      method_string = method_name.to_s
+      if !@executed && input_object&.attribute_names&.include?(method_string)
+        input_object.send(method_string)
+      elsif @executed && success? && success_object&.attribute_names&.include?(method_string)
+        success_object.send(method_string)
+      elsif @executed && failure? && failure_object&.attribute_names&.include?(method_string)
+        failure_object.send(method_string)
       else
         super
       end
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      input_args.key?(method_name) ||
-        success_args&.key?(method_name) ||
-        failure_args&.key?(method_name) ||
+      input_object&.attribute_names&.include?(method_name) ||
+        success_object&.attribute_names&.include?(method_name) ||
+        failure_object&.attribute_names&.include?(method_name) ||
         super
     end
 

data/lib/interaktor/organizer.rb

@@ -39,8 +39,6 @@ module Interaktor::Organizer
     #
     # @return [void]
     def call
-      check_attribute_flow_valid
-
       latest_interaction = nil
 
       self.class.organized.each do |interaktor|
@@ -49,39 +47,13 @@ module Interaktor::Organizer
         end
       end
 
-      if latest_interaction
-        @interaction.instance_variable_set(:@success_args, latest_interaction.success_args)
-      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
+      if defined?(self.class::SuccessAttributesModel)
+        @interaction.success!(
+          latest_interaction
+            .success_object
+            &.attributes
+            &.slice(*self.class::SuccessAttributesModel.attribute_names) || {}
+        )
       end
     end
   end

data/lib/interaktor.rb

@@ -15,9 +15,7 @@ module Interaktor
       include Hooks
       include Callable
 
-      interaction_class = Class.new(Interaktor::Interaction) do
-      end
-
+      interaction_class = Class.new(Interaktor::Interaction)
       base.const_set(:Interaction, interaction_class)
     end
   end
@@ -31,23 +29,13 @@ module Interaktor
     @interaction = self.class::Interaction.new(self, args)
   end
 
-  # @param args [Hash{Symbol=>Object}]
+  # @param args [Hash]
   def fail!(args = {})
-    if (disallowed_key = args.keys.find { |k| !self.class.failure_attributes.include?(k.to_sym) })
-      raise Interaktor::Error::UnknownAttributeError.new(self, disallowed_key)
-    end
-
-    self.class.validate_failure_schema(args)
     @interaction.fail!(args)
   end
 
   # @param args [Hash]
   def success!(args = {})
-    if (disallowed_key = args.keys.find { |k| !self.class.success_attributes.include?(k.to_sym) })
-      raise Interaktor::Error::UnknownAttributeError.new(self, disallowed_key)
-    end
-
-    self.class.validate_success_schema(args)
     @interaction.success!(args)
   end
 
@@ -87,10 +75,6 @@ module Interaktor
         call
       end
 
-      if self.class.required_success_attributes.any? && !@interaction.success_args
-        raise Interaktor::Error::MissingExplicitSuccessError.new(self, self.class.required_success_attributes)
-      end
-
       @interaction.called!(self)
     end
   rescue