Verboser error message #1
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
Spell out the problem in the error message for user-friendliness. Motivation: When this error is raised while Rails is rendering a view, Rails helpfully rescues it and re-raises it as an `ActionView::Template::Error`. So, I was getting just `ActionView::Template::Error: 0`, which is less than helpful. Also, rename `LengthNotOne` to `CountNotOne` since we use the `count` method and not the `length` method.
| raise_error(Enumerable::FirstAndOnly::LengthNotOne, "0") | ||
| expect { subject.first_and_only! }.to raise_error( | ||
| Enumerable::FirstAndOnly::CountNotOne, | ||
| "Expected the count to be 1, but it was 0." |
There was a problem hiding this comment.
Maybe I'm doing it wrong, but the original intent was that the error class itself would be part of the error message:
Enumerable::FirstAndOnly::CountNotOne # "Oh, I see the count is supposed to be 1"
So putting that in the text of the message is kind of redundant:
Expected the count to be 1, but it was 0.
So, I should mark this as "wont-fix, change the downstream problem with ActionView" 
So thinking about this in real time, I think I agree with your change, even though it duplicates information in the class name. For example, maybe the text of the error message could be localized, but of course, the CountNotOne class name would not be localized.
Thanks @mikegee!
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.
Spell out the problem in the error message for user-friendliness.
Motivation: When this error is raised while Rails is rendering a view, Rails helpfully rescues it and re-raises it as an
ActionView::Template::Error. So, I was getting justActionView::Template::Error: 0, which is less than helpful.Also, rename
LengthNotOnetoCountNotOnesince we use thecountmethod and not thelengthmethod.