[Fix #4886] Fix false offense for Style/CommentedKeyword #4944
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
pocke
reviewed
Oct 27, 2017
| @@ -57,7 +59,8 @@ def investigate(processed_source) | |||
| ALLOWED_COMMENTS = %w[:nodoc: rubocop:disable].freeze | |||
|
|
|||
| def offensive?(line) | |||
| KEYWORDS.any? { |k| line =~ /^\s*#{k}\s+.*#/ } && | |||
| line = line.lstrip | |||
| KEYWORDS.any? { |keyword| line.start_with?(keyword) } && | |||
There was a problem hiding this comment.
String#start_with? can receive more than one string.
e.g. line.start_with?(*KEYWORDS)
BTW, we can add a cop for the pattern.
Commit also contains cop improvements: Instead of going through each line of the processed_source we can easily take comments only and cop only those lines, where comments are located. Instead of splitting line with `#` symbol we take column values from `comment.location`.
michniewicz
force-pushed
the
4886-fix-false-comment-offence
branch
from
48cf145
to
7dc743b
Compare
|
👍 |
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.
[Fix #4886] Fix false offense for Style/CommentedKeyword
Fix also contains cop improvements:
Instead of going through each line of the processed_source we can easily take comments only and cop only those lines, where comments are located.
Instead of splitting line with
#symbol we take column values fromcomment.location.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).rake spec) are passing.rake internal_investigation.and description in grammatically correct, complete sentences.
rake generate_cops_documentation(required only when you've added a new cop or changed the configuration/documentation of an existing cop).