interactor_support 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6d8c9f46a3e48520652cdb83a9257d487a3411feef0b1efd69c1fc4a209c03
-  data.tar.gz: 31b939d573a1dc042b671304ec777bf4a8bf53ad61bd3b4d63fccc3fd4dd2806
+  metadata.gz: 315dd265352ed997c5b69934609478e6e5f8b61bbe74bba065acf495f7dac41c
+  data.tar.gz: 6a942d0ccb3f3323d156d85f302987b4af7809cdcce852dca56fb9b1ae8419bc
 SHA512:
-  metadata.gz: 2cf4e789be122df812109df549d3d94a4cf685af0a85eb3fa3d47e811fc73d2231a4fd5af95a2e3c397505102c363bb831df716f16fe701fa0e2fd33e586e757
-  data.tar.gz: 8d6e5ee59b6c0523d0d7a9931d6b0ee4f1f98c7aa7d87aabfd45f8dcad8b9f7831444030803abc98bf0594b87a9e084cc9285e8f7382dd378f0d68f4fdc79823
+  metadata.gz: 2fb25732876e4702b12da283cf4d205504c597ecb904cc9406af3a9825814e8ba518e84bcc615c1c8aadc31ed81cfb9008e2addf759273c2688e029d5b07628e
+  data.tar.gz: 5615bf986b8ab272cff775eebbd874c336be93f4e17333d37fd6e87a04b9d74d110b2fcab2a48fb1e0ff86956785b4a7825d03f4201701700566825c2335c633

data/CHANGELOG.md

@@ -21,3 +21,11 @@
 ## [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

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**
@@ -652,6 +678,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/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,9 @@
+module InteractorSupport
+  module Errors
+    class UnknownAttribute < StandardError
+      def initialize(attribute)
+        super("Unknown attribute: #{attribute}")
+      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,32 @@ 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?
+            InteractorSupport.configuration.logger.log(
+              InteractorSupport.configuration.log_level,
+              "InteractorSupport::RequestObject ignoring unknown attribute '#{k}' for #{self.class.name}.",
+            )
+          else
+            raise Errors::UnknownAttribute, "`#{k}` for #{self.class.name}."
+          end
+        end
+      end
+
       class << self
         ##
         # Custom constructor that optionally returns the context instead of the object itself.
@@ -103,6 +130,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.

data/lib/interactor_support/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InteractorSupport
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 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.5
 platform: ruby
 authors:
 - Charlie Mitchell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 2025-07-01 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