Merge pull request #302 from crystal-ameba/Sija/style-parenthesized-assignments

This commit is contained in:
Sijawusz Pur Rahnama 2022-11-20 00:39:58 +01:00 committed by GitHub
commit a3e5f2d206
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 46 additions and 15 deletions

View File

@ -1,9 +1,9 @@
require "../../../spec_helper" require "../../../spec_helper"
module Ameba::Rule::Style module Ameba::Rule::Style
subject = RedundantParentheses.new subject = ParenthesesAroundCondition.new
describe RedundantParentheses do describe ParenthesesAroundCondition do
{% for keyword in %w(if unless while until) %} {% for keyword in %w(if unless while until) %}
context "{{ keyword.id }}" do context "{{ keyword.id }}" do
it "reports if redundant parentheses are found" do it "reports if redundant parentheses are found" do
@ -51,7 +51,7 @@ module Ameba::Rule::Style
end end
it "allows to configure assignments" do it "allows to configure assignments" do
rule = Rule::Style::RedundantParentheses.new rule = Rule::Style::ParenthesesAroundCondition.new
rule.exclude_ternary = false rule.exclude_ternary = false
expect_issue rule, <<-CRYSTAL expect_issue rule, <<-CRYSTAL
@ -75,7 +75,7 @@ module Ameba::Rule::Style
end end
end end
context "#exclude_assignments=" do context "#allow_safe_assignment=" do
it "reports assignments by default" do it "reports assignments by default" do
expect_issue subject, <<-CRYSTAL expect_issue subject, <<-CRYSTAL
if (foo = @foo) if (foo = @foo)
@ -83,11 +83,30 @@ module Ameba::Rule::Style
foo foo
end end
CRYSTAL CRYSTAL
expect_no_issues subject, <<-CRYSTAL
if !(foo = @foo)
foo
end
CRYSTAL
expect_no_issues subject, <<-CRYSTAL
if foo = @foo
foo
end
CRYSTAL
end end
it "allows to configure assignments" do it "allows to configure assignments" do
rule = Rule::Style::RedundantParentheses.new rule = Rule::Style::ParenthesesAroundCondition.new
rule.exclude_assignments = true rule.allow_safe_assignment = true
expect_issue rule, <<-CRYSTAL
if foo = @foo
# ^^^^^^^^^^ error: Missing parentheses
foo
end
CRYSTAL
expect_no_issues rule, <<-CRYSTAL expect_no_issues rule, <<-CRYSTAL
if (foo = @foo) if (foo = @foo)

View File

@ -1,5 +1,6 @@
module Ameba::Rule::Style module Ameba::Rule::Style
# A rule that disallows redundant parentheses around control expressions. # A rule that checks for the presence of superfluous parentheses
# around the condition of `if`, `unless`, `case, `while` and `until`.
# #
# For example, this is considered invalid: # For example, this is considered invalid:
# #
@ -20,20 +21,21 @@ module Ameba::Rule::Style
# YAML configuration example: # YAML configuration example:
# #
# ``` # ```
# Style/RedundantParentheses: # Style/ParenthesesAroundCondition:
# Enabled: true # Enabled: true
# ExcludeTernary: false # ExcludeTernary: false
# ExcludeAssignments: false # AllowSafeAssignment: false
# ``` # ```
class RedundantParentheses < Base class ParenthesesAroundCondition < Base
properties do properties do
description "Disallows redundant parentheses around control expressions" description "Disallows redundant parentheses around control expressions"
exclude_ternary false exclude_ternary false
exclude_assignments false allow_safe_assignment false
end end
MSG = "Redundant parentheses" MSG_REDUNDANT = "Redundant parentheses"
MSG_MISSING = "Missing parentheses"
protected def strip_parentheses?(node, in_ternary) : Bool protected def strip_parentheses?(node, in_ternary) : Bool
case node case node
@ -44,24 +46,34 @@ module Ameba::Rule::Style
when Crystal::Yield when Crystal::Yield
!in_ternary || node.has_parentheses? || node.exps.empty? !in_ternary || node.has_parentheses? || node.exps.empty?
when Crystal::Assign, Crystal::OpAssign, Crystal::MultiAssign when Crystal::Assign, Crystal::OpAssign, Crystal::MultiAssign
!in_ternary && !exclude_assignments !in_ternary && !allow_safe_assignment
else else
true true
end end
end end
def test(source, node : Crystal::If | Crystal::Unless | Crystal::Case | Crystal::While | Crystal::Until) def test(source, node : Crystal::If | Crystal::Unless | Crystal::Case | Crystal::While | Crystal::Until)
cond = node.cond
if cond.is_a?(Crystal::Assign) && allow_safe_assignment
issue_for cond, MSG_MISSING do |corrector|
corrector.insert_before(cond, '(')
corrector.insert_after(cond, ')')
end
return
end
is_ternary = node.is_a?(Crystal::If) && node.ternary? is_ternary = node.is_a?(Crystal::If) && node.ternary?
return if is_ternary && exclude_ternary return if is_ternary && exclude_ternary
return unless (cond = node.cond).is_a?(Crystal::Expressions) return unless cond.is_a?(Crystal::Expressions)
return unless cond.keyword.paren? return unless cond.keyword.paren?
return unless exp = cond.single_expression? return unless exp = cond.single_expression?
return unless strip_parentheses?(exp, is_ternary) return unless strip_parentheses?(exp, is_ternary)
issue_for cond, MSG do |corrector| issue_for cond, MSG_REDUNDANT do |corrector|
corrector.remove_trailing(cond, 1) corrector.remove_trailing(cond, 1)
corrector.remove_leading(cond, 1) corrector.remove_leading(cond, 1)
end end