refactor: Rename parameter for methods to be more cohesive (#806)

fabapp2 · web-flow · commit 0457ef5e795c · 2023-06-16T09:33:05.000+02:00
diff --git a/components/sbm-core/src/main/java/org/springframework/sbm/java/api/ProjectJavaSources.java b/components/sbm-core/src/main/java/org/springframework/sbm/java/api/ProjectJavaSources.java
@@ -36,7 +36,7 @@ public interface ProjectJavaSources {
 
     List<RewriteSourceFileHolder<J.CompilationUnit>> find(Recipe find);
 
-    void replaceType(String annotation, String withAnnotation);
+    void replaceType(String existingType, String withType);
 
     /**
      * Tries to match regex against imports of all Java sources.
@@ -54,5 +54,5 @@ public interface ProjectJavaSources {
 
     List<JavaSourceAndType> findTypesImplementing(String interfaceType);
 
-    List<? extends JavaSource> findClassesUsingType(String databaseDriverGAE);
+    List<? extends JavaSource> findClassesUsingType(String type);
 }
diff --git a/components/sbm-core/src/main/java/org/springframework/sbm/java/impl/ProjectJavaSourcesImpl.java b/components/sbm-core/src/main/java/org/springframework/sbm/java/impl/ProjectJavaSourcesImpl.java
@@ -77,8 +77,8 @@ public List<RewriteSourceFileHolder<J.CompilationUnit>> find(Recipe findCompilat
     }
 
     @Override
-    public void replaceType(String annotation, String withAnnotation) {
-        ChangeType visitor = new ChangeType(annotation, withAnnotation, false);
+    public void replaceType(String existingType, String withType) {
+        ChangeType visitor = new ChangeType(existingType, withType, false);
         globalRefactoring.refactor(visitor);
     }
 
@@ -131,8 +131,8 @@ public List<JavaSourceAndType> findTypesImplementing(String type) {
     }
 
     @Override
-    public List<? extends JavaSource> findClassesUsingType(String fqName) {
-        UsesType<ExecutionContext> usesType = new UsesType<>(fqName);
+    public List<? extends JavaSource> findClassesUsingType(String type) {
+        UsesType<ExecutionContext> usesType = new UsesType<>(type);
         GenericOpenRewriteRecipe<UsesType<ExecutionContext>> recipe = new GenericOpenRewriteRecipe<>(() -> usesType);
         return find(recipe).stream()
                 .filter(RewriteSourceFileHolder.class::isInstance)
diff --git a/components/sbm-core/src/main/java/org/springframework/sbm/java/migration/actions/ReplaceTypeAction.java b/components/sbm-core/src/main/java/org/springframework/sbm/java/migration/actions/ReplaceTypeAction.java
@@ -28,13 +28,13 @@
 @NoArgsConstructor
 public class ReplaceTypeAction extends AbstractAction {
 
-    private String annotation;
+    private String existingType;
 
-    private String withAnnotation;
+    private String withType;
 
     @Override
     public void apply(ProjectContext context) {
-        context.getProjectJavaSources().replaceType(annotation, withAnnotation);
+        context.getProjectJavaSources().replaceType(existingType, withType);
     }
 }
 
diff --git a/components/sbm-core/src/test/java/org/springframework/sbm/java/migration/actions/ReplaceTypeActionTest.java b/components/sbm-core/src/test/java/org/springframework/sbm/java/migration/actions/ReplaceTypeActionTest.java
@@ -41,8 +41,8 @@ void test() {
         String annotation = "annotationToBeReplaced";
         String withAnnotation = "annotationReplacing";
         ReplaceTypeAction sut = new ReplaceTypeAction();
-        sut.setAnnotation(annotation);
-        sut.setWithAnnotation(withAnnotation);
+        sut.setExistingType(annotation);
+        sut.setWithType(withAnnotation);
 
         Mockito.when(projectContext.getProjectJavaSources()).thenReturn(projectJavaSources);
 
@@ -75,8 +75,8 @@ void replaceTypeOfMethodParameter() {
                 "}";
 
         ReplaceTypeAction sut = new ReplaceTypeAction();
-        sut.setAnnotation("javax.ws.rs.PathParam");
-        sut.setWithAnnotation("org.springframework.web.bind.annotation.PathVariable");
+        sut.setExistingType("javax.ws.rs.PathParam");
+        sut.setWithType("org.springframework.web.bind.annotation.PathVariable");
 
         ProjectContext projectContext = TestProjectContext.buildProjectContext()
                 .withJavaSources(given)
diff --git a/components/sbm-recipes-jee-to-boot/src/main/java/org/springframework/sbm/jee/jaxrs/MigrateJaxRsRecipe.java b/components/sbm-recipes-jee-to-boot/src/main/java/org/springframework/sbm/jee/jaxrs/MigrateJaxRsRecipe.java
@@ -79,22 +79,22 @@ public Recipe jaxRs(RewriteRecipeLoader rewriteRecipeLoader, RewriteRecipeRunner
                                 ReplaceTypeAction.builder()
                                         .condition(HasAnnotation.builder().annotation("javax.ws.rs.PathParam").build())
                                         .description("Replace JAX-RS @PathParam with Spring Boot @PathVariable annotation.")
-                                        .annotation("javax.ws.rs.PathParam")
-                                        .withAnnotation("org.springframework.web.bind.annotation.PathVariable")
+                                        .existingType("javax.ws.rs.PathParam")
+                                        .withType("org.springframework.web.bind.annotation.PathVariable")
                                         .build(),
 
                                 ReplaceTypeAction.builder()
                                         .condition(HasAnnotation.builder().annotation("javax.ws.rs.QueryParam").build())
                                         .description("Replace JAX-RS @QueryParam with Spring Boot @RequestParam annotation.")
-                                        .annotation("javax.ws.rs.QueryParam")
-                                        .withAnnotation("org.springframework.web.bind.annotation.RequestParam")
+                                        .existingType("javax.ws.rs.QueryParam")
+                                        .withType("org.springframework.web.bind.annotation.RequestParam")
                                         .build(),
 
                                 ReplaceTypeAction.builder()
                                         .condition(HasAnnotation.builder().annotation("javax.ws.rs.FormParam").build())
                                         .description("Replace JAX-RS @FormParam with Spring Boot @RequestParam annotation.")
-                                        .annotation("javax.ws.rs.QueryParam")
-                                        .withAnnotation("org.springframework.web.bind.annotation.RequestParam")
+                                        .existingType("javax.ws.rs.QueryParam")
+                                        .withType("org.springframework.web.bind.annotation.RequestParam")
                                         .build(),
 
                                 JavaRecipeAction.builder()
diff --git a/components/sbm-recipes-jee-to-boot/src/main/resources/recipes/migrate-stateless-ejb.yaml b/components/sbm-recipes-jee-to-boot/src/main/resources/recipes/migrate-stateless-ejb.yaml
@@ -8,24 +8,24 @@
 
   actions:
     - type: org.springframework.sbm.jee.ejb.actions.MigrateEjbAnnotations
+      description: "Replace @EJB injection with Spring Boot @Autowired."
       condition:
         type: org.springframework.sbm.java.migration.conditions.HasAnnotation
         annotation: "javax.ejb.EJB"
-      description: "Replace @EJB injection with Spring Boot @Autowired."
 
 
     - type: org.springframework.sbm.java.migration.actions.ReplaceTypeAction
-      annotation: "javax.inject.Inject"
-      withAnnotation: "org.springframework.beans.factory.annotation.Autowired"
+      description: "Replace CDI field injection with Spring Boot field injection."
+      existingType: "javax.inject.Inject"
+      withType: "org.springframework.beans.factory.annotation.Autowired"
       condition:
         type: org.springframework.sbm.java.migration.conditions.HasMemberAnnotation
         annotation: "javax.inject.Inject"
-      description: "Replace CDI field injection with Spring Boot field injection."
 
 
     - type: org.springframework.sbm.java.migration.actions.ReplaceTypeAction
-      annotation: "javax.ejb.Startup"
-      withAnnotation: "org.springframework.stereotype.Service"
+      existingType: "javax.ejb.Startup"
+      withType: "org.springframework.stereotype.Service"
       condition:
         type: org.springframework.sbm.java.migration.conditions.HasTypeAnnotation
         annotation: "javax.ejb.Startup"
diff --git a/components/sbm-recipes-jee-to-boot/src/test/java/org/springframework/sbm/jee/ejb/recipes/MigrateStatelessEjbRecipeTest.java b/components/sbm-recipes-jee-to-boot/src/test/java/org/springframework/sbm/jee/ejb/recipes/MigrateStatelessEjbRecipeTest.java
@@ -67,14 +67,14 @@ void migrateStatelessEjbRecipe() {
             assertThatActionHasCondition(replaceTypeActions.get(0), HasMemberAnnotation.class);
             HasMemberAnnotation condition2 = getConditionFor(replaceTypeActions.get(0), HasMemberAnnotation.class);
             assertThat(condition2.getAnnotation()).isEqualTo("javax.inject.Inject");
-            assertThat(replaceTypeActions.get(0).getAnnotation()).isEqualTo("javax.inject.Inject");
-            assertThat(replaceTypeActions.get(0).getWithAnnotation()).isEqualTo("org.springframework.beans.factory.annotation.Autowired");
+            assertThat(replaceTypeActions.get(0).getExistingType()).isEqualTo("javax.inject.Inject");
+            assertThat(replaceTypeActions.get(0).getWithType()).isEqualTo("org.springframework.beans.factory.annotation.Autowired");
 
             assertThatActionHasCondition(replaceTypeActions.get(1), HasTypeAnnotation.class);
             HasTypeAnnotation condition4 = getConditionFor(replaceTypeActions.get(1), HasTypeAnnotation.class);
             assertThat(condition4.getAnnotation()).isEqualTo("javax.ejb.Startup");
-            assertThat(replaceTypeActions.get(1).getAnnotation()).isEqualTo("javax.ejb.Startup");
-            assertThat(replaceTypeActions.get(1).getWithAnnotation()).isEqualTo("org.springframework.stereotype.Service");
+            assertThat(replaceTypeActions.get(1).getExistingType()).isEqualTo("javax.ejb.Startup");
+            assertThat(replaceTypeActions.get(1).getWithType()).isEqualTo("org.springframework.stereotype.Service");
 
             MigrateLocalStatelessSessionBeans migrateLocalStatelessSessionBeans = getAction(recipe, MigrateLocalStatelessSessionBeans.class);
             assertThatActionHasCondition(migrateLocalStatelessSessionBeans, HasTypeAnnotation.class);

Original file line number	Diff line number	Diff line change
`@@ -77,8 +77,8 @@ public List<RewriteSourceFileHolder<J.CompilationUnit>> find(Recipe findCompilat`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`@Override`
`80`		`- public void replaceType(String annotation, String withAnnotation) {`
`81`		`- ChangeType visitor = new ChangeType(annotation, withAnnotation, false);`
	`80`	`+ public void replaceType(String existingType, String withType) {`
	`81`	`+ ChangeType visitor = new ChangeType(existingType, withType, false);`
`82`	`82`	`globalRefactoring.refactor(visitor);`
`83`	`83`	`}`
`84`	`84`
`@@ -131,8 +131,8 @@ public List<JavaSourceAndType> findTypesImplementing(String type) {`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`@Override`
`134`		`- public List<? extends JavaSource> findClassesUsingType(String fqName) {`
`135`		`- UsesType<ExecutionContext> usesType = new UsesType<>(fqName);`
	`134`	`+ public List<? extends JavaSource> findClassesUsingType(String type) {`
	`135`	`+ UsesType<ExecutionContext> usesType = new UsesType<>(type);`
`136`	`136`	`GenericOpenRewriteRecipe<UsesType<ExecutionContext>> recipe = new GenericOpenRewriteRecipe<>(() -> usesType);`
`137`	`137`	`return find(recipe).stream()`
`138`	`138`	`.filter(RewriteSourceFileHolder.class::isInstance)`
Original file line number	Diff line number	Diff line change
`@@ -28,13 +28,13 @@`
`28`	`28`	`@NoArgsConstructor`
`29`	`29`	`public class ReplaceTypeAction extends AbstractAction {`
`30`	`30`
`31`		`- private String annotation;`
	`31`	`+ private String existingType;`
`32`	`32`
`33`		`- private String withAnnotation;`
	`33`	`+ private String withType;`
`34`	`34`
`35`	`35`	`@Override`
`36`	`36`	`public void apply(ProjectContext context) {`
`37`		`- context.getProjectJavaSources().replaceType(annotation, withAnnotation);`
	`37`	`+ context.getProjectJavaSources().replaceType(existingType, withType);`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`