[Fix #4182] Add Lint/AmbiguousRange
cop to check for ranges with ambiguous boundaries
#9986
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.
Adds a new cop
Lint/AmbiguousRange
to detect range boundaries that are ambiguous. An ambiguous boundary is one that is not a basic literal, single variable/constant/method reference, or method chain (depending on the value ofRequireParenthesesForMethodChains
, defaultfalse
). Originally I was intending to have it only accept unparenthesized basic literals, but it would require too many ranges in rubocop's code to be changed that I re-evaluated.This change will allow
1..2
without parens but require the parens in(x || 1)..10
or(x || 1)..(y || 10)
. Having the cop act on each boundary individually is the clearest approach IMO because(x || 1..y || 10)
is just as ambiguous as without the parentheses.In order to avoid the ambiguity of
1..2.to_a
, method calls with a basic literal receiver always require parentheses, regardless ofRequireParenthesesForMethodChains
.Autocorrection is straightforward, wrapping any unacceptable boundaries in parens. However, I have marked this cop as
SafeAutocorrect: false
because it is likely that the intended code is not the same as the actual behaviour of the code. In other words,1..2.to_a
is equivalent to1..(2.to_a)
, which is what the cop will correct to, but the programmer almost definitely intended on(1..2).to_a
. The autocorrection will make it clear how ruby will actually evaluate this code, however.This seemed like it was going to be simple until it became complicated 😁
Fixes #4182.
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.