Add new Lint/LiteralAssignmentInCondition
cop
#12420
Merged
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.
Summary
This PR adds a new
Lint/LiteralAssignmentInCondition
cop, which checks for literal assignments in the conditions ofif
,while
, anduntil
. It emulates the following Ruby warning:As a lint cop, it cannot be determined if
==
is appropriate as intended, therefore this cop does not provide autocorrection.Literal assignment used within a condition always triggers a Ruby warning, regardless of parentheses. This PR prevents the Ruby warning from being overlooked due to the
ruby -w
option.Additional Information
Here, the differences between similar cops,
Lint/LiteralAssignmentInCondition
cop andLint/LiteralAsCondition
cop are discussed.Lint/LiteralAssignmentInCondition
copA similar
Lint/LiteralAssignmentInCondition
cop already exists, but as mentioned above, literal assignments are Ruby's warned about regardless of the presence of parentheses:Therefore, a new cop has been created separate from
Lint/LiteralAssignmentInCondition
.Furthermore, as documented for
Lint/LiteralAssignmentInCondition
cop, literal assignments are never consideredgood
case, so= true
has been replaced with= value
.Lint/LiteralAsCondition
copAdditionally, the existing
Lint/LiteralAsCondition
cop addresses a slightly different Ruby warning:This is another reason for choosing to implement a new cop.
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.