Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix S1125 CodeFix: C# pattern matching in conditional operator #7719

Merged
merged 5 commits into from
Aug 4, 2023
Merged

Fix S1125 CodeFix: C# pattern matching in conditional operator #7719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5a98976
Add reproducer
CristianAmbrosini Aug 2, 2023
cbdb886
Fix codeFix
CristianAmbrosini Aug 3, 2023
5f8a553
Fix #7462
CristianAmbrosini Aug 3, 2023
d9b504d
Add always parenthesis and then simplify
CristianAmbrosini Aug 3, 2023
1227edd
Method renaming
CristianAmbrosini Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions analyzers/src/SonarAnalyzer.CSharp/Rules/BooleanLiteralUnnecessaryCodeFix.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,73 +281,63 @@ private static SyntaxNode ReplaceExpressionWithBinary(SyntaxNode nodeToReplace,
private static Document RewriteConditional(Document document, SyntaxNode root, SyntaxNode syntaxNode, ConditionalExpressionSyntax conditional)
{
var whenTrue = conditional.WhenTrue.RemoveParentheses();
if (whenTrue.Equals(syntaxNode)
&& CSharpEquivalenceChecker.AreEquivalent(syntaxNode, CSharpSyntaxHelper.TrueLiteralExpression))
if (whenTrue.Equals(syntaxNode) && syntaxNode.IsTrue())
{
var newRoot = ReplaceExpressionWithBinary(
conditional,
root,
SyntaxKind.LogicalOrExpression,
conditional.Condition,
conditional.WhenFalse);
AddParenthesis(conditional.WhenFalse));

return document.WithSyntaxRoot(newRoot);
}

if (whenTrue.Equals(syntaxNode)
&& CSharpEquivalenceChecker.AreEquivalent(syntaxNode, CSharpSyntaxHelper.FalseLiteralExpression))
if (whenTrue.Equals(syntaxNode) && syntaxNode.IsFalse())
{
var newRoot = ReplaceExpressionWithBinary(
conditional,
root,
SyntaxKind.LogicalAndExpression,
GetNegatedExpression(conditional.Condition),
conditional.WhenFalse);
AddParenthesis(conditional.WhenFalse));

return document.WithSyntaxRoot(newRoot);
}

var whenFalse = conditional.WhenFalse.RemoveParentheses();

if (whenFalse.Equals(syntaxNode)
&& CSharpEquivalenceChecker.AreEquivalent(syntaxNode, CSharpSyntaxHelper.TrueLiteralExpression))
if (whenFalse.Equals(syntaxNode) && syntaxNode.IsTrue())
{
var newRoot = ReplaceExpressionWithBinary(
conditional,
root,
SyntaxKind.LogicalOrExpression,
GetNegatedExpression(conditional.Condition),
conditional.WhenTrue);
AddParenthesis(conditional.WhenTrue));

return document.WithSyntaxRoot(newRoot);
}

if (whenFalse.Equals(syntaxNode)
&& CSharpEquivalenceChecker.AreEquivalent(syntaxNode, CSharpSyntaxHelper.FalseLiteralExpression))
if (whenFalse.Equals(syntaxNode) && syntaxNode.IsFalse())
{
var newRoot = ReplaceExpressionWithBinary(
conditional,
root,
SyntaxKind.LogicalAndExpression,
conditional.Condition,
conditional.WhenTrue);
AddParenthesis(conditional.WhenTrue));

return document.WithSyntaxRoot(newRoot);
}

return document;
}

private static ExpressionSyntax GetNegatedExpression(ExpressionSyntax expression)
{
var exp = expression;
if (expression is BinaryExpressionSyntax
|| expression is ConditionalExpressionSyntax)
{
exp = SyntaxFactory.ParenthesizedExpression(expression);
}
private static ExpressionSyntax GetNegatedExpression(ExpressionSyntax expression) =>
SyntaxFactory.PrefixUnaryExpression(SyntaxKind.LogicalNotExpression, AddParenthesis(expression));

return SyntaxFactory.PrefixUnaryExpression(SyntaxKind.LogicalNotExpression, exp);
}
private static ExpressionSyntax AddParenthesis(ExpressionSyntax expression) =>
SyntaxFactory.ParenthesizedExpression(expression).WithAdditionalAnnotations(Simplifier.Annotation);
}
}
12 changes: 12 additions & 0 deletions analyzers/tests/SonarAnalyzer.UnitTest/TestCases/BooleanLiteralUnnecessary.CSharp9.Fixed.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,17 @@ void IsNotPattern(bool a, bool? b)

var x = a is not true ? throw new Exception() : false;
}

// https://github.com/SonarSource/sonar-dotnet/issues/2618
public void Repro_2618(Item item)
{
var booleanVariable = !(item is not Item myItem) && myItem.Required; // Fixed
booleanVariable = item is not Item myItem2 || myItem2.Required; // Fixed
}
}

public class Item
{
public bool Required { get; set; }
}
}
12 changes: 12 additions & 0 deletions analyzers/tests/SonarAnalyzer.UnitTest/TestCases/BooleanLiteralUnnecessary.CSharp9.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,17 @@ void IsNotPattern(bool a, bool? b)

var x = a is not true ? throw new Exception() : false;
}

// https://github.com/SonarSource/sonar-dotnet/issues/2618
public void Repro_2618(Item item)
{
var booleanVariable = item is not Item myItem ? false : myItem.Required; // Noncompliant
booleanVariable = item is not Item myItem2 ? true : myItem2.Required; // Noncompliant
}
}

public class Item
{
public bool Required { get; set; }
}
}
13 changes: 13 additions & 0 deletions analyzers/tests/SonarAnalyzer.UnitTest/TestCases/BooleanLiteralUnnecessary.Fixed.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,13 @@ public BooleanLiteralUnnecessary(bool a, bool b, bool? c, Item item)
};
}

// https://github.com/SonarSource/sonar-dotnet/issues/2618
public void Repro_2618(Item item)
{
var booleanVariable = item is Item myItem && myItem.Required; // Fixed
booleanVariable = !(item is Item myItem2) || myItem2.Required; // Fixed
}

public static void SomeFunc(bool x) { }

private bool Foo()
Expand Down Expand Up @@ -174,6 +181,12 @@ public void ThrowExpressionIsIgnored(bool condition, int number)
x = condition is true ? throw new Exception() : false;
}
}

// https://github.com/SonarSource/sonar-dotnet/issues/7462
public void Repro_7462(object obj)
{
var a = !(obj == null) && (obj.ToString() == "x" || obj.ToString() == "y"); // Fixed
}
}

public class Item
Expand Down
13 changes: 13 additions & 0 deletions analyzers/tests/SonarAnalyzer.UnitTest/TestCases/BooleanLiteralUnnecessary.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,13 @@ public BooleanLiteralUnnecessary(bool a, bool b, bool? c, Item item)
};
}

// https://github.com/SonarSource/sonar-dotnet/issues/2618
public void Repro_2618(Item item)
{
var booleanVariable = item is Item myItem ? myItem.Required : false; // Noncompliant
booleanVariable = item is Item myItem2 ? myItem2.Required : true; // Noncompliant
}

public static void SomeFunc(bool x) { }

private bool Foo()
Expand Down Expand Up @@ -191,6 +198,12 @@ public void ThrowExpressionIsIgnored(bool condition, int number)
x = condition is true ? throw new Exception() : false;
}
}

// https://github.com/SonarSource/sonar-dotnet/issues/7462
public void Repro_7462(object obj)
{
var a = obj == null ? false : obj.ToString() == "x" || obj.ToString() == "y"; // Noncompliant
}
}

public class Item
Expand Down