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

StringFormatted should not wrap first argument by default in Java 17 upgrade #618

Merged
merged 1 commit into from
Dec 4, 2024
Merged

StringFormatted should not wrap first argument by default in Java 17 upgrade #618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 59 additions & 47 deletions src/main/java/org/openrewrite/java/migrate/lang/StringFormatted.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,16 @@

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.search.UsesJavaVersion;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.*;
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JRightPadded;
import org.openrewrite.java.tree.Space;
import org.openrewrite.marker.Markers;

import java.time.Duration;
Expand All @@ -40,6 +41,13 @@ public class StringFormatted extends Recipe {

private static final MethodMatcher STRING_FORMAT = new MethodMatcher("java.lang.String format(String, ..)");

@Option(displayName = "Add parentheses around the first argument",
description = "Add parentheses around the first argument if it is not a simple expression. " +
"Default true; if false no change will be made. ",
required = false)
@Nullable
Boolean addParentheses;

@Override
public String getDisplayName() {
return "Prefer `String.formatted(Object...)`";
Expand All @@ -51,52 +59,56 @@ public String getDescription() {
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return Preconditions.check(
Preconditions.and(new UsesJavaVersion<>(17), new UsesMethod<>(STRING_FORMAT)),
new StringFormattedVisitor());
public Duration getEstimatedEffortPerOccurrence() {
return Duration.ofMinutes(1);
}

private static class StringFormattedVisitor extends JavaVisitor<ExecutionContext> {
@Override
public J visitMethodInvocation(J.MethodInvocation methodInvocation, ExecutionContext ctx) {
methodInvocation = (J.MethodInvocation) super.visitMethodInvocation(methodInvocation, ctx);
if (!STRING_FORMAT.matches(methodInvocation) || methodInvocation.getMethodType() == null) {
return methodInvocation;
}
@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
TreeVisitor<?, ExecutionContext> check = Preconditions.and(new UsesJavaVersion<>(17), new UsesMethod<>(STRING_FORMAT));
return Preconditions.check(check, new JavaVisitor<ExecutionContext>() {
@Override
public J visitMethodInvocation(J.MethodInvocation methodInvocation, ExecutionContext ctx) {
methodInvocation = (J.MethodInvocation) super.visitMethodInvocation(methodInvocation, ctx);
if (!STRING_FORMAT.matches(methodInvocation) || methodInvocation.getMethodType() == null) {
return methodInvocation;
}

maybeRemoveImport("java.lang.String.format");
J.MethodInvocation mi = methodInvocation.withName(methodInvocation.getName().withSimpleName("formatted"));
mi = mi.withMethodType(methodInvocation.getMethodType().getDeclaringType().getMethods().stream()
.filter(it -> it.getName().equals("formatted"))
.findAny()
.orElse(null));
if (mi.getName().getType() != null) {
mi = mi.withName(mi.getName().withType(mi.getMethodType()));
}
List<Expression> arguments = methodInvocation.getArguments();
mi = mi.withSelect(wrapperNotNeeded(arguments.get(0)) ? arguments.get(0).withPrefix(Space.EMPTY) :
new J.Parentheses<>(randomId(), Space.EMPTY, Markers.EMPTY,
JRightPadded.build(arguments.get(0))));
mi = mi.withArguments(arguments.subList(1, arguments.size()));
if (mi.getArguments().isEmpty()) {
// To store spaces between the parenthesis of a method invocation argument list
// Ensures formatting recipes chained together with this one will still work as expected
mi = mi.withArguments(singletonList(new J.Empty(randomId(), Space.EMPTY, Markers.EMPTY)));
}
return maybeAutoFormat(methodInvocation, mi, ctx);
}
// No change when change might be controversial, such as string concatenation
List<Expression> arguments = methodInvocation.getArguments();
boolean wrapperNeeded = wrapperNeeded(arguments.get(0));
if (Boolean.FALSE.equals(addParentheses) && wrapperNeeded) {
return methodInvocation;
}

private static boolean wrapperNotNeeded(Expression expression) {
return expression instanceof J.Identifier ||
expression instanceof J.Literal ||
expression instanceof J.MethodInvocation ||
expression instanceof J.FieldAccess;
}
}
maybeRemoveImport("java.lang.String.format");
J.MethodInvocation mi = methodInvocation.withName(methodInvocation.getName().withSimpleName("formatted"));
mi = mi.withMethodType(methodInvocation.getMethodType().getDeclaringType().getMethods().stream()
.filter(it -> it.getName().equals("formatted"))
.findAny()
.orElse(null));
if (mi.getName().getType() != null) {
mi = mi.withName(mi.getName().withType(mi.getMethodType()));
}
mi = mi.withSelect(wrapperNeeded ?
new J.Parentheses<>(randomId(), Space.EMPTY, Markers.EMPTY,
JRightPadded.build(arguments.get(0))) :
arguments.get(0).withPrefix(Space.EMPTY));
mi = mi.withArguments(arguments.subList(1, arguments.size()));
if (mi.getArguments().isEmpty()) {
// To store spaces between the parenthesis of a method invocation argument list
// Ensures formatting recipes chained together with this one will still work as expected
mi = mi.withArguments(singletonList(new J.Empty(randomId(), Space.EMPTY, Markers.EMPTY)));
}
return maybeAutoFormat(methodInvocation, mi, ctx);
}

@Override
public Duration getEstimatedEffortPerOccurrence() {
return Duration.ofMinutes(1);
private boolean wrapperNeeded(Expression expression) {
return !(expression instanceof J.Identifier ||
expression instanceof J.Literal ||
expression instanceof J.MethodInvocation ||
expression instanceof J.FieldAccess);
}
});
}
}
3 changes: 2 additions & 1 deletion src/main/resources/META-INF/rewrite/java-version-17.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,15 @@ tags:
recipeList:
- org.openrewrite.java.migrate.Java8toJava11
- org.openrewrite.java.migrate.UpgradeBuildToJava17
- org.openrewrite.java.migrate.lang.StringFormatted
- org.openrewrite.staticanalysis.InstanceOfPatternMatch
- org.openrewrite.staticanalysis.AddSerialAnnotationToSerialVersionUID
- org.openrewrite.java.migrate.RemovedRuntimeTraceMethods
- org.openrewrite.java.migrate.RemovedToolProviderConstructor
- org.openrewrite.java.migrate.RemovedModifierAndConstantBootstrapsConstructors
- org.openrewrite.java.migrate.lang.UseTextBlocks:
convertStringsWithoutNewlines: false
- org.openrewrite.java.migrate.lang.StringFormatted:
addParentheses: false
- org.openrewrite.java.migrate.DeprecatedJavaxSecurityCert
- org.openrewrite.java.migrate.DeprecatedLogRecordThreadID
- org.openrewrite.java.migrate.RemovedLegacySunJSSEProviderName
Expand Down
38 changes: 31 additions & 7 deletions src/test/java/org/openrewrite/java/migrate/lang/StringFormattedTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
class StringFormattedTest implements RewriteTest {
@Override
public void defaults(RecipeSpec spec) {
spec.recipe(new StringFormatted());
spec.recipe(new StringFormatted(null));
}

@Test
Expand Down Expand Up @@ -72,12 +72,36 @@ void concatenatedText() {
class A {
String str = String.format("foo"
+ "%s", "a");
}""", """
}
""",
"""
package com.example.app;
class A {
String str = ("foo"
+ "%s").formatted("a");
}"""
}
"""
),
17
)
);
}

@Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/616")
@Test
void concatenatedFormatStringNotConvertedIfIndicated() {
//language=java
rewriteRun(
spec -> spec.recipe(new StringFormatted(false)),
version(
java(
"""
package com.example.app;
class A {
String str = String.format("foo"
+ "%s", "a");
}
"""
),
17
)
Expand All @@ -92,21 +116,21 @@ void callingFunction() {
java(
"""
package com.example.app;

class A {
String str = String.format(getTemplateString(), "a");

private String getTemplateString() {
return "foo %s";
}
}
""",
"""
package com.example.app;

class A {
String str = getTemplateString().formatted("a");

private String getTemplateString() {
return "foo %s";
}
Expand Down
Loading