[Fix #9558] Fix inconsistency when dealing with URIs that are wrapped in single quotes vs double quotes #9568
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.
The
LineLength
cop usesLineLengthHelp#allowed_uri_position?
to determine if the URI is in an allowed position. Previously it checked that the URL either ended the line, or ended one character before the end of the line:rubocop/lib/rubocop/cop/mixin/line_length_help.rb
Lines 26 to 30 in 291aec7
It looks like this was added originally in #5361... also to handle disparity between single and double quotes. 🤔
As it turns out, ruby's default URI parser (which we use to match parts of strings as a URL), accepts
'
as a valid character, but does not accept"
. It also matches)
. Therefore, the URL extracted from the string differs depending on the type of quote being used:This was leading to the failure in the issue, because for the single quoted string, the "URL" ends on the last character (despite the
')
not actually being a part of the URL!), but for the double quoted string, the parser actually ends at the "real" end of the URL, and thenallowed_uri_position?
fails.This change updates the
uri_range
to also capture any trailing characters until the next whitespace, and then just checks that theuri_range
ends at the end of the line. This fixes the issue while also continuing to register an offense for subsequent words.Fixes #9558.
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.