New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ActiveModel::Errors#merge! #29714

Merged
merged 1 commit into from Jul 7, 2017

Conversation

Projects
None yet
4 participants
@jahfer
Contributor

jahfer commented Jul 7, 2017

Summary

ActiveModel::Errors#merge! allows instances of ActiveModel::Errors to append errors from a separate instance of ActiveModel::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

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"] }
@rails-bot

This comment has been minimized.

rails-bot commented Jul 7, 2017

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.

activemodel/lib/active_model/errors.rb Outdated
# Examples
#
# person.errors.merge!(other)
def merge!(other) # :nodoc:

This comment has been minimized.

@rafaelfranca

rafaelfranca Jul 7, 2017

Member

You can remove the `# :nodoc: comment here since we want it to be public API.

This comment has been minimized.

@jahfer

jahfer Jul 7, 2017

Contributor

activemodel/lib/active_model/errors.rb Outdated
#
# person.errors.merge!(other)
def merge!(other)
@messages.merge!(other.messages) { |_, hash1, hash2| hash1 + hash2 }

This comment has been minimized.

@rafaelfranca

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?

This comment has been minimized.

@jahfer

jahfer Jul 7, 2017

Contributor

Oh they are definitely arrays. Fixed now.

Add ActiveModel::Errors#merge!
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"] }

@rafaelfranca rafaelfranca merged commit 98f8f81 into rails:master Jul 7, 2017

2 checks passed

codeclimate no new or fixed issues
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment