Skip to content

Do not add explicit Record class import if using var keyword #781

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

Merged
timtebeek merged 4 commits into from
Jul 3, 2025
Merged

Do not add explicit Record class import if using var keyword #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd9a761
Do not add explicit `Record` class import if using `var` keyword
timtebeek Jul 3, 2025
e270cd3
Show new now problematic case
timtebeek Jul 3, 2025
60777d6
Switch to using `FindTypes.findAssignable`
timtebeek Jul 3, 2025
2dc5659
No need for marker
timtebeek Jul 3, 2025
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
15 changes: 8 additions & 7 deletions src/main/java/org/openrewrite/java/migrate/lang/ExplicitRecordImport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.search.FindTypes;
import org.openrewrite.java.search.UsesType;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaSourceFile;
import org.openrewrite.java.tree.JavaType;
import org.openrewrite.java.tree.*;

public class ExplicitRecordImport extends Recipe {
@Override
Expand All @@ -45,10 +44,12 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
public J.CompilationUnit visitCompilationUnit(J.CompilationUnit cu, ExecutionContext ctx) {
JavaSourceFile javaSourceFile = getCursor().firstEnclosing(JavaSourceFile.class);
if (javaSourceFile != null) {
for (JavaType type : cu.getTypesInUse().getTypesInUse()) {
if (type instanceof JavaType.FullyQualified) {
JavaType.FullyQualified ref = (JavaType.FullyQualified) type;
if ("Record".equals(ref.getClassName()) && !ref.getPackageName().startsWith("java.lang")) {
for (NameTree nameTree : FindTypes.findAssignable(cu, "*..Record")) {
if (nameTree.getType() instanceof JavaType.FullyQualified) {
JavaType.FullyQualified ref = (JavaType.FullyQualified) nameTree.getType();
if ("Record".equals(ref.getClassName()) &&
!ref.getPackageName().startsWith("java.lang") &&
!nameTree.getMarkers().findFirst(JavaVarKeyword.class).isPresent()) {
maybeAddImport(ref.getFullyQualifiedName());
}
}
Expand Down
93 changes: 79 additions & 14 deletions src/test/java/org/openrewrite/java/migrate/lang/ExplicitRecordImportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/
package org.openrewrite.java.migrate.lang;

import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.openrewrite.DocumentExample;
import org.openrewrite.Issue;
Expand All @@ -32,12 +31,19 @@ public void defaults(RecipeSpec spec) {
spec.recipe(new ExplicitRecordImport())
//language=java
.parser(JavaParser.fromJavaVersion().dependsOn("""
package com.acme.music;
public class Record {
String name;
}
"""
)
package com.acme.music;
public class Record {
public String name;
}
""",
"""
package com.acme.music;
import java.util.List;
public class RecordList {
public List<Record> records;
}
"""
)
);
}

Expand All @@ -51,7 +57,7 @@ void addImportFromSamePackage() {
"""
package com.acme.music;

public class Test {
class Test {
Record record;
}
""",
Expand All @@ -60,27 +66,86 @@ public class Test {

import com.acme.music.Record;

public class Test {
class Test {
Record record;
}
"""
)
);
}

@Test
void noChangeIfUsingVar() {
rewriteRun(
//language=java
java(
"""
package com.acme.music;

import com.acme.music.RecordList;

class Test {
void test() {
for (var record : new RecordList().records) {
}
}
}
"""
)
);
}

@Test
@Disabled("Not handled yet; deemed unlikely")
void noChangeIfAlreadyFullyQualified() {
void genericUseOfRecordClass() {
rewriteRun(
//language=java
java(
"""
package com.acme.music;

public class Test {
import java.util.List;

class Test {
List<Record> records;
}
""",
"""
package com.acme.music;

import com.acme.music.Record;

import java.util.List;

class Test {
List<Record> records;
}
"""
)
);
}


@Test
void documentChangeWhenFullyQualified() {
rewriteRun(
//language=java
java(
"""
package com.acme.music;

class Test {
com.acme.music.Record record;
}
""",
// Perhaps undesired, but also unlikely, so not worth changing
"""
package com.acme.music;

import com.acme.music.Record;

class Test {
Record record;
}
"""
)
);
Expand All @@ -97,7 +162,7 @@ void noChangeIfAlreadyImported() {

import com.acme.music.Record;

public class Test {
class Test {
Record record;
}
"""
Expand All @@ -113,7 +178,7 @@ void noImportAddedForJavaLangRecord() {
"""
package foo.bar;

public class Test {
class Test {
Record record;
}
"""
Expand Down