active_interaction 4.0.5 → 5.0.0

data/lib/active_interaction/filters/array_filter.rb

@@ -8,6 +8,8 @@ module ActiveInteraction
     #
     #   @!macro filter_method_params
     #   @param block [Proc] filter method to apply to each element
+    #   @option options [Boolean] :index_errors (ActiveRecord.index_nested_attribute_errors) returns errors with an
+    #     index
     #
     #   @example
     #     array :ids
@@ -36,8 +38,37 @@ module ActiveInteraction
 
     register :array
 
+    def process(value, context)
+      input = super
+
+      return ArrayInput.new(self, value: input.value, error: input.errors.first) if input.errors.any?
+      return ArrayInput.new(self, value: default(context), error: input.errors.first) if input.value.nil?
+
+      value = input.value
+      error = nil
+      children = []
+
+      unless filters.empty?
+        value.each do |item|
+          children.push(filters[:'0'].process(item, context))
+        end
+      end
+
+      ArrayInput.new(self, value: value, error: error, children: children, index_errors: index_errors?)
+    end
+
     private
 
+    def index_errors?
+      default =
+        if ::ActiveRecord.respond_to?(:index_nested_attribute_errors)
+          ::ActiveRecord.index_nested_attribute_errors # Moved to here in Rails 7.0
+        else
+          ::ActiveRecord::Base.index_nested_attribute_errors
+        end
+      options.fetch(:index_errors, default)
+    end
+
     def klasses
       %w[
         ActiveRecord::Relation
@@ -55,16 +86,13 @@ module ActiveInteraction
       false
     end
 
-    def adjust_output(value, context)
-      return value if filters.empty?
-
-      filter = filters.values.first
-      value.map { |e| filter.clean(e, context) }
+    def adjust_output(value, _context)
+      value.to_a
     end
 
     def convert(value)
       if value.respond_to?(:to_ary)
-        value.to_ary
+        [value.to_ary, nil]
       else
         super
       end
@@ -91,7 +119,7 @@ module ActiveInteraction
 
         filters[filters.size.to_s.to_sym] = filter
 
-        validate!(filter, names)
+        validate!(names)
       end
     end
     # rubocop:enable Style/MissingRespondToMissing
@@ -100,13 +128,11 @@ module ActiveInteraction
     # @param names [Array<Symbol>]
     #
     # @raise [InvalidFilterError]
-    def validate!(filter, names)
+    def validate!(names)
       raise InvalidFilterError, 'multiple filters in array block' if filters.size > 1
 
       raise InvalidFilterError, 'attribute names in array block' unless names.empty?
 
-      raise InvalidDefaultError, 'default values in array block' if filter.default?
-
       nil
     end
   end

data/lib/active_interaction/filters/boolean_filter.rb

@@ -6,7 +6,8 @@ module ActiveInteraction
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are Booleans. The strings `"1"`, `"true"`, and `"on"`
     #     (case-insensitive) are converted to `true` while the strings `"0"`,
-    #     `"false"`, and `"off"` are converted to `false`.
+    #     `"false"`, and `"off"` are converted to `false`. Blank strings are
+    #     treated as a `nil` value.
     #
     #   @!macro filter_method_params
     #
@@ -38,9 +39,9 @@ module ActiveInteraction
 
       case value
       when /\A(?:0|false|off)\z/i
-        false
+        [false, nil]
       when /\A(?:1|true|on)\z/i
-        true
+        [true, nil]
       else
         super
       end

data/lib/active_interaction/filters/date_filter.rb

@@ -6,7 +6,7 @@ module ActiveInteraction
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are Dates. String values are processed using `parse`
     #     unless the format option is given, in which case they will be
-    #     processed with `strptime`.
+    #     processed with `strptime`. Blank strings are treated as a `nil` value.
     #
     #   @!macro filter_method_params
     #   @option options [String] :format parse strings using this format string

data/lib/active_interaction/filters/date_time_filter.rb

@@ -6,7 +6,7 @@ module ActiveInteraction
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are DateTimes. String values are processed using
     #     `parse` unless the format option is given, in which case they will be
-    #     processed with `strptime`.
+    #     processed with `strptime`. Blank strings are treated as a `nil` value.
     #
     #   @!macro filter_method_params
     #   @option options [String] :format parse strings using this format string

data/lib/active_interaction/filters/decimal_filter.rb

@@ -7,7 +7,7 @@ module ActiveInteraction
     # @!method self.decimal(*attributes, options = {})
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are BigDecimals. Numerics and String values are
-    #     converted into BigDecimals.
+    #     converted into BigDecimals. Blank strings are treated as a `nil` value.
     #
     #   @!macro filter_method_params
     #

data/lib/active_interaction/filters/float_filter.rb

@@ -5,7 +5,7 @@ module ActiveInteraction
     # @!method self.float(*attributes, options = {})
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are Floats. Integer and String values are converted
-    #     into Floats.
+    #     into Floats. Blank strings are treated as a `nil` value.
     #
     #   @!macro filter_method_params
     #

data/lib/active_interaction/filters/hash_filter.rb

@@ -25,6 +25,26 @@ module ActiveInteraction
 
     register :hash
 
+    def process(value, context)
+      input = super
+
+      return HashInput.new(self, value: input.value, error: input.errors.first) if input.errors.first
+      return HashInput.new(self, value: default(context), error: input.errors.first) if input.value.nil?
+
+      value = strip? ? HashWithIndifferentAccess.new : input.value
+      error = nil
+      children = {}
+
+      filters.each do |name, filter|
+        filter.process(input.value[name], context).tap do |result|
+          value[name] = result.value
+          children[name.to_sym] = result
+        end
+      end
+
+      HashInput.new(self, value: value, error: error, children: children)
+    end
+
     private
 
     def matches?(value)
@@ -33,29 +53,17 @@ module ActiveInteraction
       false
     end
 
-    def clean_value(hash, name, filter, value, context)
-      hash[name] = filter.clean(value[name], context)
-    rescue InvalidValueError, MissingValueError
-      raise InvalidNestedValueError.new(name, value[name])
-    end
-
     def strip?
       options.fetch(:strip, true)
     end
 
-    def adjust_output(value, context)
-      value = ActiveSupport::HashWithIndifferentAccess.new(value.to_hash)
-
-      initial = strip? ? ActiveSupport::HashWithIndifferentAccess.new : value
-
-      filters.each_with_object(initial) do |(name, filter), hash|
-        clean_value(hash, name.to_s, filter, value, context)
-      end
+    def adjust_output(value, _context)
+      ActiveSupport::HashWithIndifferentAccess.new(value)
     end
 
     def convert(value)
       if value.respond_to?(:to_hash)
-        value.to_hash
+        [value.to_hash, nil]
       else
         super
       end

data/lib/active_interaction/filters/integer_filter.rb

@@ -5,7 +5,7 @@ module ActiveInteraction
     # @!method self.integer(*attributes, options = {})
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are Integers. String values are converted into
-    #     Integers.
+    #     Integers. Blank strings are treated as a `nil` value.
     #
     #   @!macro filter_method_params
     #   @option options [Integer] :base (10) The base used to convert strings

data/lib/active_interaction/filters/interface_filter.rb

@@ -47,34 +47,34 @@ module ActiveInteraction
         "constant #{const_name.inspect} does not exist"
     end
 
-    def matches?(object)
-      return false if object.nil?
-      return matches_methods?(object) if options.key?(:methods)
+    def matches?(value)
+      return false if value == nil # rubocop:disable Style/NilComparison
+      return matches_methods?(value) if options.key?(:methods)
 
       const = from
-      if checking_class_inheritance?(object, const)
-        class_inherits_from?(object, const)
+      if checking_class_inheritance?(value, const)
+        class_inherits_from?(value, const)
       else
-        singleton_ancestor?(object, const)
+        singleton_ancestor?(value, const)
       end
     rescue NoMethodError
       false
     end
 
-    def matches_methods?(object)
-      options[:methods].all? { |method| object.respond_to?(method) }
+    def matches_methods?(value)
+      options[:methods].all? { |method| value.respond_to?(method) }
     end
 
-    def checking_class_inheritance?(object, from)
-      object.is_a?(Class) && from.is_a?(Class)
+    def checking_class_inheritance?(value, from)
+      value.is_a?(Class) && from.is_a?(Class)
     end
 
     def class_inherits_from?(klass, inherits_from)
       klass != inherits_from && klass.ancestors.include?(inherits_from)
     end
 
-    def singleton_ancestor?(object, from)
-      object.class != from && object.singleton_class.ancestors.include?(from)
+    def singleton_ancestor?(value, from)
+      value.class != from && value.singleton_class.ancestors.include?(from)
     end
   end
 end

data/lib/active_interaction/filters/object_filter.rb

@@ -38,19 +38,25 @@ module ActiveInteraction
     end
 
     def matches?(value)
+      return false if value == nil # rubocop:disable Style/NilComparison
+
       value.class <= klass
     rescue NoMethodError
       false
     end
 
     def convert(value)
-      converter(value).tap do |result|
-        raise InvalidValueError if result.nil?
+      result = converter(value)
+
+      if result.nil?
+        [value, Filter::Error.new(self, :invalid_type)]
+      else
+        [result, nil]
       end
     rescue StandardError => e
       raise e if e.is_a?(InvalidConverterError)
 
-      raise InvalidValueError
+      [value, Filter::Error.new(self, :invalid_type)]
     end
 
     def converter(value)

data/lib/active_interaction/filters/record_filter.rb

@@ -4,7 +4,9 @@ module ActiveInteraction
   class Base # rubocop:disable Lint/EmptyClass
     # @!method self.record(*attributes, options = {})
     #   Creates accessors for the attributes and ensures that values passed to
-    #     the attributes are the correct class.
+    #     the attributes are the correct class. Blank strings passed in will be
+    #     treated as `nil` and the `finder` will not be called.
+
     #
     #   @!macro filter_method_params
     #   @option options [Class, String, Symbol] :class (use the attribute name)
@@ -44,20 +46,28 @@ module ActiveInteraction
     end
 
     def convert(value)
-      finder = options.fetch(:finder, :find)
-      find(klass, value, finder)
-    end
+      return [nil, nil] if blank_string?(value)
 
-    def find(klass, value, finder)
-      result = klass.public_send(finder, value)
+      finder = options.fetch(:finder, :find)
+      result = find(klass, value, finder)
 
-      raise InvalidValueError if result.nil?
+      if result.nil?
+        [value, Filter::Error.new(self, :invalid_type)]
+      else
+        [result, nil]
+      end
+    end
 
-      result
-    rescue StandardError => e
-      raise e if e.is_a?(InvalidConverterError)
+    def blank_string?(value)
+      value.is_a?(String) && value.blank?
+    rescue NoMethodError # BasicObject
+      false
+    end
 
-      raise InvalidValueError
+    def find(klass, value, finder)
+      klass.public_send(finder, value)
+    rescue StandardError
+      nil
     end
   end
 end

data/lib/active_interaction/filters/string_filter.rb

@@ -38,7 +38,7 @@ module ActiveInteraction
 
     def convert(value)
       if value.respond_to?(:to_str)
-        value.to_str
+        [value.to_str, nil]
       else
         super
       end

data/lib/active_interaction/filters/symbol_filter.rb

@@ -26,7 +26,7 @@ module ActiveInteraction
 
     def convert(value)
       if value.respond_to?(:to_sym)
-        value.to_sym
+        [value.to_sym, nil]
       else
         super
       end

data/lib/active_interaction/filters/time_filter.rb

@@ -6,9 +6,9 @@ module ActiveInteraction
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are Times. Numeric values are processed using `at`.
     #     Strings are processed using `parse` unless the format option is
-    #     given, in which case they will be processed with `strptime`. If
-    #     `Time.zone` is available it will be used so that the values are time
-    #     zone aware.
+    #     given, in which case they will be processed with `strptime`. Blank
+    #     strings are treated as a `nil` value. If `Time.zone` is available it
+    #     will be used so that the values are time zone aware.
     #
     #   @!macro filter_method_params
     #   @option options [String] :format parse strings using this format string
@@ -59,7 +59,7 @@ module ActiveInteraction
       value = value.to_int if value.respond_to?(:to_int)
 
       if value.is_a?(Numeric)
-        klass.at(value)
+        [klass.at(value), nil]
       else
         super
       end

data/lib/active_interaction/hash_input.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveInteraction
+  # Represents a processed hash input.
+  class HashInput < Input
+    # @private
+    def initialize(filter, value: nil, error: nil, children: {})
+      super(filter, value: value, error: error)
+
+      @children = children
+    end
+
+    # @overload children
+    #   Child inputs if nested filters are used.
+    #
+    #   @return [Hash{ Symbol => Input, ArrayInput, HashInput }]
+    attr_reader :children
+
+    # Any errors that occurred during processing.
+    #
+    # @return [Filter::Error]
+    def errors
+      return @errors if defined?(@errors)
+
+      return @errors = super if @error
+
+      child_errors = get_errors(children)
+
+      return @errors = super if child_errors.empty?
+
+      @errors ||=
+        child_errors.map do |error|
+          Filter::Error.new(error.filter, error.type, name: :"#{@filter.name}.#{error.name}")
+        end.freeze
+    end
+
+    private
+
+    def get_errors(children)
+      children.values.flat_map(&:errors)
+    end
+  end
+end

data/lib/active_interaction/input.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveInteraction
+  # Represents a processed input.
+  class Input
+    # @private
+    def initialize(filter, value: nil, error: nil)
+      @filter = filter
+      @value = value
+      @error = error
+    end
+
+    # The processed input value.
+    attr_reader :value
+
+    # Any errors that occurred during processing.
+    #
+    # @return [Filter::Error]
+    def errors
+      @errors ||= Array(@error)
+    end
+  end
+end