Fix infinite correction loop in RSpec/ExampleWording #1438
Conversation
pirj
force-pushed
the
fix-infinite-correction-loop
branch
from
9fa60c9
to
8bb9c1a
Compare
| else | ||
| check_and_handle_insufficient_examples(description_node) | ||
| elsif insufficient_docstring?(description_node) | ||
| add_offense(docstring(description_node), |
There was a problem hiding this comment.
How about adding next if text(node) == replacement_text(node) in the auto-correction?
RuboCop thinks correction was made because the autocorrect didn't return nil, even though the correction resulted in replacing with the same value
There was a problem hiding this comment.
It feels a bit hacky, for two reasons.
For "should do something" we know we have a correction, but we'll be making this check that will also return false.
For "works" we know we don't have a correction, so the check will be true.
I'm shortcutting (in a good way) here to skip autocorrection for "works", along with this check.
@ydah This expectation was passing before the fix - no surprise, it was replacing "works" with "works". But I deliberately decided not to add this expectation because it's deceiving, at least not in the scope of this PR. Don't trust a spec you didn't see fail™ |
Indeed it is. Thank you. |
Fix infinite correction loop in RSpec/ExampleWording
fixes #1433
Since we don't have any corrections for an insufficient example wording like "works", we keep "replacing" the description with itself.
NOTE:
expect_no_correctionswas passing. But RuboCop was (falsely?) detecting that a change has been made, and was re-running the cop over and over.Before submitting the PR make sure the following are checked:
master(if not - rebase it).CHANGELOG.mdif the new code introduces user-observable changes.bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).