interactor_support 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6d8c9f46a3e48520652cdb83a9257d487a3411feef0b1efd69c1fc4a209c03
-  data.tar.gz: 31b939d573a1dc042b671304ec777bf4a8bf53ad61bd3b4d63fccc3fd4dd2806
+  metadata.gz: bf8cda13999c9971a1499398e23135ef6e870af7581ffe7e9f173b9d7c4231ea
+  data.tar.gz: 48c401b5b42e80ccea3db170ecb1e8476861522804b800ad28651eebfa674222
 SHA512:
-  metadata.gz: 2cf4e789be122df812109df549d3d94a4cf685af0a85eb3fa3d47e811fc73d2231a4fd5af95a2e3c397505102c363bb831df716f16fe701fa0e2fd33e586e757
-  data.tar.gz: 8d6e5ee59b6c0523d0d7a9931d6b0ee4f1f98c7aa7d87aabfd45f8dcad8b9f7831444030803abc98bf0594b87a9e084cc9285e8f7382dd378f0d68f4fdc79823
+  metadata.gz: 2adf5f317e6432571a24358e9e1ba453397fcfd5f6b83758930fd45bef652dfb01ead87aa68fcfec385151bd60646127a087968e332baa0193e5bb9f7ac14ff6
+  data.tar.gz: a6a670cacb4abd50812a82232dcbeb1e582eea72d3526b2659f4dccd827226c6e07c6b12f6c39b282eb276db482d02911cd4d0e125094f8c1d114fba5459c899

data/CHANGELOG.md

@@ -21,3 +21,17 @@
 ## [1.0.4] - 2025-04-05
 
 - Added the organizable concern
+
+## [1.0.5] - 2025-06-30
+
+- Add support for ignoring unknown attributes in RequestObjects via `ignore_unknown_attributes` class method
+- Introduce `InteractorSupport.configuration.log_unknown_request_object_attributes` to optionally log ignored attributes
+- Introduce `InteractorSupport.configuration.logger` and `log_level` for customizable logging
+- Override `assign_attributes` to integrate attribute ignoring and error-raising behavior
+- Improve test coverage for unknown attribute handling and logging
+
+## [1.0.6] - 2025-09-24
+
+- Wrap request object validation failures from `Organizable#organize` in `InteractorSupport::Errors::InvalidRequestObject` for consistent controller handling
+- Honor `configuration.log_unknown_request_object_attributes` when logging ignored request object keys
+- Improve request object error messaging for failed casts and unknown attributes

data/README.md

@@ -148,6 +148,7 @@ Instead of raw hashes, **Request Objects** provide **validation, transformation,
 - Works just like an **ActiveRecord model**
 - Supports **validations** out of the box
 - Automatically **transforms & sanitizes** data
+- Gracefully ignores unknown attributes if configured, with optional logging
 
 ```ruby
 class TodoRequest
@@ -162,6 +163,31 @@ class TodoRequest
 end
 ```
 
+### 🔍 Ignoring Unknown Attributes
+
+To prevent `RequestObject` from raising an error on unexpected keys, declare `ignore_unknown_attributes` in your class.
+
+```ruby
+class CalendarRequest
+  include InteractorSupport::RequestObject
+
+  ignore_unknown_attributes
+
+  attribute :start_date, type: :date
+  attribute :end_date, type: :date
+  attribute :timezone, transform: :strip
+
+  validates :start_date, :end_date, presence: true
+end
+```
+
+Now, if you initialize the request with an unexpected attribute, it will be logged (if logging is enabled) and ignored:
+
+```ruby
+CalendarRequest.new(start_date: "2025-07-01", end_date: "2025-07-02", foo: "bar")
+# => No exception raised; 'foo' is ignored.
+```
+
 ---
 
 ## 📖 **Documentation**
@@ -533,7 +559,7 @@ The Organizable concern provides utility methods to simplify working with intera
 
 Features
 
-- organize: Call interactors with request objects, optionally namespaced under a context_key.
+- organize: Call interactors with request objects, optionally namespaced under a context_key, and wrap validation failures in a consistent error.
 - request_params: Extract, shape, filter, rename, flatten, and merge incoming params in a clear and declarative way.
 - Built for controllers or service entry points.
 - Rails-native feel — works seamlessly with strong params.
@@ -562,6 +588,18 @@ organize(MyInteractor, params: request_params, request_object: MyRequest, contex
 # => MyInteractor.call({ request: MyRequest.new(params) })
 ```
 
+Validation failures inside the request object raise `InteractorSupport::Errors::InvalidRequestObject`. The exception exposes the request class and its validation messages, making it straightforward to surface errors back to the caller.
+
+```rb
+def create
+  organize(CreateUserInteractor, params: request_params(:user), request_object: CreateUserRequest)
+  redirect_to dashboard_path
+rescue InteractorSupport::Errors::InvalidRequestObject => e
+  flash.now[:alert] = "Unable to continue: #{e.errors.to_sentence}"
+  render :new, status: :unprocessable_entity
+end
+```
+
 #### #request_params(\*top_level_keys, merge: {}, except: [], rewrite: [])
 
 Returns a shaped parameter hash derived from params.permit!. You can extract specific top-level keys, rename them, flatten values, apply defaults, and remove unwanted fields.
@@ -652,6 +690,34 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+---
+
+## 🛠 Configuration Reference
+
+All global settings for InteractorSupport can be set via the `InteractorSupport.configure` block. Here's a full list of configuration options:
+
+<!-- prettier-ignore-start -->
+| Key | Type | Default | Description |
+| --- | ---- | ------- | -----------|
+| `logger` | `Logger` | `Logger.new($stdout)` | Logger instance used for internal logging. |
+| `log_level` | `Integer` (Logger constant) | `Logger::INFO` | Logging level (e.g., `Logger::DEBUG`, `Logger::WARN`, etc.). |
+| `log_unknown_request_object_attributes` | `Boolean` | `true` | Whether to log unknown request attributes that are ignored. |
+| `request_object_behavior` | `Symbol` | `:returns_context` | Controls what `RequestObject.new(...)` returns (`:returns_self` or `:returns_context`). |
+| `request_object_key_type` | `Symbol` | `:symbol` | Controls the output format of keys in `#to_context` (`:symbol`, `:string`, `:struct`).  |
+<!-- prettier-ignore-end -->
+
+To update these settings, use:
+
+```ruby
+InteractorSupport.configure do |config|
+  config.logger = Rails.logger
+  config.log_level = Logger::WARN
+  config.log_unknown_request_object_attributes = true
+  config.request_object_behavior = :returns_self
+  config.request_object_key_type = :struct
+end
+```
+
 ## 🤝 **Contributing**
 
 Pull requests are welcome on [GitHub](https://github.com/charliemitchell/interactor_support).

data/lib/interactor_support/concerns/organizable.rb

@@ -38,8 +38,22 @@ module InteractorSupport
       #   # => Calls MyInteractor with an instance of MyRequest initialized with request_params at :context_key.
       #   #   # => The context will contain { request: MyRequest.new(request_params) }
       def organize(interactor, params:, request_object:, context_key: nil)
+        request_payload = request_object.new(params)
+
         @context = interactor.call(
-          context_key ? { context_key => request_object.new(params) } : request_object.new(params),
+          context_key ? { context_key => request_payload } : request_payload,
+        )
+      rescue ActiveModel::ValidationError => e
+        errors =
+          if e.model&.respond_to?(:errors)
+            e.model.errors.full_messages
+          else
+            []
+          end
+
+        raise InteractorSupport::Errors::InvalidRequestObject.new(
+          request_class: request_object,
+          errors: errors,
         )
       end
 

data/lib/interactor_support/configuration.rb

@@ -29,13 +29,35 @@ module InteractorSupport
     # @return [:string, :symbol, :struct]
     attr_accessor :request_object_key_type
 
+    ##
+    # Logger for InteractorSupport, defaults to STDOUT.
+    # @return [Logger]
+    attr_accessor :logger
+
+    ##
+    # The log level for InteractorSupport logs.
+    # @return [Integer]
+    attr_accessor :log_level
+
+    ##
+    # Whether to log unknown request object attributes when they are ignored.
+    # If true, logs a warning when an unknown attribute is encountered.
+    # @see InteractorSupport::RequestObject#ignore_unknown_attributes
+    attr_accessor :log_unknown_request_object_attributes
+
     ##
     # Initializes the configuration with default values:
     # - `request_object_behavior` defaults to `:returns_context`
     # - `request_object_key_type` defaults to `:symbol`
+    # - `logger` defaults to a new Logger instance writing to STDOUT
+    # - `log_level` defaults to `Logger::INFO`
+    # - `log_unknown_request_object_attributes` defaults to `true`
     def initialize
       @request_object_behavior = :returns_context
       @request_object_key_type = :symbol
+      @logger = Logger.new($stdout)
+      @log_level = Logger::INFO
+      @log_unknown_request_object_attributes = true
     end
   end
 end

data/lib/interactor_support/errors.rb

@@ -0,0 +1,56 @@
+module InteractorSupport
+  module Errors
+    class UnknownAttribute < StandardError
+      attr_reader :attribute, :owner
+
+      def initialize(attribute, owner: nil)
+        @attribute = attribute
+        @owner = owner
+        super(build_message(attribute, owner))
+      end
+
+      private
+
+      def build_message(attribute, owner)
+        name =
+          case attribute
+          when String then attribute
+          when Symbol then attribute.to_s
+          else attribute.inspect
+          end
+
+        owner_name =
+          if owner.respond_to?(:name) && owner.name
+            owner.name
+          elsif owner.respond_to?(:to_s)
+            owner.to_s
+          else
+            owner
+          end
+
+        suffix = owner_name ? " for #{owner_name}" : ''
+        "Unknown attribute: #{name}#{suffix}"
+      end
+    end
+
+    class InvalidRequestObject < StandardError
+      attr_reader :request_class, :errors
+
+      def initialize(request_class:, errors: [])
+        @request_class = request_class
+        @errors = Array(errors)
+
+        request_name =
+          if request_class.respond_to?(:name) && request_class.name
+            request_class.name
+          else
+            request_class.to_s
+          end
+
+        detail = @errors.any? ? ": #{@errors.join(', ')}" : ''
+
+        super("Invalid #{request_name}#{detail}")
+      end
+    end
+  end
+end

data/lib/interactor_support/request_object.rb

@@ -40,6 +40,7 @@ module InteractorSupport
     included do
       include ActiveModel::Model
       include ActiveModel::Attributes
+      include ActiveModel::AttributeAssignment
       include ActiveModel::Validations::Callbacks
 
       ##
@@ -88,6 +89,34 @@ module InteractorSupport
         attrs
       end
 
+      ##
+      # Assigns the given attributes to the request object.
+      #
+      # - Known attributes are assigned normally via their setters.
+      # - If `ignore_unknown_attributes?` is defined and true, unknown keys are ignored and logged.
+      # - Otherwise, raises `Errors::UnknownAttribute`.
+      #
+      # @param attrs [Hash] input attributes to assign
+      # @raise [Errors::UnknownAttribute] if unknown attribute is encountered and not ignored
+      # @return [void]
+      def assign_attributes(attrs)
+        attrs.each do |k, v|
+          setter = "#{k}="
+          if respond_to?(setter)
+            send(setter, v)
+          elsif respond_to?(:ignore_unknown_attributes?) && ignore_unknown_attributes?
+            if InteractorSupport.configuration.log_unknown_request_object_attributes
+              InteractorSupport.configuration.logger.log(
+                InteractorSupport.configuration.log_level,
+                "InteractorSupport::RequestObject ignoring unknown attribute '#{k}' for #{self.class.name}.",
+              )
+            end
+          else
+            raise Errors::UnknownAttribute.new(k, owner: self.class)
+          end
+        end
+      end
+
       class << self
         ##
         # Custom constructor that optionally returns the context instead of the object itself.
@@ -103,6 +132,19 @@ module InteractorSupport
           super(*args, **kwargs).to_context
         end
 
+        ##
+        # Defines whether to ignore unknown attributes during assignment.
+        # If true, unknown attributes are logged but not raised as errors.
+        # @example
+        #   class MyRequest
+        #     include InteractorSupport::RequestObject
+        #     ignore_unknown_attributes
+        #   end
+        #   @return [void]
+        def ignore_unknown_attributes
+          define_method(:ignore_unknown_attributes?) { true }
+        end
+
         ##
         # Defines one or more attributes with optional coercion, default values, transformation,
         # and an optional `rewrite:` key to rename the underlying attribute.
@@ -192,7 +234,13 @@ module InteractorSupport
         message = ":#{type} is not a supported type. Supported types are: #{SUPPORTED_TYPES.join(", ")}"
         raise TypeError, message
       rescue
-        raise TypeError, "Cannot cast #{value.inspect} to #{type.name}"
+        type_name =
+          if type.respond_to?(:name) && type.name
+            type.name
+          else
+            type.to_s
+          end
+        raise TypeError, "Cannot cast #{value.inspect} to #{type_name}"
       end
     end
   end

data/lib/interactor_support/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InteractorSupport
-  VERSION = '1.0.4'
+  VERSION = '1.0.6'
 end

data/lib/interactor_support.rb

@@ -3,6 +3,7 @@
 require 'interactor'
 require 'logger'
 require 'active_support/concern'
+require 'interactor_support/errors'
 require_relative 'interactor_support/core'
 require_relative 'interactor_support/version'
 require_relative 'interactor_support/actions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interactor_support
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Charlie Mitchell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 2025-09-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -37,7 +37,9 @@ files:
 - lib/interactor_support/concerns/updatable.rb
 - lib/interactor_support/configuration.rb
 - lib/interactor_support/core.rb
+- lib/interactor_support/errors.rb
 - lib/interactor_support/request_object.rb
+- lib/interactor_support/response_object.rb
 - lib/interactor_support/rubocop.rb
 - lib/interactor_support/rubocop/cop/base_interactor_cop.rb
 - lib/interactor_support/rubocop/cop/require_required_for_interactor_support.rb