active_interaction 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90b2dc28188b224ed0aa986afb739056dbd2407061da2dfee81b825c5674ca9
-  data.tar.gz: 755707a0f9554cee89a08567245f3d78d597a8b7ae7ec671c3eb572f4dd5a881
+  metadata.gz: f39aaac6de9ca228f9a223ef78ce39b17f7b934ac161e66067993b33968851c6
+  data.tar.gz: 9b16a1f1e0e0ecacb542709b103db93a79c9995a7cc90c5cff89d619ffcad204
 SHA512:
-  metadata.gz: d24433ef35282b38531e2e18c1e426f69f9cc71692fdb2d96e21f3c420b56a6bb42c3f473b255890b457ab3d1764d6b132ec7f30260437d732ced70b083d217a
-  data.tar.gz: dd2ce32a0c59afa9f5fe1a8134aa82e98404b1e0d5a3a3801b8dd7a726f75f28d16de46c72687c3e5f807db0576936e0a34abe3b26201dd2c58c90c798df10d5
+  metadata.gz: 4c1796f310a05133999ad8b69ea16073f017856a4fb371d4f38381d8d69c3503b3b1b2e1e45126b4f8feec0723de622ce672d043b5e6a933840abd5825327235
+  data.tar.gz: b7af241f16b1554e186456e647e2d612446b4a1ad8bb9ae2a4fa903a5231fe4b04751e6ba4becd4c5d2edd69ebe4698ab27b82534a73a464ca631073a7f71160

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [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
@@ -1130,6 +1151,7 @@ Example.run
 
 - Initial release.
 
+  [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
@@ -1361,3 +1383,7 @@ Example.run
   [#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.2'
+gem 'active_interaction', '~> 5.4'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 5.2'
+$ gem install active_interaction --version '~> 5.4'
 ```
 
 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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-22 00:00:00.000000000 Z
+date: 2024-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -20,7 +20,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 +30,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 +40,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 +50,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -127,14 +141,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 +169,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
@@ -249,56 +263,6 @@ files:
 - 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
@@ -322,58 +286,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 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: []

data/spec/active_interaction/array_input_spec.rb

@@ -1,166 +0,0 @@
-require 'spec_helper'
-
-describe ActiveInteraction::ArrayInput do
-  subject(:input) do
-    described_class.new(filter,
-      value: value,
-      error: error,
-      index_errors: index_errors,
-      children: children
-    )
-  end
-
-  let(:filter) do
-    ActiveInteraction::ArrayFilter.new(:a, &block)
-  end
-  let(:block) { proc { integer } }
-  let(:value) { nil }
-  let(:error) { nil }
-  let(:index_errors) { false }
-  let(:children) { [] }
-
-  describe '#errors' do
-    context 'with no errors' do
-      it 'returns an empty array' do
-        expect(input.errors).to be_empty
-      end
-    end
-
-    context 'with an error on the array' do
-      let(:error) { ActiveInteraction::Filter::Error.new(filter, :invalid_type) }
-
-      it 'returns one error in the array' do
-        expect(input.errors.size).to be 1
-
-        error = input.errors.first
-        expect(error.name).to be filter.name
-        expect(error.type).to be :invalid_type
-      end
-    end
-
-    context 'with children with errors' do
-      let(:child_filter) { ActiveInteraction::IntegerFilter.new(:'') }
-      let(:child_error) { ActiveInteraction::Filter::Error.new(child_filter, :invalid_type) }
-      let(:child1) { ActiveInteraction::Input.new(child_filter, value: 'a', error: child_error) }
-      let(:child2) { ActiveInteraction::Input.new(child_filter, value: 'b', error: child_error) }
-      let(:children) { [child1, child2] }
-
-      context 'with an error on the array' do
-        let(:error) { ActiveInteraction::Filter::Error.new(filter, :invalid_type) }
-
-        it 'returns one error in the array' do
-          expect(input.errors.size).to be 1
-
-          error = input.errors.first
-          expect(error.name).to be filter.name
-          expect(error.type).to be :invalid_type
-        end
-      end
-
-      context 'without :index_errors' do
-        it 'promotes the first child error and returns it in the array' do
-          expect(input.errors.size).to be 1
-
-          error = input.errors.first
-          expect(error.name).to be filter.name
-          expect(error.type).to be :invalid_type
-        end
-      end
-
-      context 'with :index_errors' do
-        let(:index_errors) { true }
-
-        it 'lists all child errors in the array' do
-          expect(input.errors.size).to be 2
-
-          input.errors.each_with_index do |error, i|
-            expect(error.name).to be :"#{filter.name}[#{i}]"
-            expect(error.type).to be :invalid_type
-          end
-        end
-
-        context 'with a nested array' do
-          let(:invalid_value) { Object.new }
-          let(:array_child) do
-            filter = ActiveInteraction::IntegerFilter.new(:'')
-            ActiveInteraction::Input.new(filter,
-              value: invalid_value,
-              error: ActiveInteraction::Filter::Error.new(filter, :invalid_type)
-            )
-          end
-          let(:child_filter) { ActiveInteraction::ArrayFilter.new(:'') { integer } }
-          let(:child) do
-            described_class.new(child_filter,
-              value: [invalid_value],
-              index_errors: index_errors,
-              children: [array_child]
-            )
-          end
-          let(:children) { [child] }
-
-          it 'returns the error' do
-            expect(input.errors.size).to be 1
-
-            error = input.errors.first
-            expect(error.name).to be :"#{filter.name}[0][0]"
-            expect(error.type).to be :invalid_type
-          end
-        end
-
-        context 'with a nested hash' do
-          let(:hash_child_a) do
-            filter = ActiveInteraction::IntegerFilter.new(:a)
-            ActiveInteraction::Input.new(filter,
-              value: nil,
-              error: ActiveInteraction::Filter::Error.new(filter, :missing)
-            )
-          end
-          let(:hash_child_b) do
-            filter = ActiveInteraction::IntegerFilter.new(:b)
-            ActiveInteraction::Input.new(filter,
-              value: nil,
-              error: ActiveInteraction::Filter::Error.new(filter, :missing)
-            )
-          end
-          let(:child_filter) { ActiveInteraction::HashFilter.new(:'') { integer :a, :b } }
-          let(:child) do
-            ActiveInteraction::HashInput.new(child_filter, value: {}, children: { a: hash_child_a, b: hash_child_b })
-          end
-          let(:children) { [child] }
-
-          it 'list all child errors' do
-            expect(input.errors.size).to be 2
-
-            error = input.errors.first
-            expect(error.name).to be :"#{filter.name}[0].a"
-            expect(error.type).to be :missing
-
-            error = input.errors.last
-            expect(error.name).to be :"#{filter.name}[0].b"
-            expect(error.type).to be :missing
-          end
-
-          context 'with an invalid hash' do
-            let(:child_filter) { ActiveInteraction::HashFilter.new(:'') }
-            let(:child) do
-              ActiveInteraction::HashInput.new(child_filter,
-                value: Object.new,
-                error: ActiveInteraction::Filter::Error.new(child_filter, :invalid_type),
-                children: {}
-              )
-            end
-            let(:children) { [child] }
-
-            it 'list all child errors' do
-              expect(input.errors.size).to be 1
-
-              error = input.errors.first
-              expect(error.name).to be :"#{filter.name}[0]"
-              expect(error.type).to be :invalid_type
-            end
-          end
-        end
-      end
-    end
-  end
-end