-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce
ClassCastLambdaUsage
check (#1381)
This new check replaces the `ClassLiteralCast` Refaster rule, as the latter produced invalid code by suggesting expressions of the form `T.class::cast` for generic `T`.
- Loading branch information
1 parent
507d759
commit caf2a86
Showing
7 changed files
with
144 additions
and
34 deletions.
There are no files selected for viewing
65 changes: 65 additions & 0 deletions
65
...-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/ClassCastLambdaUsage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
package tech.picnic.errorprone.bugpatterns; | ||
|
||
import static com.google.errorprone.BugPattern.LinkType.CUSTOM; | ||
import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION; | ||
import static com.google.errorprone.BugPattern.StandardTags.SIMPLIFICATION; | ||
import static tech.picnic.errorprone.utils.Documentation.BUG_PATTERNS_BASE_URL; | ||
|
||
import com.google.auto.service.AutoService; | ||
import com.google.common.collect.Iterables; | ||
import com.google.errorprone.BugPattern; | ||
import com.google.errorprone.VisitorState; | ||
import com.google.errorprone.bugpatterns.BugChecker; | ||
import com.google.errorprone.bugpatterns.BugChecker.LambdaExpressionTreeMatcher; | ||
import com.google.errorprone.fixes.SuggestedFix; | ||
import com.google.errorprone.matchers.Description; | ||
import com.google.errorprone.util.ASTHelpers; | ||
import com.sun.source.tree.LambdaExpressionTree; | ||
import com.sun.source.tree.TypeCastTree; | ||
import com.sun.source.tree.VariableTree; | ||
import com.sun.tools.javac.code.Type; | ||
import tech.picnic.errorprone.utils.SourceCode; | ||
|
||
/** | ||
* A {@link BugChecker} that flags lambda expressions that can be replaced with a method reference | ||
* of the form {@code T.class::cast}. | ||
*/ | ||
// XXX: Consider folding this logic into the `MethodReferenceUsage` check of the | ||
// `error-prone-experimental` module. | ||
// XXX: This check and its tests are structurally nearly identical to `IsInstanceLambdaUsage`. | ||
// Unless folded into `MethodReferenceUsage`, consider merging the two. | ||
@AutoService(BugChecker.class) | ||
@BugPattern( | ||
summary = "Prefer `Class::cast` method reference over equivalent lambda expression", | ||
link = BUG_PATTERNS_BASE_URL + "ClassCastLambdaUsage", | ||
linkType = CUSTOM, | ||
severity = SUGGESTION, | ||
tags = SIMPLIFICATION) | ||
public final class ClassCastLambdaUsage extends BugChecker implements LambdaExpressionTreeMatcher { | ||
private static final long serialVersionUID = 1L; | ||
|
||
/** Instantiates a new {@link ClassCastLambdaUsage} instance. */ | ||
public ClassCastLambdaUsage() {} | ||
|
||
@Override | ||
public Description matchLambdaExpression(LambdaExpressionTree tree, VisitorState state) { | ||
if (tree.getParameters().size() != 1 || !(tree.getBody() instanceof TypeCastTree typeCast)) { | ||
return Description.NO_MATCH; | ||
} | ||
|
||
Type type = ASTHelpers.getType(typeCast); | ||
if (type == null || type.isParameterized()) { | ||
return Description.NO_MATCH; | ||
} | ||
|
||
VariableTree param = Iterables.getOnlyElement(tree.getParameters()); | ||
if (!ASTHelpers.getSymbol(param).equals(ASTHelpers.getSymbol(typeCast.getExpression()))) { | ||
return Description.NO_MATCH; | ||
} | ||
|
||
return describeMatch( | ||
tree, | ||
SuggestedFix.replace( | ||
tree, SourceCode.treeToString(typeCast.getType(), state) + ".class::cast")); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
...ne-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/ClassCastLambdaUsageTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
package tech.picnic.errorprone.bugpatterns; | ||
|
||
import com.google.errorprone.BugCheckerRefactoringTestHelper; | ||
import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode; | ||
import com.google.errorprone.CompilationTestHelper; | ||
import org.junit.jupiter.api.Test; | ||
|
||
final class ClassCastLambdaUsageTest { | ||
@Test | ||
void identification() { | ||
CompilationTestHelper.newInstance(ClassCastLambdaUsage.class, getClass()) | ||
.addSourceLines( | ||
"A.java", | ||
"import com.google.common.collect.ImmutableSet;", | ||
"import java.util.stream.Stream;", | ||
"", | ||
"class A {", | ||
" void m() {", | ||
" Number localVariable = 0;", | ||
"", | ||
" Stream.of(0).map(i -> i);", | ||
" Stream.of(1).map(i -> i + 1);", | ||
" Stream.of(2).map(Integer.class::cast);", | ||
" Stream.of(3).map(i -> (Integer) 2);", | ||
" Stream.of(4).map(i -> (Integer) localVariable);", | ||
" // XXX: Ideally this case is also flagged. Pick this up in the context of merging the", | ||
" // `ClassCastLambdaUsage` and `MethodReferenceUsage` checks, or introduce a separate check that", | ||
" // simplifies unnecessary block lambda expressions.", | ||
" Stream.of(5)", | ||
" .map(", | ||
" i -> {", | ||
" return (Integer) i;", | ||
" });", | ||
" Stream.<ImmutableSet>of(ImmutableSet.of(5)).map(l -> (ImmutableSet<Number>) l);", | ||
" Stream.of(ImmutableSet.of(6)).map(l -> (ImmutableSet<?>) l);", | ||
" Stream.of(7).reduce((a, b) -> (Integer) a);", | ||
"", | ||
" // BUG: Diagnostic contains:", | ||
" Stream.of(8).map(i -> (Integer) i);", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
void replacement() { | ||
BugCheckerRefactoringTestHelper.newInstance(ClassCastLambdaUsage.class, getClass()) | ||
.addInputLines( | ||
"A.java", | ||
"import java.util.stream.Stream;", | ||
"", | ||
"class A {", | ||
" void m() {", | ||
" Stream.of(1).map(i -> (Integer) i);", | ||
" }", | ||
"}") | ||
.addOutputLines( | ||
"A.java", | ||
"import java.util.stream.Stream;", | ||
"", | ||
"class A {", | ||
" void m() {", | ||
" Stream.of(1).map(Integer.class::cast);", | ||
" }", | ||
"}") | ||
.doTest(TestMode.TEXT_MATCH); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters