Fix an error for Style/RedundantStringEscape cop
#11095
Merged
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 PR fixes the following error for `Style/RedundantStringEscape` cop
when using `?\n` string character literal.
```console
% cat example.rb
?\n
% bundle exec rubocop --only Style/RedundantStringEscape -d
(snip)
An error occurred while Style/RedundantStringEscape cop was inspecting /Users/koic/src/github.com/koic/rubocop-issues/11090/example.rb:1:0.
undefined method `source' for nil:NilClass
delimiters = [node.loc.begin.source[-1], node.loc.end.source[0]]
^^^^^^^
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/redundant_string_escape.rb:162:in `delimiter?'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/redundant_string_escape.rb:110:in `single_quoted?'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/redundant_string_escape.rb:103:in `interpolation_not_enabled?'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/redundant_string_escape.rb:85:in `allowed_escape?'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/redundant_string_escape.rb:51:in `block in on_str'
```
Similar case to rubocop#11089, but not resolved by rubocop#11090.
It also removes a bit of unnecessary implementation logic I found.
koic
force-pushed
the
fix_an_error_for_style_redundant_string_escape
branch
from
d063145
to
5583d05
Compare
koic
added a commit
to koic/rubocop-ast
that referenced
this pull request
Oct 21, 2022
This PR adds `character_literal?` to `StrNode`.
`...begin.is?('?')` used in rubocop/rubocop#11095
and `Style/CharacterLiteral` can be rewritten by `node.character_literal?`.
koic
added a commit
to koic/rubocop-ast
that referenced
this pull request
Oct 21, 2022
This PR adds `character_literal?` to `StrNode`.
`...begin.is?('?')` used in rubocop/rubocop#11095
and `Style/CharacterLiteral` can be rewritten by `node.character_literal?`.
koic
commented
Oct 21, 2022
| @@ -42,10 +42,9 @@ class RedundantStringEscape < Base | |||
| MSG = 'Redundant escape of %<char>s inside string literal.' | |||
|
|
|||
| def on_str(node) | |||
| return if node.parent&.regexp_type? || node.parent&.xstr_type? | |||
| return if node.parent&.regexp_type? || node.parent&.xstr_type? || character_literal?(node) | |||
There was a problem hiding this comment.
If rubocop/rubocop-ast#242 becomes available, it can be rewritten as:
Suggested change
| return if node.parent&.regexp_type? || node.parent&.xstr_type? || character_literal?(node) | |
| return if node.parent&.regexp_type? || node.parent&.xstr_type? || node.character_literal? |
There was a problem hiding this comment.
That'd be nice - we have several checks for char literals in the codebase that can be simplified. And one cop that discourages them. :-)
|
Thanks! |
marcandre
pushed a commit
to rubocop/rubocop-ast
that referenced
this pull request
Oct 21, 2022
This PR adds `character_literal?` to `StrNode`.
`...begin.is?('?')` used in rubocop/rubocop#11095
and `Style/CharacterLiteral` can be rewritten by `node.character_literal?`.
koic
added a commit
that referenced
this pull request
Oct 21, 2022
Follow up #11095 (comment) and rubocop/rubocop-ast#242. The API was introduced in rubocop-ast 1.23.0.
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.
This PR fixes the following error for
Style/RedundantStringEscapecop when using?\nstring character literal.Similar case to #11089, but not resolved by #11090. It also removes a bit of unnecessary implementation logic I found.
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}.mdif the new code introduces user-observable changes. See changelog entry format for details.