active_interaction 4.0.6 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ea0d31fc8d2cf65540edb64cc51b1b3a31205a5f4a179fd56ecdb1606d84c9f
-  data.tar.gz: fd79ef266a8357bad053b282068b0fe5bfb3cf677f778b97ebe373b7c9c9a216
+  metadata.gz: c740eef14e1c0bca42f4bbb5b3718c879bc3af038f40953a60a53007611916e5
+  data.tar.gz: b0a3738aa38869c7be559d72f23e958d0f9e66c0f490652bd8a92e1ef449e48e
 SHA512:
-  metadata.gz: d4070194c1bcf654043c65e340abf6a1be0977282c214636511cb5188cace08a81a34ef811f9d3a369b7dc10a8ce8fcdda6a563c69fe34435fef6618c67dc5b7
-  data.tar.gz: 446e6ccc7f28132c70808817b3db99b5852486f1c097212aea861db4235da1df676c1cd3751019425a34f84b6590b9c06e954b31ae3c8dc32cf0843ea3c7d326
+  metadata.gz: f998483eb21ec13a43dcf3c7b6805f7865b3dd7b4d8fbc9846263338d676c41c7991a602dd3a82e13a9b93a027cbeccd5648a87fef688964124935d38d9ef6c4
+  data.tar.gz: 4669a1e76a427af4a62415f242bfdc3fa45f7a63c5a43de704b7849639841f365e83168b5c1db68ab067ca2104f8f7ec580baa487e5caa6035196607033c79f8

data/CHANGELOG.md

@@ -1,38 +1,180 @@
+# [5.1.0][] (2022-07-28)
+
+## Added
+
+- Limit dependencies to the minimum requirements.
+
+## Fixed
+
+- [#536][] - `compose` accepts `Inputs`.
+- [#537][] - Arrays with nested filters returned the wrong value.
+
+# [5.0.0][] (2022-06-24)
+
+## Changed
+
+- Drop support for JRuby.
+- Drop support for Ruby 2.5 and 2.6, adding support for 3.1
+- Drop support for Rails 5.0 and 5.1
+- `ActiveInteraction::Inputs` no longer inherits from `Hash` though it still has most of the methods
+  provided by `Hash` (methods that write were removed).
+- Removed `Filter#clean` (use `Filter#process` and call `#value` on the result)
+- The `given?` method has been moved onto `inputs`. ([how to upgrade](#given))
+- [#503][] - The record filter now treats blank strings value as `nil`. This was missed in the 4.0 update.
+- The `type_check` callback has been renamed to `filter` to better match the reality of what it does.
+  ([how to upgrade](#filter-callback))
+- `ActiveIneraction::FilterColumn` is now `ActiveInteraction::Filter::Column`
+- Errors on the array filter will now be indexed if the Rails config `index_nested_attribute_errors`
+  is `true` or the `:index_errors` option is set to `true`. The `:index_errors` option always overrides
+  the Rails config.
+- Invalid nested errors (`:invalid_nested`) are gone. Instead the nested errors will appear as they would
+  in Rails if they were a `has_many` relationship being assigned attributes through a parent.
+  ([how to upgrade](#nested-hash-errors))
+
+## Added
+
+- `Filter#process` which returns an `Input`.
+
+## Fixed
+
+- When passing an `ActiveRecord::Relation` in an array filter with no inner
+  filter, the value returned was an `ActiveRecord::Relation` instead of an
+  Array.
+
+## Upgrading
+
+### `given?`
+
+The `given?` method can now be found on `inputs`. It works the same as before.
+
+```ruby
+# 4.1
+class Example < ActiveInteraction::Base
+  string :name, default: nil
+
+  def execute
+    given?(:name)
+  end
+end
+
+# 5.0
+class Example < ActiveInteraction::Base
+  string :name, default: nil
+
+  def execute
+    inputs.given?(:name)
+  end
+end
+```
+
+### Filter Callback
+
+You'll need to rename any `:type_check` callbacks to `:filter`.
+
+```ruby
+# 4.1
+set_callback :type_check, :before, -> { puts 'before type check' }
+
+# 5.0
+set_callback :filter, :before, -> { puts 'before type check' }
+```
+
+### Nested Hash Errors
+
+Nested hash errors no longer add an error as through it happened on the hash.
+They now use the error in its original form and attach the name of the hash to
+the error. It is also not limited to returning one error.
+
+```ruby
+class HashInteraction < ActiveInteraction::Base
+  hash :mailing_lists do
+    boolean :marketing
+    boolean :product_updates
+  end
+
+  def execute
+    # ...
+  end
+end
+
+> outcome = HashInteraction.run(mailing_lists: {})
+
+# 4.1
+> outcome.errors.details
+# => {:mailing_lists=>[{:error=>:invalid_nested, :name=>"\"marketing\"", :value=>"nil"}]},
+> outcome.errors.messages
+# => {:mailing_lists=>["has an invalid nested value (\"marketing\" => nil)"]}
+> outcome.errors.full_messages
+# => ["Mailing lists has an invalid nested value (\"marketing\" => nil)"]
+
+# 5.0
+> outcome.errors.details
+# => {:"mailing_lists.marketing"=>[{:error=>:missing}], :"mailing_lists.product_updates"=>[{:error=>:missing}]}
+> outcome.errors.messages
+# => {:"mailing_lists.marketing"=>["is required"], :"mailing_lists.product_updates"=>["is required"]}
+> outcome.errors.full_messages
+# => ["Mailing lists marketing is required", "Mailing lists product updates is required"]
+```
+
+I18n can handle these values the same as nested values in Rails:
+
+```yml
+en:
+  active_interaction:
+    attributes:
+      hash_interaction/mailing_lists:
+        marketing: 'Mailing list "Marketing"'
+        product_updates: 'Mailing list "Product Updates"'
+```
+
+Using the same example from above:
+
+```ruby
+> outcome.errors.full_messages
+# => ["Mailing list \"Marketing\" is required", "Mailing list \"Product Updates\" is required"]
+```
+
+# [4.1.0][] (2021-12-30)
+
+## Added
+
+- [#518][] - Add Rails 7 support
+
 # [4.0.6][] (2021-10-13)
 
-## Fix
+## Fixed
 
 - [#515][] - Filters nested in arrays should accept default values as indicated in the documentation.
 
 # [4.0.5][] (2021-07-11)
 
-## Fix
+## Fixed
 
 - [#480][] - Interfaces used inside hashes failed to recognize `nil` as a non-value.
 
 # [4.0.4][] (2021-07-03)
 
-## Fix
+## Fixed
 
 - [#510][] - Hash parameters failed when working outside of Rails.
 - [#511][] - Nested filters with options but no `:class` failed to have `:class` automatically added.
 
 # [4.0.3][] (2021-06-24)
 
-## Fix
+## Fixed
 
 - [#499][] - `given?` now recognizes multi-part date inputs by their primary key name
 - [#493][] - `compose` now properly accepts `Inputs`
 
 # [4.0.2][] (2021-06-22)
 
-## Fix
+## Fixed
 
 - [#505][] - Nested Interface filters using the `:methods` option threw an error.
 
 # [4.0.1][] (2021-05-26)
 
-## Fix
+## Fixed
 
 - Fix regression of filter name relaxing.
 - [#495][] - Fix time filter ignoring time zones
@@ -62,7 +204,7 @@
 
 ## Added
 
-- Implicit coercion of types are now supported in filters (e.g. to_str, to_int,
+- Implicit coercion of types are now supported in filters (e.g. `to_str`, `to_int`,
   etc).
 - The `interface` and `record` filters, when used as an inner filter for an
   `array`, will have their `from/class` option set to a singularized version of
@@ -970,6 +1112,9 @@ Example.run
 
 - Initial release.
 
+  [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
   [4.0.6]: https://github.com/AaronLasseigne/active_interaction/compare/v4.0.5...v4.0.6
   [4.0.5]: https://github.com/AaronLasseigne/active_interaction/compare/v4.0.4...v4.0.5
   [4.0.4]: https://github.com/AaronLasseigne/active_interaction/compare/v4.0.3...v4.0.4
@@ -1190,3 +1335,7 @@ Example.run
   [#412]: https://github.com/AaronLasseigne/active_interaction/issues/412
   [#480]: https://github.com/AaronLasseigne/active_interaction/issues/480
   [#515]: https://github.com/AaronLasseigne/active_interaction/issues/515
+  [#518]: https://github.com/AaronLasseigne/active_interaction/issues/518
+  [#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

data/CONTRIBUTING.md

@@ -1,13 +1,21 @@
-# Steps
+# Contributing
+
+Bug fixes and optimizations are welcome.
+For optimizations please provide some reproducable proof of the improvement.
+
+For features please open a [discussion][] and we can make sure the feature fits with the gem before working on it.
+
+## Steps
 
 1. [Fork][] the repo.
 2. Add a breaking test for your change.
 3. Make the tests pass.
 4. Push your fork.
-5. Submit a pull request.
+5. Submit a pull request against the `next` branch.
 
-# Code Style
+## Code Style
 
 Running the tests using `rake` (with no args) will also check for style issues in the code. Ideally all submissions would pass these checks. If the code style is causing issues (particularly the method or class size) we can work with you to correct it. Don't let it stop you from contributing.
 
 [fork]: https://github.com/AaronLasseigne/active_interaction/fork
+[discussion]: https://github.com/AaronLasseigne/active_interaction/discussions/categories/ideas