Raise on non-existent kwargs

Currently filters will allow you to include keyword arguments that don't exist, leading to potentially confusing outcomes for users.
This change makes it so that unsupported keyword arguments will raise an
exception, while still allowing users to extend the available options if needed.

Author: smcabrera

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Added
 
  - Support for Ruby 3.4.
+ - Added per-filter option validation. Each filter type now validates its own specific options and raises `ArgumentError` when passed unrecognized options.
 
 ## Fixed
 

lib/active_interaction/filter.rb

@@ -51,6 +51,13 @@ def factory(slug)
         CLASSES.fetch(slug) { raise MissingFilterError, slug.inspect }
       end
 
+      # Returns the list of allowed options for this filter type.
+      #
+      # @return [Array<Symbol>]
+      def allowed_options
+        %i[desc default]
+      end
+
       private
 
       # @param slug [Symbol]
@@ -66,6 +73,7 @@ def register(slug)
     #
     # @option options [Object] :default Fallback value to use when given `nil`.
     def initialize(name, options = {}, &block)
+      validate_options!(options)
       @name = name
       @options = options.dup
       @filters = {}
@@ -229,6 +237,12 @@ def describe(value)
       "(Object doesn't support #inspect)"
     end
 
+    def validate_options!(options)
+      if (invalid_options = options.keys - self.class.allowed_options).any?
+        raise ArgumentError, "invalid options: #{invalid_options.join(', ')}"
+      end
+    end
+
     def raw_default(context)
       value = options.fetch(:default)
       return value unless value.is_a?(Proc)

lib/active_interaction/filters/abstract_date_time_filter.rb

@@ -8,6 +8,10 @@ module ActiveInteraction
   #
   # @private
   class AbstractDateTimeFilter < Filter
+    def self.allowed_options
+      super + %i[format]
+    end
+
     def database_column_type
       self.class.slug
     end

lib/active_interaction/filters/array_filter.rb

@@ -38,6 +38,10 @@ class ArrayFilter < Filter
 
     register :array
 
+    def self.allowed_options
+      super + %i[index_errors]
+    end
+
     def process(value, context)
       input = super
 

lib/active_interaction/filters/decimal_filter.rb

@@ -19,6 +19,10 @@ class Base # rubocop:disable Lint/EmptyClass
   class DecimalFilter < AbstractNumericFilter
     register :decimal
 
+    def self.allowed_options
+      super + %i[digits]
+    end
+
     private
 
     def digits

lib/active_interaction/filters/hash_filter.rb

@@ -25,6 +25,10 @@ class HashFilter < Filter
 
     register :hash
 
+    def self.allowed_options
+      super + %i[strip]
+    end
+
     def process(value, context) # rubocop:disable Metrics/AbcSize
       input = super
 

lib/active_interaction/filters/integer_filter.rb

@@ -20,6 +20,10 @@ class Base # rubocop:disable Lint/EmptyClass
   class IntegerFilter < AbstractNumericFilter
     register :integer
 
+    def self.allowed_options
+      super + %i[base]
+    end
+
     private
 
     def base

lib/active_interaction/filters/interface_filter.rb

@@ -28,6 +28,10 @@ class Base # rubocop:disable Lint/EmptyClass
   class InterfaceFilter < Filter
     register :interface
 
+    def self.allowed_options
+      super + %i[from methods]
+    end
+
     def initialize(name, options = {}, &block)
       if options.key?(:methods) && options.key?(:from)
         raise InvalidFilterError,

lib/active_interaction/filters/object_filter.rb

@@ -28,6 +28,10 @@ class Base # rubocop:disable Lint/EmptyClass
   class ObjectFilter < Filter
     register :object
 
+    def self.allowed_options
+      super + %i[class converter]
+    end
+
     private
 
     def klass

lib/active_interaction/filters/record_filter.rb

@@ -30,6 +30,10 @@ class Base # rubocop:disable Lint/EmptyClass
   class RecordFilter < Filter
     register :record
 
+    def self.allowed_options
+      super + %i[class finder]
+    end
+
     private
 
     def klass