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

Jump to bottom

Add new migration case of WebMvcConfigurer #616

Merged
merged 4 commits into from
Nov 5, 2024
+95 −32
Merged

Add new migration case of WebMvcConfigurer #616

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
8d778b6
Add new migration case of WebMvcConfigurer
SiBorea Nov 5, 2024
d710aa6
Minor polish to reduce diff
timtebeek Nov 5, 2024
08f4dd1
Take out the ParameterizedType handling for now
timtebeek Nov 5, 2024
75a0ae7
Update src/main/java/org/openrewrite/java/spring/framework/MigrateWeb…
timtebeek Nov 5, 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
63 changes: 57 additions & 6 deletions src/main/java/org/openrewrite/java/spring/framework/MigrateWebMvcConfigurerAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@
import org.openrewrite.java.search.UsesType;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType;
import org.openrewrite.java.tree.TypeTree;
import org.openrewrite.java.tree.TypeUtils;
timtebeek marked this conversation as resolved.
Show resolved Hide resolved

public class MigrateWebMvcConfigurerAdapter extends Recipe {
private static final String WEB_MVC_CONFIGURER_ADAPTER = "org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter";
private static final String WEB_MVC_CONFIGURER = "org.springframework.web.servlet.config.annotation.WebMvcConfigurer";

@Override
public String getDisplayName() {
return "Replace `WebMvcConfigurerAdapter` with `WebMvcConfigurer`";
Expand All @@ -43,11 +47,13 @@ public String getDescription() {

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return Preconditions.check(new UsesType<>("org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter", false), new JavaIsoVisitor<ExecutionContext>() {
return Preconditions.check(new UsesType<>(WEB_MVC_CONFIGURER_ADAPTER, false), new JavaIsoVisitor<ExecutionContext>() {
private final JavaType WEB_MVC_CONFIGURER_TYPE = JavaType.buildType(WEB_MVC_CONFIGURER);

@Override
public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, ExecutionContext ctx) {
J.ClassDeclaration cd = super.visitClassDeclaration(classDecl, ctx);
if (cd.getExtends() != null && TypeUtils.isOfClassType(cd.getExtends().getType(), "org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter")) {
if (cd.getExtends() != null && TypeUtils.isOfClassType(cd.getExtends().getType(), WEB_MVC_CONFIGURER_ADAPTER)) {
cd = cd.withExtends(null);
updateCursor(cd);
// This is an interesting one... WebMvcConfigurerAdapter implements WebMvcConfigurer
Expand All @@ -59,18 +65,63 @@ public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, Ex
}
cd = JavaTemplate.builder("WebMvcConfigurer")
.contextSensitive()
.imports("org.springframework.web.servlet.config.annotation.WebMvcConfigurer")
.imports(WEB_MVC_CONFIGURER)
.javaParser(JavaParser.fromJavaVersion()
.classpathFromResources(ctx, "spring-webmvc-5.*"))
.classpathFromResources(ctx, "spring-webmvc-5"))
.build().apply(getCursor(), cd.getCoordinates().addImplementsClause());
updateCursor(cd);
cd = (J.ClassDeclaration) new RemoveSuperStatementVisitor().visitNonNull(cd, ctx, getCursor().getParentOrThrow());
maybeRemoveImport("org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter");
maybeAddImport("org.springframework.web.servlet.config.annotation.WebMvcConfigurer");
maybeRemoveImport(WEB_MVC_CONFIGURER_ADAPTER);
maybeAddImport(WEB_MVC_CONFIGURER);
}
return cd;
}

@Override
public J.NewClass visitNewClass(J.NewClass newClass, ExecutionContext ctx) {
if (newClass.getClazz() != null && TypeUtils.isOfClassType(newClass.getClazz().getType(), WEB_MVC_CONFIGURER_ADAPTER)) {
if (newClass.getClazz() instanceof J.Identifier) {
J.Identifier identifier = (J.Identifier) newClass.getClazz();
newClass = newClass.withClazz(identifier
.withType(WEB_MVC_CONFIGURER_TYPE)
.withSimpleName(((JavaType.ShallowClass) WEB_MVC_CONFIGURER_TYPE).getClassName())
);
} else if (newClass.getClazz() instanceof J.ParameterizedType) {
J.ParameterizedType parameterizedType = (J.ParameterizedType) newClass.getClazz();
newClass = newClass.withClazz(parameterizedType
.withType(WEB_MVC_CONFIGURER_TYPE)
.withClazz(TypeTree.build(WEB_MVC_CONFIGURER).withType(WEB_MVC_CONFIGURER_TYPE))
);
timtebeek marked this conversation as resolved.
Show resolved Hide resolved
}
maybeRemoveImport(WEB_MVC_CONFIGURER_ADAPTER);
maybeAddImport(WEB_MVC_CONFIGURER);
}
return super.visitNewClass(newClass, ctx);
}

@Override
public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration md, ExecutionContext ctx) {
if (md.getMethodType() != null && TypeUtils.isOfClassType(md.getType(), WEB_MVC_CONFIGURER_ADAPTER)) {
if (md.getReturnTypeExpression() instanceof J.Identifier) {
J.Identifier identifier = (J.Identifier) md.getReturnTypeExpression();
md = md.withReturnTypeExpression(identifier
.withType(WEB_MVC_CONFIGURER_TYPE)
.withSimpleName(((JavaType.ShallowClass) WEB_MVC_CONFIGURER_TYPE).getClassName())
);
} else if (md.getReturnTypeExpression() instanceof J.ParameterizedType) {
J.ParameterizedType parameterizedType = (J.ParameterizedType) md.getReturnTypeExpression();
md = md.withReturnTypeExpression(parameterizedType
.withType(WEB_MVC_CONFIGURER_TYPE)
.withClazz(TypeTree.build(WEB_MVC_CONFIGURER).withType(WEB_MVC_CONFIGURER_TYPE))
);
timtebeek marked this conversation as resolved.
Show resolved Hide resolved
}

maybeRemoveImport(WEB_MVC_CONFIGURER_ADAPTER);
maybeAddImport(WEB_MVC_CONFIGURER);
}
return super.visitMethodDeclaration(md, ctx);
}

class RemoveSuperStatementVisitor extends JavaIsoVisitor<ExecutionContext> {
final MethodMatcher wm = new MethodMatcher("org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter *(..)");

Expand Down
77 changes: 51 additions & 26 deletions ...ot_2_1/java/org/openrewrite/java/spring/framework/MigrateWebMvcConfigurerAdapterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ class MigrateWebMvcConfigurerAdapterTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec.parser(JavaParser.fromJavaVersion()
.classpathFromResources(new InMemoryExecutionContext(), "spring-webmvc-5.*", "spring-core-5.*", "spring-web-5.*"))
spec.parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(),
"spring-webmvc-5", "spring-core-5", "spring-web-5"))
.recipe(new MigrateWebMvcConfigurerAdapter());
}

Expand All @@ -39,30 +39,55 @@ void transformSimple() {
rewriteRun(
//language=java
java(
"""
package a.b.c;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

public class CustomMvcConfigurer extends WebMvcConfigurerAdapter {
private final String someArg;
public CustomMvcConfigurer(String someArg) {
super();
this.someArg = someArg;
}
}
""", """
package a.b.c;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

public class CustomMvcConfigurer implements WebMvcConfigurer {
private final String someArg;
public CustomMvcConfigurer(String someArg) {
this.someArg = someArg;
}
}
""")
"""
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

public class CustomMvcConfigurer extends WebMvcConfigurerAdapter {
private final String someArg;
public CustomMvcConfigurer(String someArg) {
super();
this.someArg = someArg;
}
}
""", """
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

public class CustomMvcConfigurer implements WebMvcConfigurer {
private final String someArg;
public CustomMvcConfigurer(String someArg) {
this.someArg = someArg;
}
}
""")
);
}

@Test
void transformBean() {
// language=java
rewriteRun(
java(
"""
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

class WebConfig {
WebMvcConfigurerAdapter forwardToIndex() {
return new WebMvcConfigurerAdapter() {
};
}
}
""",
"""
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

class WebConfig {
WebMvcConfigurer forwardToIndex() {
return new WebMvcConfigurer() {
};
}
}
"""
)
);
}
}
Loading