Fix multibyte support in the regexp node handler #8989
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
knu
force-pushed
the
fix_multibyte_support_in_regexp_node
branch
from
b42c53e
to
9766115
Compare
marcandre
reviewed
Nov 2, 2020
|
#8948 is probably related to this issue. |
bbatsov
reviewed
Nov 3, 2020
bbatsov
reviewed
Nov 3, 2020
Auto-correction by Style/RedundantRegexpEscape can corrupt a program
by removing a character at the wrong index when it deals with a regexp
pattern containing multibyte characters.
```console
% cat a.rb
x = s[/[一二\.]+/]
p x
% be rubocop -a a.rb
Inspecting 1 file
F
Offenses:
a.rb:1:7: F: Lint/Syntax: unterminated string meets end of file
(Using Ruby 2.4 parser; configure using TargetRubyVersion parameter, under AllCops)
x = s[/[一二\.]+]
^
a.rb:1:15: C: [Corrected] Style/RedundantRegexpEscape: Redundant escape inside regexp literal
x = s[/[一二\.]+/]
^^
1 file inspected, 2 offenses detected, 1 offense corrected
% cat a.rb
x = s[/[一二\.]+]
p x
```
Note that the closing slash is removed instead of the redundant
backslash.
The problem is that the cop mixes byte index with character index and
results in manipulating source code with the wrong index values.
Regexp::Parser stores byte index in Regexp::Expression#ts and that is
the source of confusion.
It can be fixed by converting index values like this, but ideally it
should be done in Regexp::Parser.
knu
force-pushed
the
fix_multibyte_support_in_regexp_node
branch
from
2a043d4
to
b87785e
Compare
|
Looks great, thanks! 👍 |
knu
added a commit
to knu/rubocop
that referenced
this pull request
Nov 26, 2020
Methods we use that used to return byte-based indices now return char-based indices, so we can revert the changes made in rubocop#8989. https://github.com/ammar/regexp_parser/blob/master/CHANGELOG.md#200---2020-11-25---janosch-m%C3%BCller
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.
Auto-correction by Style/RedundantRegexpEscape can corrupt a program by removing a character at the wrong index when it deals with a regexp pattern containing multibyte characters.
Note that the closing slash is removed instead of the redundant backslash.
The problem is that the cop mixes byte index with character index and results in manipulating source code with the wrong index values. Regexp::Parser stores byte index in Regexp::Expression#ts and that is the source of confusion.
It can be fixed by converting index values like this, but ideally it should be done in Regexp::Parser.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.