Require filter definition for each input

[nvanoorschot]

We sometimes use AI to manually perform certain custom actions. This exposes us to human errors in the naming of optional arguments. Is it possible to have AI fail if arguments are passed for which no filter has been defined?

Example

class ObjectInteraction < ActiveInteraction::Base
  boolean :commit, default: true

  def execute
    commit_transaction if commit?
  end
end

This command will unintentionally commit the transaction since the argument is misspelled.

ObjectInteraction.run!(comit: false)

Solution?

Introduce a class method and/or global option that changes the default behavior.

class ObjectInteraction < ActiveInteraction::Base
  enforce_filters!
end

ObjectInteraction.run!(comit: false)
# => ActiveInteraction::MissingFilterError: no filter defined for argument `comit`

[antulik]

I think that might be useful to have, in the meantime it's possible with a simple module

module EnforceFilters
  extend ActiveSupport::Concern

  MissingFilterError = Class.new(StandardError)

  included do
    class_attribute :enforce_filters
  end

  def populate_reader(key, value)
    if enforce_filters && !respond_to?(key)
      raise MissingFilterError, "no filter defined for argument `#{key}`"
    end
    super
  end

  class_methods do
    def enforce_filters!
      self.enforce_filters = true
    end
  end
end

class ObjectInteraction < ActiveInteraction::Base
  include EnforceFilters

  boolean :commit, default: true

  enforce_filters!

  def execute
    commit
  end
end

ObjectInteraction.run!(comit: false)
# => no filter defined for argument `comit` (EnforceFilters::MissingFilterError)

[MathijsK93]

I rewrote the example from @antulik so it works for 4.0.5

module EnforceFilters
  extend ActiveSupport::Concern

  MissingFilterError = Class.new(StandardError)

  included do
    class_attribute :enforce_filters
  end

  def populate_filters_and_inputs(inputs)
    validate_arguments(inputs.keys) if enforce_filters

    super
  end

  def validate_arguments(arguments)
    arguments.each do |argument|
      raise MissingFilterError, "no filter defined for argument `#{argument}`" unless respond_to?(argument)
    end
  end

  class_methods do
    def enforce_filters!
      self.enforce_filters = true
    end
  end
end

class ObjectInteraction < ActiveInteraction::Base
  include EnforceFilters

  boolean :commit, default: true

  enforce_filters!

  def execute
    commit
  end
end

ObjectInteraction.run!(comit: false)
# => no filter defined for argument `comit` (EnforceFilters::MissingFilterError)