Add ActiveModel::Errors#merge! #29714
Conversation
Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @matthewd (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review. Please see the contribution instructions for more information. |
# Examples | ||
# | ||
# person.errors.merge!(other) | ||
def merge!(other) # :nodoc: |
rafaelfranca
Jul 7, 2017
Member
You can remove the `# :nodoc: comment here since we want it to be public API.
You can remove the `# :nodoc: comment here since we want it to be public API.
jahfer
Jul 7, 2017
Author
Contributor
✅
# | ||
# person.errors.merge!(other) | ||
def merge!(other) | ||
@messages.merge!(other.messages) { |_, hash1, hash2| hash1 + hash2 } |
rafaelfranca
Jul 7, 2017
Member
Are the variable inside the block hashes or arrays? I think they are arrays, so maybe we should rename them?
Are the variable inside the block hashes or arrays? I think they are arrays, so maybe we should rename them?
jahfer
Jul 7, 2017
Author
Contributor
Oh they are definitely arrays. Fixed now.
Oh they are definitely arrays. Fixed now.
ActiveModel::Errors#merge! allows ActiveModel::Errors to append errors from a separate ActiveModel::Errors instance onto their own. Example: person = Person.new person.errors.add(:name, :blank) errors = ActiveModel::Errors.new(Person.new) errors.add(:name, :invalid) person.errors.merge!(errors) puts person.errors.messages # => { name: ["can't be blank", "is invalid"] }
Summary
ActiveModel::Errors#merge!
allows instances ofActiveModel::Errors
to append errors from a separate instance ofActiveModel::Errors
onto its own set of errors.The implementation in this PR does a "deep" merge of the contents within each key so that any keys already containing errors will be merged with the new set, rather than overridden.
This contribution was suggested to me by @rafaelfranca.
Example