org.openrewrite.java.ReorderMethodArguments Maven / Gradle / Ivy
Show all versions of rewrite-java Show documentation
/*
* Copyright 2020 the original author or authors.
*
* 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
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* 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;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
import lombok.EqualsAndHashCode;
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
import org.openrewrite.java.search.DeclaresMethod;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.*;
import java.util.ArrayList;
import java.util.List;
import static java.util.Arrays.asList;
import static java.util.Objects.requireNonNull;
/**
* This recipe finds method invocations matching the given method pattern and reorders the arguments based on the ordered
* array of parameter names.
*/
@Value
@EqualsAndHashCode(callSuper = false)
public class ReorderMethodArguments extends Recipe {
/**
* A method pattern that is used to find matching method invocations.
* See {@link MethodMatcher} for details on the expression's syntax.
*/
@Option(displayName = "Method pattern",
description = "A method pattern that is used to find matching method invocations.",
example = "com.yourorg.A foo(String, Integer, Integer)")
String methodPattern;
/**
* An array of parameter names that indicates the new order in which those arguments should be arranged.
*/
@Option(displayName = "New parameter names",
description = "An array of parameter names that indicates the new order in which those arguments should be arranged.",
example = "[foo, bar, baz]")
String[] newParameterNames;
/**
* If the original method signature is not type-attributed, this is an optional list that indicates the original order
* in which the arguments were arranged.
*/
@Option(displayName = "Old parameter names",
description = "If the original method signature is not type-attributed, this is an optional list that indicates the original order in which the arguments were arranged.",
required = false,
example = "[baz, bar, foo]")
String @Nullable [] oldParameterNames;
@Option(displayName = "Ignore type definition",
description = "When set to `true` the definition of the old type will be left untouched. " +
"This is useful when you're replacing usage of a class but don't want to rename it.",
required = false)
@Nullable
Boolean ignoreDefinition;
@Option(displayName = "Match on overrides",
description = "When enabled, find methods that are overrides of the method pattern.",
required = false)
@Nullable
Boolean matchOverrides;
@JsonPOJOBuilder(withPrefix = "")
public static class Builder {
}
@Override
public String getDisplayName() {
return "Reorder method arguments";
}
@Override
public String getDescription() {
return "Reorder method arguments into the specified order.";
}
@Override
public TreeVisitor getVisitor() {
return Preconditions.check(new JavaVisitor() {
@Override
public J visit(@Nullable Tree tree, ExecutionContext ctx) {
if (tree instanceof JavaSourceFile) {
JavaSourceFile cu = (JavaSourceFile) requireNonNull(tree);
if (Boolean.TRUE.equals(ignoreDefinition)) {
J j = new DeclaresMethod<>(methodPattern, true).visitNonNull(cu, ctx);
if (cu != j) {
return cu;
}
}
return new UsesMethod<>(methodPattern).visitNonNull(cu, ctx);
}
return super.visit(tree, ctx);
}
}, new ReorderMethodArgumentsVisitor(new MethodMatcher(methodPattern, matchOverrides)));
}
private class ReorderMethodArgumentsVisitor extends JavaIsoVisitor {
private final MethodMatcher methodMatcher;
private ReorderMethodArgumentsVisitor(MethodMatcher methodMatcher) {
this.methodMatcher = methodMatcher;
}
@Override
public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
return (J.MethodInvocation) visitMethodCall(super.visitMethodInvocation(method, ctx));
}
@Override
public J.NewClass visitNewClass(J.NewClass newClass, ExecutionContext ctx) {
return (J.NewClass) visitMethodCall(super.visitNewClass(newClass, ctx));
}
private MethodCall visitMethodCall(MethodCall m) {
if (methodMatcher.matches(m) && m.getMethodType() != null) {
@SuppressWarnings("ConstantConditions") List paramNames =
oldParameterNames == null || oldParameterNames.length == 0 ?
m.getMethodType().getParameterNames() :
asList(oldParameterNames);
List> originalArgs = getPaddedArguments(m);
int resolvedParamCount = m.getMethodType().getParameterTypes().size();
int i = 0;
List> reordered = new ArrayList<>(originalArgs.size());
List reorderedNames = new ArrayList<>(originalArgs.size());
List reorderedTypes = new ArrayList<>(originalArgs.size());
List formattings = new ArrayList<>(originalArgs.size());
List rightFormattings = new ArrayList<>(originalArgs.size());
for (String name : newParameterNames) {
int fromPos = paramNames.indexOf(name);
if (originalArgs.size() > resolvedParamCount && fromPos == resolvedParamCount - 1) {
// this is a varargs argument
List> varargs = originalArgs.subList(fromPos, originalArgs.size());
reordered.addAll(varargs);
for (int j = 0; j < varargs.size(); j++) {
reorderedNames.add(name + j);
reorderedTypes.add(varargs.get(j).getElement().getType());
}
for (JRightPadded exp : originalArgs.subList(i, (i++) + varargs.size())) {
formattings.add(exp.getElement().getPrefix());
rightFormattings.add(exp.getAfter());
}
} else if (fromPos >= 0 && originalArgs.size() > fromPos) {
JRightPadded originalArg = originalArgs.get(fromPos);
reordered.add(originalArg);
reorderedNames.add(name);
reorderedTypes.add(originalArg.getElement().getType());
formattings.add(originalArgs.get(i).getElement().getPrefix());
rightFormattings.add(originalArgs.get(i++).getAfter());
}
}
boolean changed = false;
i = 0;
for (JRightPadded expression : reordered) {
final int index = i;
reordered.set(i, expression
.map(e -> e.withPrefix(formattings.get(index)))
.withAfter(rightFormattings.get(index)));
if (reordered.get(i) != originalArgs.get(i)) {
changed = true;
}
i++;
}
if (changed) {
JavaType.Method mt = m.getMethodType()
.withParameterNames(reorderedNames)
.withParameterTypes(reorderedTypes);
m = withPaddedArguments(m, reordered)
.withMethodType(mt);
if (m instanceof J.MethodInvocation && ((J.MethodInvocation) m).getName().getType() != null) {
m = ((J.MethodInvocation) m).withName(((J.MethodInvocation) m).getName().withType(mt));
}
}
}
return m;
}
private List> getPaddedArguments(MethodCall m) {
if (m instanceof J.MethodInvocation) {
return ((J.MethodInvocation) m).getPadding().getArguments().getPadding().getElements();
} else if (m instanceof J.NewClass) {
return ((J.NewClass) m).getPadding().getArguments().getPadding().getElements();
} else {
throw new IllegalArgumentException("Unknown MethodCall type");
}
}
private MethodCall withPaddedArguments(MethodCall m, List> reordered) {
if (m instanceof J.MethodInvocation) {
J.MethodInvocation mi = (J.MethodInvocation) m;
return mi.getPadding().withArguments(
mi.getPadding().getArguments().getPadding().withElements(reordered)
);
} else if (m instanceof J.NewClass) {
J.NewClass nc = (J.NewClass) m;
return nc.getPadding().withArguments(
nc.getPadding().getArguments().getPadding().withElements(reordered)
);
} else {
throw new IllegalArgumentException("Unknown MethodCall type");
}
}
}
}