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 Guava Immutable{Set|List|Map} #586

Merged
merged 12 commits into from
Oct 22, 2024
Merged

Fix Guava Immutable{Set|List|Map} #586

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f4ae115
issue-489: fix ImmutableList.of(1, 2).stream()
BramliAK Oct 20, 2024
1a64764
fix conflicts
BramliAK Oct 20, 2024
a8f271d
Apply formatter to clear out automated suggestions
timtebeek Oct 22, 2024
e569532
Drop IntelliJ annotation
timtebeek Oct 22, 2024
ccf0f23
Minimize diff due to line wrap
timtebeek Oct 22, 2024
4962fad
Replace mutable field with identity check
timtebeek Oct 22, 2024
c77d32d
Format the tests while we're at it
timtebeek Oct 22, 2024
ad1c589
Add missing newline between tests
timtebeek Oct 22, 2024
3dda0a5
Drop `.contextSensitive` by updating name.type too
timtebeek Oct 22, 2024
636fc05
Standardize variable use around JavaTemplate
timtebeek Oct 22, 2024
387bf0b
Use withers on J.ParameterizedType in createNewTypeExpression
timtebeek Oct 22, 2024
aac0f25
Drop nonNull as method invocation; only used as method reference
timtebeek Oct 22, 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
331 changes: 213 additions & 118 deletions src/main/java/org/openrewrite/java/migrate/guava/AbstractNoGuavaImmutableOf.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,22 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.openrewrite.java.migrate.guava;

import static java.util.Collections.emptyList;
import static java.util.Objects.nonNull;

import java.util.ArrayList;
import java.util.List;
import org.jetbrains.annotations.NotNull;
import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.Tree;
import org.openrewrite.TreeVisitor;
import org.openrewrite.internal.ListUtils;
import org.openrewrite.java.JavaTemplate;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.MethodMatcher;
Expand All @@ -28,130 +37,216 @@
import org.openrewrite.java.tree.*;

import java.time.Duration;
import java.util.Objects;
import java.util.stream.Collectors;
import org.openrewrite.marker.Markers;

abstract class AbstractNoGuavaImmutableOf extends Recipe {

private final String guavaType;
private final String javaType;

AbstractNoGuavaImmutableOf(String guavaType, String javaType) {
this.guavaType = guavaType;
this.javaType = javaType;
}

private String getShortType(String fullyQualifiedType) {
return fullyQualifiedType.substring(javaType.lastIndexOf(".") + 1);
}

@Override
public String getDisplayName() {
return "Prefer `" + getShortType(javaType) + ".of(..)` in Java 9 or higher";
}

@Override
public String getDescription() {
return "Replaces `" + getShortType(guavaType) + ".of(..)` if the returned type is immediately down-cast.";
}

@Override
public Duration getEstimatedEffortPerOccurrence() {
return Duration.ofMinutes(10);
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
TreeVisitor<?, ExecutionContext> check = Preconditions.and(new UsesJavaVersion<>(9),
new UsesType<>(guavaType, false));
final MethodMatcher IMMUTABLE_MATCHER = new MethodMatcher(guavaType + " of(..)");
return Preconditions.check(check, new JavaVisitor<ExecutionContext>() {
@Override
public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
if (IMMUTABLE_MATCHER.matches(method) && isParentTypeDownCast(method)) {
maybeRemoveImport(guavaType);
maybeAddImport(javaType);

String template;
Object[] args;
if (method.getArguments().isEmpty() || method.getArguments().get(0) instanceof J.Empty) {
template = getShortType(javaType) + ".of()";
args = new Object[]{};
} else if ("com.google.common.collect.ImmutableMap".equals(guavaType)) {
template = getShortType(javaType) + ".of(#{any()}, #{any()})";
args = new Object[]{method.getArguments().get(0), method.getArguments().get(1)};
} else {
template = getShortType(javaType) + ".of(#{any()})";
args = new Object[]{method.getArguments().get(0)};
}

J.MethodInvocation templated = JavaTemplate.builder(template)
.imports(javaType)
.build()
.apply(getCursor(),
method.getCoordinates().replace(),
args);
return templated.getPadding().withArguments(method.getPadding().getArguments());
}
return super.visitMethodInvocation(method, ctx);
private final String guavaType;
private final String javaType;
private boolean methodUpdated = false;

AbstractNoGuavaImmutableOf(String guavaType, String javaType) {
this.guavaType = guavaType;
this.javaType = javaType;
}

private String getShortType(String fullyQualifiedType) {
return fullyQualifiedType.substring(javaType.lastIndexOf(".") + 1);
}

@Override
public String getDisplayName() {
return "Prefer `" + getShortType(javaType) + ".of(..)` in Java 9 or higher";
}

@Override
public String getDescription() {
return "Replaces `" + getShortType(guavaType) +
".of(..)` if the returned type is immediately down-cast.";
}

@Override
public Duration getEstimatedEffortPerOccurrence() {
return Duration.ofMinutes(10);
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
TreeVisitor<?, ExecutionContext> check = Preconditions.and(new UsesJavaVersion<>(9),
new UsesType<>(guavaType, false));
final MethodMatcher IMMUTABLE_MATCHER = new MethodMatcher(guavaType + " of(..)");
return Preconditions.check(check, new JavaVisitor<ExecutionContext>() {
@Override
public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
J.MethodInvocation mi = (J.MethodInvocation) super.visitMethodInvocation(method, ctx);
if (!IMMUTABLE_MATCHER.matches(mi) || !isParentTypeDownCast(mi)) {
return mi;
}
maybeRemoveImport(guavaType);
maybeAddImport(javaType);

String template;
Object[] args;
if (method.getArguments().isEmpty() || method.getArguments().get(0) instanceof J.Empty) {
template = getShortType(javaType) + ".of()";
args = new Object[]{};
} else if ("com.google.common.collect.ImmutableMap".equals(guavaType)) {
template = getShortType(javaType) + ".of(#{any()}, #{any()})";
args = new Object[]{method.getArguments().get(0), method.getArguments().get(1)};
} else {
template = getShortType(javaType) + ".of(#{any()})";
args = new Object[]{method.getArguments().get(0)};
}

methodUpdated = true;
J.MethodInvocation m = JavaTemplate.builder(template)
.contextSensitive()
.imports(javaType)
.build()
.apply(getCursor(),
mi.getCoordinates().replace(),
args);
m = m.getPadding().withArguments(method.getPadding().getArguments());
J.MethodInvocation p = getCursor().getValue();
m = m.withMethodType((JavaType.Method) visitType(p.getMethodType(), ctx));
return super.visitMethodInvocation(m, ctx);
}
@Override
public J.VariableDeclarations visitVariableDeclarations(J.VariableDeclarations multiVariable,
ExecutionContext ctx) {
methodUpdated = false;
J.VariableDeclarations mv =
(J.VariableDeclarations) super.visitVariableDeclarations(multiVariable, ctx);

if (methodUpdated && TypeUtils.isOfClassType(mv.getType(), guavaType)) {
JavaType newType = JavaType.buildType(javaType);
mv = mv.withTypeExpression(mv.getTypeExpression() == null ?
null :
createNewTypeExpression(mv.getTypeExpression(), newType)
);

mv = mv.withVariables(ListUtils.map(mv.getVariables(), variable -> {
JavaType.FullyQualified varType = TypeUtils.asFullyQualified(variable.getType());
if (nonNull(varType) && !varType.equals(newType)) {
return variable.withType(newType).withName(variable.getName().withType(newType));
}
return variable;
}));
}

private boolean isParentTypeDownCast(MethodCall immutableMethod) {
J parent = getCursor().dropParentUntil(J.class::isInstance).getValue();
boolean isParentTypeDownCast = false;
if (parent instanceof J.VariableDeclarations.NamedVariable) {
isParentTypeDownCast = isParentTypeMatched(((J.VariableDeclarations.NamedVariable) parent).getType());
} else if (parent instanceof J.Assignment) {
J.Assignment a = (J.Assignment) parent;
if (a.getVariable() instanceof J.Identifier && ((J.Identifier) a.getVariable()).getFieldType() != null) {
isParentTypeDownCast = isParentTypeMatched(((J.Identifier) a.getVariable()).getFieldType().getType());
} else if (a.getVariable() instanceof J.FieldAccess) {
isParentTypeDownCast = isParentTypeMatched(a.getVariable().getType());
}
} else if (parent instanceof J.Return) {
// Does not currently support returns in lambda expressions.
J j = getCursor().dropParentUntil(is -> is instanceof J.MethodDeclaration || is instanceof J.CompilationUnit).getValue();
if (j instanceof J.MethodDeclaration) {
TypeTree returnType = ((J.MethodDeclaration) j).getReturnTypeExpression();
if (returnType != null) {
isParentTypeDownCast = isParentTypeMatched(returnType.getType());
}
}
} else if (parent instanceof J.MethodInvocation) {
J.MethodInvocation m = (J.MethodInvocation) parent;
int index = m.getArguments().indexOf(immutableMethod);
if (m.getMethodType() != null && index != -1) {
isParentTypeDownCast = isParentTypeMatched(m.getMethodType().getParameterTypes().get(index));
}
} else if (parent instanceof J.NewClass) {
J.NewClass c = (J.NewClass) parent;
int index = 0;
if (c.getConstructorType() != null) {
for (Expression argument : c.getArguments()) {
if (IMMUTABLE_MATCHER.matches(argument)) {
break;
}
index++;
}
if (c.getConstructorType() != null) {
isParentTypeDownCast = isParentTypeMatched(c.getConstructorType().getParameterTypes().get(index));
}
}
} else if (parent instanceof J.NewArray) {
J.NewArray a = (J.NewArray) parent;
JavaType arrayType = a.getType();
while (arrayType instanceof JavaType.Array) {
arrayType = ((JavaType.Array) arrayType).getElemType();
}

isParentTypeDownCast = isParentTypeMatched(arrayType);
return mv;
}

@NotNull
private TypeTree createNewTypeExpression(TypeTree typeTree,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@NotNull
private TypeTree createNewTypeExpression(TypeTree typeTree,
private TypeTree createNewTypeExpression(TypeTree typeTree,

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@NotNull
private TypeTree createNewTypeExpression(TypeTree typeTree,
private TypeTree createNewTypeExpression(TypeTree typeTree,

JavaType newType) {
if (typeTree instanceof J.ParameterizedType) {
List<Expression> parameterizedTypes =
((J.ParameterizedType)typeTree).getTypeParameters();
List<JRightPadded<Expression>> jRightPaddedList = new ArrayList<>();
parameterizedTypes.forEach(
expression -> {
if(expression instanceof J.ParameterizedType && TypeUtils.isOfClassType(expression.getType(), guavaType)) {
jRightPaddedList.add(JRightPadded.build(((J.ParameterizedType)createNewTypeExpression((TypeTree) expression, newType))));
} else {
jRightPaddedList.add(JRightPadded.build(expression));
}
return isParentTypeDownCast;
}
});
JContainer<Expression> typeParameters = JContainer.build(jRightPaddedList);
NameTree clazz =
new J.Identifier(Tree.randomId(), Space.EMPTY, Markers.EMPTY, emptyList(),
getShortType(javaType), null, null);
return new J.ParameterizedType(
typeTree.getId(),
typeTree.getPrefix(),
typeTree.getMarkers(),
clazz,
typeParameters,
newType
);
}
return new J.Identifier(typeTree.getId(),
typeTree.getPrefix(),
Markers.EMPTY,
emptyList(),
getShortType(javaType),
newType,
null
);
}

private boolean isParentTypeMatched(@Nullable JavaType type) {
JavaType.FullyQualified fq = TypeUtils.asFullyQualified(type);
return TypeUtils.isOfClassType(fq, javaType) ||
TypeUtils.isOfClassType(fq, "java.lang.Object");

private boolean isParentTypeDownCast(MethodCall immutableMethod) {
J parent = getCursor().dropParentUntil(J.class::isInstance).getValue();
boolean isParentTypeDownCast = false;
if (parent instanceof J.VariableDeclarations.NamedVariable) {
isParentTypeDownCast =
isParentTypeMatched(((J.VariableDeclarations.NamedVariable) parent).getType());
} else if (parent instanceof J.Assignment) {
J.Assignment a = (J.Assignment) parent;
if (a.getVariable() instanceof J.Identifier &&
((J.Identifier) a.getVariable()).getFieldType() != null) {
isParentTypeDownCast =
isParentTypeMatched(((J.Identifier) a.getVariable()).getFieldType().getType());
} else if (a.getVariable() instanceof J.FieldAccess) {
isParentTypeDownCast = isParentTypeMatched(a.getVariable().getType());
}
} else if (parent instanceof J.Return) {
// Does not currently support returns in lambda expressions.
J j = getCursor().dropParentUntil(
is -> is instanceof J.MethodDeclaration || is instanceof J.CompilationUnit)
.getValue();
if (j instanceof J.MethodDeclaration) {
TypeTree returnType = ((J.MethodDeclaration) j).getReturnTypeExpression();
if (returnType != null) {
isParentTypeDownCast = isParentTypeMatched(returnType.getType());
}
}
} else if (parent instanceof J.MethodInvocation) {
J.MethodInvocation m = (J.MethodInvocation) parent;
int index = m.getArguments().indexOf(immutableMethod);
if (m.getMethodType() != null && index != -1 &&
!m.getMethodType().getParameterTypes().isEmpty()) {
isParentTypeDownCast =
isParentTypeMatched(m.getMethodType().getParameterTypes().get(index));
} else {
isParentTypeDownCast = true;
}
} else if (parent instanceof J.NewClass) {
J.NewClass c = (J.NewClass) parent;
int index = 0;
if (c.getConstructorType() != null) {
for (Expression argument : c.getArguments()) {
if (IMMUTABLE_MATCHER.matches(argument)) {
break;
}
index++;
}
if (c.getConstructorType() != null) {
isParentTypeDownCast =
isParentTypeMatched(c.getConstructorType().getParameterTypes().get(index));
}
});
}
}
} else if (parent instanceof J.NewArray) {
J.NewArray a = (J.NewArray) parent;
JavaType arrayType = a.getType();
while (arrayType instanceof JavaType.Array) {
arrayType = ((JavaType.Array) arrayType).getElemType();
}

isParentTypeDownCast = isParentTypeMatched(arrayType);
}
return isParentTypeDownCast;
}

private boolean isParentTypeMatched(@Nullable JavaType type) {
JavaType.FullyQualified fq = TypeUtils.asFullyQualified(type);
return TypeUtils.isOfClassType(fq, javaType) ||
TypeUtils.isOfClassType(fq, "java.lang.Object") ||
TypeUtils.isOfClassType(fq, guavaType);
}
});
}
}
Loading