active_interaction 5.1.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c740eef14e1c0bca42f4bbb5b3718c879bc3af038f40953a60a53007611916e5
-  data.tar.gz: b0a3738aa38869c7be559d72f23e958d0f9e66c0f490652bd8a92e1ef449e48e
+  metadata.gz: 9e3c0c4b273d6133644463ea773ea4551331ee7a9eb92c9dc9b3ff4b069aff55
+  data.tar.gz: bc874a3de1e5557e2baf01a59b62822fb073721f4e639559e47ce72ce50c41ad
 SHA512:
-  metadata.gz: f998483eb21ec13a43dcf3c7b6805f7865b3dd7b4d8fbc9846263338d676c41c7991a602dd3a82e13a9b93a027cbeccd5648a87fef688964124935d38d9ef6c4
-  data.tar.gz: 4669a1e76a427af4a62415f242bfdc3fa45f7a63c5a43de704b7849639841f365e83168b5c1db68ab067ca2104f8f7ec580baa487e5caa6035196607033c79f8
+  metadata.gz: b3af5f93ea4049897a6d10bf3da4e11d3eccfa14fd8a0180eeb84c6e695fadd9bc2990c0058bb605a9f7667c0759e32187797984128d3ab36b4e06ff176e26ea
+  data.tar.gz: 4b3fdc8b15977f1e0e46f654e97574581da9ebbdd851b7c91355c5ea32906fdd9b68e220bf89cc57973041995e47b3f9a8183155fbf5a1e8167d3be213c3ad8e

data/CHANGELOG.md

@@ -1,3 +1,53 @@
+# [5.5.0][] (2025-02-02)
+
+## Added
+
+ - Support for Ruby 3.4.
+
+## Fixed
+
+ - OStruct was listed as a development dependency instead of a runtime dependency.
+   The need for OStruct has been removed entirely.
+
+# [5.4.0][] (2024-11-23)
+
+## Added
+
+ - [#579][] Support for Rails 8. Thanks @bvalentino!
+
+## Fixed
+
+ - [#577][] Manually pull in the `ostruct` gem since it's being removed from stdlib.
+
+# [5.3.0][] (2023-05-06)
+
+## Added
+
+ - Added predicate methods for boolean values. Thanks @heka1024
+
+## Fixed
+
+ - [#554][] - Non-detailed error should not lose options when merged.
+ - [#553][] - Improve error handling and documentation for hash filter defaults.
+
+# [5.2.0][] (2022-10-22)
+
+## Added
+
+- Added translation for Spanish. Thanks @matiasasis!
+
+## Fixed
+
+- [#545][] - Arrays passed in are no longer modified. Thanks @jonkgrimes!
+
+## Added
+
+# [5.1.1][] (2022-09-01)
+
+## Fixed
+
+- [#539][] - Fixed a caching error in default values.
+
 # [5.1.0][] (2022-07-28)
 
 ## Added
@@ -1112,6 +1162,11 @@ Example.run
 
 - Initial release.
 
+  [5.5.0]: https://github.com/AaronLasseigne/active_interaction/compare/v5.4.0...v5.5.0
+  [5.4.0]: https://github.com/AaronLasseigne/active_interaction/compare/v5.3.0...v5.4.0
+  [5.3.0]: https://github.com/AaronLasseigne/active_interaction/compare/v5.2.0...v5.3.0
+  [5.2.0]: https://github.com/AaronLasseigne/active_interaction/compare/v5.1.1...v5.2.0
+  [5.1.1]: https://github.com/AaronLasseigne/active_interaction/compare/v5.1.0...v5.1.1
   [5.1.0]: https://github.com/AaronLasseigne/active_interaction/compare/v5.0.0...v5.1.0
   [5.0.0]: https://github.com/AaronLasseigne/active_interaction/compare/v4.1.0...v5.0.0
   [4.1.0]: https://github.com/AaronLasseigne/active_interaction/compare/v4.0.6...v4.1.0
@@ -1339,3 +1394,9 @@ Example.run
   [#503]: https://github.com/AaronLasseigne/active_interaction/issues/503
   [#536]: https://github.com/AaronLasseigne/active_interaction/issues/536
   [#537]: https://github.com/AaronLasseigne/active_interaction/issues/537
+  [#539]: https://github.com/AaronLasseigne/active_interaction/issues/539
+  [#545]: https://github.com/AaronLasseigne/active_interaction/issues/545
+  [#554]: https://github.com/AaronLasseigne/active_interaction/issues/554
+  [#553]: https://github.com/AaronLasseigne/active_interaction/issues/553
+  [#577]: https://github.com/AaronLasseigne/active_interaction/issues/577
+  [#579]: https://github.com/AaronLasseigne/active_interaction/pull/579

data/README.md

@@ -2,16 +2,11 @@
 
 ActiveInteraction manages application-specific business logic.
 It's an implementation of service objects designed to blend seamlessly into Rails.
+It also helps you write safer code by validating that your inputs conform to your expectations.
+If ActiveModel deals with your nouns, then ActiveInteraction handles your verbs.
 
 [![Version](https://img.shields.io/gem/v/active_interaction.svg?style=flat-square)](https://rubygems.org/gems/active_interaction)
-[![Test](https://img.shields.io/github/workflow/status/AaronLasseigne/active_interaction/Test?label=Test&style=flat-square)](https://github.com/AaronLasseigne/active_interaction/actions?query=workflow%3ATest)
-
----
-
-ActiveInteraction gives you a place to put your business logic. It also helps
-you write safer code by validating that your inputs conform to your
-expectations. If ActiveModel deals with your nouns, then ActiveInteraction
-handles your verbs.
+[![Test](https://img.shields.io/github/actions/workflow/status/AaronLasseigne/active_interaction/test.yml?label=Test&style=flat-square&branch=main)](https://github.com/AaronLasseigne/active_interaction/actions?query=workflow%3ATest)
 
 - [Installation](#installation)
 - [Basic usage](#basic-usage)
@@ -65,13 +60,13 @@ handles your verbs.
 Add it to your Gemfile:
 
 ``` rb
-gem 'active_interaction', '~> 5.1'
+gem 'active_interaction', '~> 5.5'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 5.1'
+$ gem install active_interaction --version '~> 5.5'
 ```
 
 This project uses [Semantic Versioning][]. Check out [GitHub releases][] for a
@@ -296,12 +291,15 @@ Boolean filters convert the strings `"1"`, `"true"`, and `"on"`
 (case-insensitive) into `true`. They also convert `"0"`, `"false"`, and `"off"`
 into `false`. Blank strings will be treated as `nil`.
 
+Boolean values can be accessed using the filter name but can also be checked
+using a predicate method of the same name.
+
 ``` rb
 class BooleanInteraction < ActiveInteraction::Base
   boolean :kool_aid
 
   def execute
-    'Oh yeah!' if kool_aid
+    'Oh yeah!' if kool_aid? # could also use `kool_aid`
   end
 end
 
@@ -360,7 +358,8 @@ HashInteraction.run!(preferences: { newsletter: true, 'sweepstakes' => false })
 
 Setting default hash values can be tricky. The default value has to be either
 `nil` or `{}`. Use `nil` to make the hash optional. Use `{}` if you want to set
-some defaults for values inside the hash.
+some defaults for values inside the hash. If any nested filter uses a
+[lazy default](#defaults) then the hash must also use a lazy default.
 
 ``` rb
 hash :optional,

data/lib/active_interaction/base.rb

@@ -147,6 +147,8 @@ module ActiveInteraction
 
         attr_accessor attribute
 
+        alias_method "#{attribute}?", attribute if filter.is_a?(BooleanFilter)
+
         eagerly_evaluate_default(filter)
       end
 

data/lib/active_interaction/errors.rb

@@ -11,7 +11,15 @@ module ActiveInteraction
     #
     # @return [Errors]
     def merge!(other)
-      merge_details!(other)
+      other.messages.each do |attribute, messages|
+        messages.zip(other.details[attribute]) do |message, detail|
+          if detailed_error?(detail)
+            merge_detail!(attribute, detail, message)
+          else
+            merge_message!(attribute, detail, message)
+          end
+        end
+      end
 
       self
     end
@@ -31,24 +39,16 @@ module ActiveInteraction
       detail[:error].is_a?(Symbol)
     end
 
-    def merge_message!(attribute, message)
+    def merge_message!(attribute, detail, message)
+      options = detail.dup
+      options.delete(:error)
+
       unless attribute?(attribute)
         message = full_message(attribute, message)
         attribute = :base
       end
-      add(attribute, message) unless added?(attribute, message)
-    end
 
-    def merge_details!(other)
-      other.messages.each do |attribute, messages|
-        messages.zip(other.details[attribute]) do |message, detail|
-          if detailed_error?(detail)
-            merge_detail!(attribute, detail, message)
-          else
-            merge_message!(attribute, message)
-          end
-        end
-      end
+      add(attribute, message, **options) unless added?(attribute, message, **options)
     end
 
     def merge_detail!(attribute, detail, message)
@@ -56,9 +56,9 @@ module ActiveInteraction
         options = detail.dup
         error = options.delete(:error)
 
-        add(attribute, error, **options.merge(message: message)) unless added?(attribute, error, **options)
+        add(attribute, error, **options, message: message) unless added?(attribute, error, **options)
       else
-        merge_message!(attribute, message)
+        merge_message!(attribute, detail, message)
       end
     end
   end

data/lib/active_interaction/filter.rb

@@ -112,24 +112,21 @@ module ActiveInteraction
     # @raise [NoDefaultError] If the default is missing.
     # @raise [InvalidDefaultError] If the default is invalid.
     def default(context = nil)
-      return @default if defined?(@default)
-
       raise NoDefaultError, name unless default?
 
       value = raw_default(context)
       raise InvalidDefaultError, "#{name}: #{value.inspect}" if value.is_a?(GroupedInput)
 
-      @default =
-        if value.nil?
-          nil
-        else
-          default = process(value, context)
-          if default.errors.any? && default.errors.first.is_a?(Filter::Error)
-            raise InvalidDefaultError, "#{name}: #{value.inspect}"
-          end
-
-          default.value
+      if value.nil?
+        nil
+      else
+        default = process(value, context)
+        if default.errors.any? && default.errors.first.is_a?(Filter::Error)
+          raise InvalidDefaultError, "#{name}: #{value.inspect}"
         end
+
+        default.value
+      end
     end
 
     # Get the description.

data/lib/active_interaction/filters/array_filter.rb

@@ -49,7 +49,7 @@ module ActiveInteraction
       children = []
 
       unless filters.empty?
-        value.map! do |item|
+        value = value.map do |item|
           result = filters[:'0'].process(item, context)
           children.push(result)
           result.value

data/lib/active_interaction/filters/hash_filter.rb

@@ -25,7 +25,7 @@ module ActiveInteraction
 
     register :hash
 
-    def process(value, context)
+    def process(value, context) # rubocop:disable Metrics/AbcSize
       input = super
 
       return HashInput.new(self, value: input.value, error: input.errors.first) if input.errors.first
@@ -36,6 +36,10 @@ module ActiveInteraction
       children = {}
 
       filters.each do |name, filter|
+        if filter.options[:default].is_a?(Proc) && !options[:default].is_a?(Proc)
+          raise InvalidDefaultError, "#{self.name}: must use a lazy default if any nested filter uses a lazy default"
+        end
+
         filter.process(input.value[name], context).tap do |result|
           value[name] = result.value
           children[name.to_sym] = result

data/lib/active_interaction/grouped_input.rb

@@ -1,11 +1,31 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 module ActiveInteraction
   # Holds a group of inputs together for passing from {Base} to {Filter}s.
   #
   # @private
-  class GroupedInput < OpenStruct
+  class GroupedInput
+    include Comparable
+
+    attr_reader :data
+    protected :data
+
+    def initialize(**data)
+      @data = data
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def []=(key, value)
+      @data[key] = value
+    end
+
+    def <=>(other)
+      return nil unless other.is_a?(self.class)
+
+      data <=> other.data
+    end
   end
 end

data/lib/active_interaction/locale/es.yml

@@ -0,0 +1,23 @@
+es:
+  active_interaction:
+    errors:
+      messages:
+        invalid: es inválido
+        invalid_type: no es un %{type} válido
+        missing: es requerido
+    types:
+      array: array
+      boolean: boolean
+      date: date
+      date_time: date time
+      decimal: decimal
+      file: file
+      float: float
+      hash: hash
+      integer: integer
+      interface: interface
+      object: object
+      record: record
+      string: string
+      symbol: symbol
+      time: time

data/lib/active_interaction/version.rb

@@ -4,5 +4,5 @@ module ActiveInteraction
   # The version number.
   #
   # @return [Gem::Version]
-  VERSION = Gem::Version.new('5.1.0')
+  VERSION = Gem::Version.new('5.5.0')
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Aaron Lasseigne
 - Taylor Fausak
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2025-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -20,7 +19,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +29,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +39,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +49,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -127,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.68.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.68.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -155,14 +154,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -242,62 +241,13 @@ files:
 - lib/active_interaction/input.rb
 - lib/active_interaction/inputs.rb
 - lib/active_interaction/locale/en.yml
+- lib/active_interaction/locale/es.yml
 - lib/active_interaction/locale/fr.yml
 - lib/active_interaction/locale/it.yml
 - lib/active_interaction/locale/ja.yml
 - lib/active_interaction/locale/pt-BR.yml
 - lib/active_interaction/modules/validation.rb
 - lib/active_interaction/version.rb
-- spec/active_interaction/array_input_spec.rb
-- spec/active_interaction/base_spec.rb
-- spec/active_interaction/concerns/active_modelable_spec.rb
-- spec/active_interaction/concerns/active_recordable_spec.rb
-- spec/active_interaction/concerns/hashable_spec.rb
-- spec/active_interaction/concerns/missable_spec.rb
-- spec/active_interaction/concerns/runnable_spec.rb
-- spec/active_interaction/errors_spec.rb
-- spec/active_interaction/filter/column_spec.rb
-- spec/active_interaction/filter_spec.rb
-- spec/active_interaction/filters/abstract_date_time_filter_spec.rb
-- spec/active_interaction/filters/abstract_numeric_filter_spec.rb
-- spec/active_interaction/filters/array_filter_spec.rb
-- spec/active_interaction/filters/boolean_filter_spec.rb
-- spec/active_interaction/filters/date_filter_spec.rb
-- spec/active_interaction/filters/date_time_filter_spec.rb
-- spec/active_interaction/filters/decimal_filter_spec.rb
-- spec/active_interaction/filters/file_filter_spec.rb
-- spec/active_interaction/filters/float_filter_spec.rb
-- spec/active_interaction/filters/hash_filter_spec.rb
-- spec/active_interaction/filters/integer_filter_spec.rb
-- spec/active_interaction/filters/interface_filter_spec.rb
-- spec/active_interaction/filters/object_filter_spec.rb
-- spec/active_interaction/filters/record_filter_spec.rb
-- spec/active_interaction/filters/string_filter_spec.rb
-- spec/active_interaction/filters/symbol_filter_spec.rb
-- spec/active_interaction/filters/time_filter_spec.rb
-- spec/active_interaction/grouped_input_spec.rb
-- spec/active_interaction/hash_input_spec.rb
-- spec/active_interaction/i18n_spec.rb
-- spec/active_interaction/inputs_spec.rb
-- spec/active_interaction/integration/array_interaction_spec.rb
-- spec/active_interaction/integration/boolean_interaction_spec.rb
-- spec/active_interaction/integration/date_interaction_spec.rb
-- spec/active_interaction/integration/date_time_interaction_spec.rb
-- spec/active_interaction/integration/file_interaction_spec.rb
-- spec/active_interaction/integration/float_interaction_spec.rb
-- spec/active_interaction/integration/hash_interaction_spec.rb
-- spec/active_interaction/integration/integer_interaction_spec.rb
-- spec/active_interaction/integration/interface_interaction_spec.rb
-- spec/active_interaction/integration/object_interaction_spec.rb
-- spec/active_interaction/integration/record_integration_spec.rb
-- spec/active_interaction/integration/string_interaction_spec.rb
-- spec/active_interaction/integration/symbol_interaction_spec.rb
-- spec/active_interaction/integration/time_interaction_spec.rb
-- spec/active_interaction/modules/validation_spec.rb
-- spec/spec_helper.rb
-- spec/support/concerns.rb
-- spec/support/filters.rb
-- spec/support/interactions.rb
 homepage: https://github.com/AaronLasseigne/active_interaction
 licenses:
 - MIT
@@ -306,7 +256,6 @@ metadata:
   source_code_uri: https://github.com/AaronLasseigne/active_interaction
   changelog_uri: https://github.com/AaronLasseigne/active_interaction/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -321,58 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Manage application specific business logic.
-test_files:
-- spec/active_interaction/array_input_spec.rb
-- spec/active_interaction/base_spec.rb
-- spec/active_interaction/concerns/active_modelable_spec.rb
-- spec/active_interaction/concerns/active_recordable_spec.rb
-- spec/active_interaction/concerns/hashable_spec.rb
-- spec/active_interaction/concerns/missable_spec.rb
-- spec/active_interaction/concerns/runnable_spec.rb
-- spec/active_interaction/errors_spec.rb
-- spec/active_interaction/filter/column_spec.rb
-- spec/active_interaction/filter_spec.rb
-- spec/active_interaction/filters/abstract_date_time_filter_spec.rb
-- spec/active_interaction/filters/abstract_numeric_filter_spec.rb
-- spec/active_interaction/filters/array_filter_spec.rb
-- spec/active_interaction/filters/boolean_filter_spec.rb
-- spec/active_interaction/filters/date_filter_spec.rb
-- spec/active_interaction/filters/date_time_filter_spec.rb
-- spec/active_interaction/filters/decimal_filter_spec.rb
-- spec/active_interaction/filters/file_filter_spec.rb
-- spec/active_interaction/filters/float_filter_spec.rb
-- spec/active_interaction/filters/hash_filter_spec.rb
-- spec/active_interaction/filters/integer_filter_spec.rb
-- spec/active_interaction/filters/interface_filter_spec.rb
-- spec/active_interaction/filters/object_filter_spec.rb
-- spec/active_interaction/filters/record_filter_spec.rb
-- spec/active_interaction/filters/string_filter_spec.rb
-- spec/active_interaction/filters/symbol_filter_spec.rb
-- spec/active_interaction/filters/time_filter_spec.rb
-- spec/active_interaction/grouped_input_spec.rb
-- spec/active_interaction/hash_input_spec.rb
-- spec/active_interaction/i18n_spec.rb
-- spec/active_interaction/inputs_spec.rb
-- spec/active_interaction/integration/array_interaction_spec.rb
-- spec/active_interaction/integration/boolean_interaction_spec.rb
-- spec/active_interaction/integration/date_interaction_spec.rb
-- spec/active_interaction/integration/date_time_interaction_spec.rb
-- spec/active_interaction/integration/file_interaction_spec.rb
-- spec/active_interaction/integration/float_interaction_spec.rb
-- spec/active_interaction/integration/hash_interaction_spec.rb
-- spec/active_interaction/integration/integer_interaction_spec.rb
-- spec/active_interaction/integration/interface_interaction_spec.rb
-- spec/active_interaction/integration/object_interaction_spec.rb
-- spec/active_interaction/integration/record_integration_spec.rb
-- spec/active_interaction/integration/string_interaction_spec.rb
-- spec/active_interaction/integration/symbol_interaction_spec.rb
-- spec/active_interaction/integration/time_interaction_spec.rb
-- spec/active_interaction/modules/validation_spec.rb
-- spec/spec_helper.rb
-- spec/support/concerns.rb
-- spec/support/filters.rb
-- spec/support/interactions.rb
+test_files: []