Improve failure messages when not expecting a list #5
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
This prepares for adding more related logic there.
rioug
approved these changes
Apr 22, 2024
| end | ||
|
|
||
| def query_summary | ||
| QuerySummary.new(@queries).summary |
There was a problem hiding this comment.
To minimise the dependency on QuerySummary, I would inject it in the constructor like this :
def initialize(queries, expected, query_summary=QuerySummary)
...
endNow you are depending on an object that implement summary and not QuerySummary directly.
There was a problem hiding this comment.
I think it's okay to depend on QuerySummary here. It means that the calling module doesn't need to know the QuerySummary. It reduces the API and the matcher definition doesn't need to know which class is responsible for which format.
dacook
approved these changes
Apr 22, 2024
Comment on lines
60
to
67
| def diff(actual, expected) | ||
| if expected.is_a?(Numeric) | ||
| change = actual - expected | ||
| format("%+d", change) | ||
| else | ||
| Expectations.differ.diff_as_object(actual, expected) | ||
| end | ||
| end |
There was a problem hiding this comment.
I guess differ doesn't provide a method for integers, that's sad 😞
There was a problem hiding this comment.
Yes, I searched through a lot of RSpec code and couldn't find any differ doing this.
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 first version of this matcher was just comparing lists of SQL commands. Then we supported more formats like numbers and summary hashes. But the failure messages were still referring to the list of queries and it wasn't easy to see the the difference between expectation and actual outcome. Now we use the same format for failure messages that is used for comparing against expectations.