[Fix #7929] Accept frozen_string_literal anywhere in leading comment lines #7939
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
…omment lines The frozen_string_literal comment can exist anywhere in the "leading comment lines" (i.e. before the first line of ruby code). If it appears after any ruby code it is ignored which does not cause an errors but could cause the absence of an expected error which is bad. The previous implementation was checking if this comment was one of the first three comments which had two issues: - The comments it was checking could be anywhere, even after ruby code - Since it was only checking three comments, it's possible that you can have an appropriate frozen_string_literal but this cop would show an error. This commit updates the logic to look at all leading comment lines, which may be more or less than three depending on where the first non-comment token is.
jeffcarbs
force-pushed
the
fix-frozen-string-literal-comment
branch
from
ca9a171
to
748d989
Compare
jeffcarbs
commented
May 7, 2020
|
|
||
| # Since we're only looking at the leading comments, a | ||
| # `frozen_string_literal` comment elsewhere in the code is invisible | ||
| # to this cop so the autocorrect won't remove it. |
There was a problem hiding this comment.
I would be happy to take a stab at implementing this, but I'm hesitant since the autocorrect method takes a specific node and we'd have to update it to "correct" code elsewhere in the source outside of that node.
There was a problem hiding this comment.
I think this case does not need to be taken care of. Because a frozen string magic comment written other than the reading comments may be an intended content in the source code comments.
|
Thank you! |
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.
Fixes #7929
The frozen_string_literal comment can exist anywhere in the "leading comment lines" (i.e. before the first line of ruby code). If it appears after any ruby code it is ignored which does not cause any errors but could cause the absence of an expected error which is bad.
The previous implementation was checking if this comment was one of the first three comments which had two issues:
This commit updates the logic to look at all leading comment lines, which may be more or less than three depending on where the first non-comment token is.
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 RuboCop for itself, and generates the documentation.