-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix/no guava immutable recipes (#258)
* Fix and Abstract NoGuavaImmutable recipes * format & imports * Use constructors to pass guavaType and javaType * Reduce visibility * Make constructors public --------- Co-authored-by: Tim te Beek <tim@moderne.io>
- Loading branch information
Showing
7 changed files
with
297 additions
and
499 deletions.
There are no files selected for viewing
184 changes: 184 additions & 0 deletions
184
src/main/java/org/openrewrite/java/migrate/guava/AbstractNoGuavaImmutableOf.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,184 @@ | ||
| /* | ||
| * Copyright 2023 the original author or authors. | ||
| * <p> | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * <p> | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.openrewrite.java.migrate.guava; | ||
|
|
||
| import org.openrewrite.ExecutionContext; | ||
| import org.openrewrite.Preconditions; | ||
| import org.openrewrite.Recipe; | ||
| import org.openrewrite.TreeVisitor; | ||
| import org.openrewrite.internal.lang.Nullable; | ||
| import org.openrewrite.java.JavaTemplate; | ||
| import org.openrewrite.java.JavaVisitor; | ||
| import org.openrewrite.java.MethodMatcher; | ||
| import org.openrewrite.java.search.UsesJavaVersion; | ||
| import org.openrewrite.java.search.UsesType; | ||
| import org.openrewrite.java.tree.*; | ||
|
|
||
| import java.time.Duration; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| 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()) { | ||
| maybeRemoveImport(guavaType); | ||
| maybeAddImport(javaType); | ||
|
|
||
| String template = method.getArguments().stream() | ||
| .map(arg -> { | ||
| if (arg.getType() instanceof JavaType.Primitive) { | ||
| String type = ""; | ||
| if (JavaType.Primitive.Boolean == arg.getType()) { | ||
| type = "Boolean"; | ||
| } else if (JavaType.Primitive.Byte == arg.getType()) { | ||
| type = "Byte"; | ||
| } else if (JavaType.Primitive.Char == arg.getType()) { | ||
| type = "Character"; | ||
| } else if (JavaType.Primitive.Double == arg.getType()) { | ||
| type = "Double"; | ||
| } else if (JavaType.Primitive.Float == arg.getType()) { | ||
| type = "Float"; | ||
| } else if (JavaType.Primitive.Int == arg.getType()) { | ||
| type = "Integer"; | ||
| } else if (JavaType.Primitive.Long == arg.getType()) { | ||
| type = "Long"; | ||
| } else if (JavaType.Primitive.Short == arg.getType()) { | ||
| type = "Short"; | ||
| } else if (JavaType.Primitive.String == arg.getType()) { | ||
| type = "String"; | ||
| } | ||
| return TypeUtils.asFullyQualified(JavaType.buildType("java.lang." + type)); | ||
| } else { | ||
| return TypeUtils.asFullyQualified(arg.getType()); | ||
| } | ||
| }) | ||
| .filter(Objects::nonNull) | ||
| .map(type -> "#{any(" + type.getFullyQualifiedName() + ")}") | ||
| .collect(Collectors.joining(",", getShortType(javaType) + ".of(", ")")); | ||
|
|
||
| return JavaTemplate.builder(template) | ||
| .contextSensitive() | ||
| .imports(javaType) | ||
| .build() | ||
| .apply(getCursor(), | ||
| method.getCoordinates().replace(), | ||
| method.getArguments().get(0) instanceof J.Empty ? new Object[]{} : method.getArguments().toArray()); | ||
| } | ||
| return super.visitMethodInvocation(method, ctx); | ||
| } | ||
|
|
||
| private boolean isParentTypeDownCast() { | ||
| 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; | ||
| if (m.getMethodType() != null) { | ||
| int index = 0; | ||
| for (Expression argument : m.getArguments()) { | ||
| if (IMMUTABLE_MATCHER.matches(argument)) { | ||
| break; | ||
| } | ||
| index++; | ||
| } | ||
| 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 isParentTypeDownCast; | ||
| } | ||
|
|
||
| private boolean isParentTypeMatched(@Nullable JavaType type) { | ||
| JavaType.FullyQualified fq = TypeUtils.asFullyQualified(type); | ||
| return TypeUtils.isOfClassType(fq, javaType) | ||
| || TypeUtils.isOfClassType(fq, "java.lang.Object"); | ||
| } | ||
| }); | ||
| } | ||
| } |
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
Oops, something went wrong.