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

Jump to bottom

Instanceof pattern: exclusion for Stream.collect(..) #337

Closed
wants to merge 2 commits into from
Closed

Instanceof pattern: exclusion for Stream.collect(..) #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b202d0
Instanceof pattern: exclusion for `Stream#collect(..)`
BoykoAlex Sep 13, 2024
069b9aa
Apply suggestions from code review
timtebeek Sep 18, 2024
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
75 changes: 55 additions & 20 deletions src/main/java/org/openrewrite/staticanalysis/InstanceOfPatternMatch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.VariableNameUtils;
import org.openrewrite.java.search.SemanticallyEqual;
import org.openrewrite.java.search.UsesJavaVersion;
Expand All @@ -45,6 +46,8 @@
@EqualsAndHashCode(callSuper = false)
public class InstanceOfPatternMatch extends Recipe {

private static MethodMatcher STREAM_COLLECT_MATCHER = new MethodMatcher("java.util.stream.Stream collect(..)");

@Override
public String getDisplayName() {
return "Changes code to use Java 17's `instanceof` pattern matching";
Expand Down Expand Up @@ -74,7 +77,8 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
public @Nullable J postVisit(J tree, ExecutionContext ctx) {
J result = super.postVisit(tree, ctx);
InstanceOfPatternReplacements original = getCursor().getMessage("flowTypeScope");
if (original != null && !original.isEmpty()) {
boolean exclusion = getCursor().getNearestMessage("exclusionScope", false);
if (original != null && !original.isEmpty() && !exclusion) {
return UseInstanceOfPatternMatching.refactor(result, original, getCursor().getParentOrThrow());
}
return result;
Expand Down Expand Up @@ -144,6 +148,55 @@ public J visitTypeCast(J.TypeCast typeCast, ExecutionContext ctx) {
}
return result;
}

@Override
public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
J j = super.visitMethodInvocation(method, ctx);
if (j instanceof J.MethodInvocation) {
J.MethodInvocation m = (J.MethodInvocation) j;
if (STREAM_COLLECT_MATCHER.matches(m, false)) {
Cursor cursorWithFlowTypeScope = getNearestCursorWithMessage(getCursor(), "flowTypeScope");
InstanceOfPatternReplacements replacements = cursorWithFlowTypeScope.getMessage("flowTypeScope");
if (replacements != null) {
Expression originalSelect = selectFromMethodInvocationChain(m);
while (originalSelect instanceof J.Parentheses) {
originalSelect = originalSelect.unwrap();
}
if (originalSelect instanceof J.Identifier) {
J.Identifier varRef = (J.Identifier) originalSelect;
if (replacements.variablesToDelete.values().stream().anyMatch(nv -> nv.getSimpleName().equals(varRef.getSimpleName()) && nv.getType().equals(varRef.getType()))) {
cursorWithFlowTypeScope.putMessage("exclusionScope", true);
}
} else if (originalSelect instanceof J.TypeCast) {
J.TypeCast typeCast = (J.TypeCast) originalSelect;
if (replacements.replacements.containsKey(typeCast)) {
cursorWithFlowTypeScope.putMessage("exclusionScope", true);
}
}
}
}
}
return j;
}

private Expression selectFromMethodInvocationChain(J.MethodInvocation method) {
J.MethodInvocation m = method;
for (; m.getSelect() instanceof J.MethodInvocation; m = (J.MethodInvocation) m.getSelect()) {}
return m.getSelect();
}

public @Nullable Cursor getNearestCursorWithMessage(Cursor cursor, String key) {
if (cursor == null) {
return null;
}
Object msg = cursor.getMessage(key);
if (msg == null) {
return getNearestCursorWithMessage(cursor.getParent(), key);
} else {
return cursor;
}
}

});
}

Expand Down Expand Up @@ -215,6 +268,7 @@ public J.InstanceOf processInstanceOf(J.InstanceOf instanceOf, Cursor cursor) {
if (!contextScopes.containsKey(instanceOf)) {
return instanceOf;
}

@Nullable JavaType type = ((TypedTree) instanceOf.getClazz()).getType();
String name = patternVariableName(instanceOf, cursor);
J.InstanceOf result = instanceOf.withPattern(new J.Identifier(
Expand All @@ -225,25 +279,6 @@ public J.InstanceOf processInstanceOf(J.InstanceOf instanceOf, Cursor cursor) {
name,
type,
null));
JavaType.FullyQualified fqType = TypeUtils.asFullyQualified(type);
if (fqType != null && !fqType.getTypeParameters().isEmpty() && !(instanceOf.getClazz() instanceof J.ParameterizedType)) {
TypedTree oldTypeTree = (TypedTree) instanceOf.getClazz();

// Each type parameter is turned into a wildcard, i.e. `List` -> `List<?>` or `Map.Entry` -> `Map.Entry<?,?>`
List<Expression> wildcardsList = IntStream.range(0, fqType.getTypeParameters().size())
.mapToObj(i -> new J.Wildcard(randomId(), Space.EMPTY, Markers.EMPTY, null, null))
.collect(Collectors.toList());

J.ParameterizedType newTypeTree = new J.ParameterizedType(
randomId(),
oldTypeTree.getPrefix(),
Markers.EMPTY,
oldTypeTree.withPrefix(Space.EMPTY),
null,
oldTypeTree.getType()
).withTypeParameters(wildcardsList);
result = result.withClazz(newTypeTree);
}

// update entry in replacements to share the pattern variable name
for (Map.Entry<J.TypeCast, J.InstanceOf> entry : replacements.entrySet()) {
Expand Down
Loading