Improve comments handling in couple of auto-corrections #9338
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.
I learned the hard way that the
comments_before_line
won't stop until the very first line in the processed file, and that it doesn't care whether the comments begin their own line or not. So I replaced it in the 2 cops that use it.In one of them (that uses the CommentsHelp mixin) the code already tried to limit the damage by looking for consecutive lines, so it would only break if there is a node with inline comment and missing separating line.
The other one however would completely mess the comments, bringing all of the unrelated one to the new position, so I added spec for that case. It also fixes #9233
Before submitting the PR make sure the following are checked:
[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).bundle exec rake default
. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.md
if the new code introduces user-observable changes. See changelog entry format for details.