Rename ::normalize to ::normalize_value_for
#47034
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `::normalize` method accepts an attribute name and a value, and type
casts the value, applying any declared normalizations for the attribute.
Because of the way type casting works for most types, the type of the
given value can be very different than the attribute type. This allows
for potential confusion between the `::normalize` method and the
`::normalizes` method. For example:
```ruby
class Post < ActiveRecord::Base
normalize :title, with: -> { _1.titlecase }
end
```
In the above code, the user meant to call `::normalizes`, but called
`::normalize` instead. The `:with` kwarg is treated as a `Hash` value
which is then type cast to a `String`. The type cast silently succeeds,
so the user does not realize why their normalization is not applied.
To prevent such confusion, this commit renames `::normalize` to
`::normalize_value_for`.
ghiculescu
approved these changes
Jan 17, 2023
rafaelfranca
approved these changes
Jan 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
::normalizemethod accepts an attribute name and a value, and type casts the value, applying any declared normalizations for the attribute. Because of the way type casting works for most types, the type of the given value can be very different than the attribute type. This allows for potential confusion between the::normalizemethod and the::normalizesmethod. For example:In the above code, the user meant to call
::normalizes, but called::normalizeinstead. The:withkwarg is treated as aHashvalue which is then type cast to aString. The type cast silently succeeds, so the user does not realize why their normalization is not applied.To prevent such confusion, this commit renames
::normalizeto::normalize_value_for.