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 var migration of variables initialized by static methods #609

Merged
merged 4 commits into from
Nov 20, 2024
Merged

Fix var migration of variables initialized by static methods #609

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cf0ec93
add Test to reproduce issue 608
MBoegers Nov 20, 2024
1ab2cbf
(Hot) Fix issue 608 by disable migration of variables that are initia…
MBoegers Nov 20, 2024
7a97a2d
Minor polish
timtebeek Nov 20, 2024
3a34f3d
Use org.jspecify.annotations.Nullable
timtebeek Nov 20, 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
28 changes: 28 additions & 0 deletions src/main/java/org/openrewrite/java/migrate/lang/var/DeclarationCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
import org.openrewrite.Cursor;
import org.openrewrite.java.tree.*;

import javax.annotation.Nullable;

import static java.util.Objects.requireNonNull;

final class DeclarationCheck {
Expand Down Expand Up @@ -198,4 +200,30 @@ private static boolean isInsideInitializer(Cursor cursor, int nestedBlockLevel)

return isInsideInitializer(requireNonNull(cursor.getParent()), nestedBlockLevel);
}

/**
* Checks whether the initializer {@linkplain Expression} is a {@linkplain J.MethodInvocation} targeting a static method.
*
* @param initializer {@linkplain J.VariableDeclarations.NamedVariable#getInitializer()} value
* @return true iff is initialized by static method
*/
public static boolean initializedByStaticMethod(@Nullable Expression initializer) {
if (initializer == null) {
return false;
}
initializer = initializer.unwrap();

if (!(initializer instanceof J.MethodInvocation)) {
// no MethodInvocation -> false
return false;
}

J.MethodInvocation invocation = (J.MethodInvocation) initializer;
if (invocation.getMethodType() == null) {
// not a static method -> false
return false;
}

return invocation.getMethodType().getFlags().contains(Flag.Static);
}
}
6 changes: 4 additions & 2 deletions src/main/java/org/openrewrite/java/migrate/lang/var/UseVarForObject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,10 @@ public J.VariableDeclarations visitVariableDeclarations(J.VariableDeclarations v
boolean isPrimitive = DeclarationCheck.isPrimitive(vd);
boolean usesGenerics = DeclarationCheck.useGenerics(vd);
boolean usesTernary = DeclarationCheck.initializedByTernary(vd);
boolean usesArrayInitializer = vd.getVariables().get(0).getInitializer() instanceof J.NewArray;
if (isPrimitive || usesGenerics || usesTernary || usesArrayInitializer) {
Expression initializer = vd.getVariables().get(0).getInitializer();
boolean usesArrayInitializer = initializer instanceof J.NewArray;
boolean initializedByStaticMethod = DeclarationCheck.initializedByStaticMethod(initializer);
if (isPrimitive || usesGenerics || usesTernary || usesArrayInitializer || initializedByStaticMethod) {
return vd;
}

Expand Down
103 changes: 73 additions & 30 deletions src/test/java/org/openrewrite/java/migrate/lang/var/UseVarForObjectsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,35 +32,6 @@ public void defaults(RecipeSpec spec) {
.allSources(s -> s.markers(javaVersion(10)));
}

@Test
@Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/550")
void genericType() {
rewriteRun(
java(
"""
import java.io.Serializable;

abstract class Outer<T extends Serializable> {
abstract T doIt();
void trigger() {
T x = doIt();
}
}
""",
"""
import java.io.Serializable;

abstract class Outer<T extends Serializable> {
abstract T doIt();
void trigger() {
var x = doIt();
}
}
"""
)
);
}

@Nested
class Applicable {
@DocumentExample
Expand Down Expand Up @@ -299,6 +270,7 @@ void m() {
}

@Test
@Disabled("in favor to https://github.com/openrewrite/rewrite-migrate-java/issues/608 we skip all static methods ATM")
void staticMethods() {
//language=java
rewriteRun(
Expand Down Expand Up @@ -336,12 +308,83 @@ void m() {
)
);
}

@Test
@Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/550")
void genericType() {
rewriteRun(
java(
"""
import java.io.Serializable;

abstract class Outer<T extends Serializable> {
abstract T doIt();
void trigger() {
T x = doIt();
}
}
""",
"""
import java.io.Serializable;

abstract class Outer<T extends Serializable> {
abstract T doIt();
void trigger() {
var x = doIt();
}
}
"""
)
);
}
}
}

@Nested
class NotApplicable {

@Test
@Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/608")
void genericTypeInStaticMethod() {
// ATM the recipe skips all static method initialized variables
rewriteRun(
java(
"""
package example;

class Global {
static <T> T cast(Object o) {
return (T) o;
}
}
class User {
public String test() {
Object o = "Hello";
String string = Global.cast(o);
return string;
}
}
""",
"""
package example;

class Global {
static <T> T cast(Object o) {
return (T) o;
}
}
class User {
public String test() {
var o = "Hello";
String string = Global.cast(o);
return string;
}
}
"""
)
);
}

@Test
@Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/551")
void arrayInitializer() {
Expand All @@ -350,7 +393,7 @@ void arrayInitializer() {
java(
"""
package com.example.app;

class A {
void m() {
String[] dictionary = {"aa", "b", "aba", "ba"};
Expand Down