Report for M1 removals (closes #162)

fabapp2 · fabapp2 · commit d3206db5d226 · 2022-08-15T16:19:41.000+02:00
- Add common SpringBeanMethodDeclarationFinder
diff --git a/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/actions/Boot_24_25_SpringDataJpaAction.java b/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/actions/Boot_24_25_SpringDataJpaAction.java
@@ -16,6 +16,7 @@
 package org.springframework.sbm.boot.upgrade_24_25.actions;
 
 import org.springframework.sbm.boot.common.finder.MatchingMethod;
+import org.springframework.sbm.boot.common.finder.MethodPatternMatchingMethod;
 import org.springframework.sbm.boot.upgrade_24_25.conditions.Boot_24_25_SpringDataJpaActionCondition;
 import org.springframework.sbm.boot.upgrade_24_25.filter.SpringDataJpaAnalyzer;
 import org.springframework.sbm.build.MultiModuleApplicationNotSupportedException;
@@ -48,19 +49,19 @@ public void apply(ProjectContext context) {
 
     private void applyToModule(ProjectContext context) {
 
-        List<MatchingMethod> jpaRepositoriesWithGetByIdMethod = springDataJpaAnalyzer.getJpaRepositoriesWithGetByIdMethod(context);
+        List<MethodPatternMatchingMethod> jpaRepositoriesWithGetByIdMethod = springDataJpaAnalyzer.getJpaRepositoriesWithGetByIdMethod(context);
         renameGetByIdMethods(jpaRepositoriesWithGetByIdMethod);
 
         List<MethodCall> callsToGetOneMethods = springDataJpaAnalyzer.findCallsToGetOneMethod(context);
         refactorCallsToGetOne(callsToGetOneMethods);
 
     }
 
-    private void renameGetByIdMethods(List<MatchingMethod> jpaRepositoriesWithGetByIdMethod) {
+    private void renameGetByIdMethods(List<MethodPatternMatchingMethod> jpaRepositoriesWithGetByIdMethod) {
         jpaRepositoriesWithGetByIdMethod.forEach(repo -> {
-            String methodPattern = "com.example.springboot24to25example.TaskRepository " + repo.methodPattern();
-            String newMethodName = "get" + repo.method().getReturnValue() + "ById";
-            repo.method().rename(methodPattern, newMethodName);
+            String methodPattern = "com.example.springboot24to25example.TaskRepository " + repo.getMethodPattern();
+            String newMethodName = "get" + repo.getMethod().getReturnValue() + "ById";
+            repo.getMethod().rename(methodPattern, newMethodName);
         });
     }
 
diff --git a/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/conditions/Boot_24_25_SpringDataJpaActionCondition.java b/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/conditions/Boot_24_25_SpringDataJpaActionCondition.java
@@ -16,6 +16,7 @@
 package org.springframework.sbm.boot.upgrade_24_25.conditions;
 
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.sbm.boot.common.finder.MethodPatternMatchingMethod;
 import org.springframework.sbm.boot.upgrade_24_25.filter.SpringDataJpaAnalyzer;
 import org.springframework.sbm.engine.context.ProjectContext;
 import org.springframework.sbm.engine.recipe.Condition;
@@ -38,7 +39,7 @@ public boolean evaluate(ProjectContext context) {
     private boolean evaluateAgainstModule(ProjectContext context) {
         SpringDataJpaAnalyzer springDataJpaAnalyzer = new SpringDataJpaAnalyzer();
         List<MethodCall> callsToGetOneMethod = springDataJpaAnalyzer.findCallsToGetOneMethod(context);
-        List<SpringDataJpaAnalyzer.MatchingMethod> jpaRepositoriesWithGetByIdMethod = springDataJpaAnalyzer.getJpaRepositoriesWithGetByIdMethod(context);
+        List<MethodPatternMatchingMethod> jpaRepositoriesWithGetByIdMethod = springDataJpaAnalyzer.getJpaRepositoriesWithGetByIdMethod(context);
 
         return !(callsToGetOneMethod.isEmpty() || jpaRepositoriesWithGetByIdMethod.isEmpty());
     }
diff --git a/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/filter/SpringDataJpaAnalyzer.java b/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/filter/SpringDataJpaAnalyzer.java
@@ -16,6 +16,7 @@
 package org.springframework.sbm.boot.upgrade_24_25.filter;
 
 import org.springframework.sbm.boot.common.finder.MatchingMethod;
+import org.springframework.sbm.boot.common.finder.MethodPatternMatchingMethod;
 import org.springframework.sbm.java.api.MethodCall;
 import org.springframework.sbm.engine.context.ProjectContext;
 import org.springframework.sbm.java.api.JavaSourceAndType;
@@ -30,18 +31,18 @@ public List<MethodCall> findCallsToGetOneMethod(ProjectContext context) {
         return context.getProjectJavaSources().findMethodCalls("org.springframework.data.jpa.repository.JpaRepository getOne(java.lang.Long)");
     }
 
-    public List<MatchingMethod> getJpaRepositoriesWithGetByIdMethod(ProjectContext context) {
+    public List<MethodPatternMatchingMethod> getJpaRepositoriesWithGetByIdMethod(ProjectContext context) {
         String jpaRepositoryInterface = "org.springframework.data.jpa.repository.JpaRepository";
         List<JavaSourceAndType> jpaRepositories = context.getProjectJavaSources().findTypesImplementing(jpaRepositoryInterface);
         // FIXME: type of PK must be retrieved, moves to rewrite when these migrations are provided as OpenRewrite recipes
         String methodPattern = "getById(java.lang.Long)";
         return findRepositoriesDeclaring(jpaRepositories, methodPattern);
     }
 
-    private List<MatchingMethod> findRepositoriesDeclaring(List<JavaSourceAndType> jpaRepositories, String methodPattern) {
+    private List<MethodPatternMatchingMethod> findRepositoriesDeclaring(List<JavaSourceAndType> jpaRepositories, String methodPattern) {
         return jpaRepositories.stream()
                 .filter(jat -> jat.getType().hasMethod(methodPattern))
-                .map(jat -> new MatchingMethod(jat.getJavaSource(), jat.getType(), jat.getType().getMethod(methodPattern), methodPattern))
+                .map(jat -> new MethodPatternMatchingMethod(jat.getJavaSource(), jat.getType(), jat.getType().getMethod(methodPattern), methodPattern))
                 .collect(Collectors.toList());
     }
 
diff --git a/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/report/Boot_24_25_SpringDataJpa.java b/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_24_25/report/Boot_24_25_SpringDataJpa.java
@@ -18,6 +18,7 @@
 import org.springframework.core.annotation.Order;
 import org.springframework.sbm.boot.UpgradeSectionBuilder;
 import org.springframework.sbm.boot.asciidoctor.*;
+import org.springframework.sbm.boot.common.finder.MethodPatternMatchingMethod;
 import org.springframework.sbm.boot.upgrade_24_25.conditions.Boot_24_25_SpringDataJpaActionCondition;
 import org.springframework.sbm.boot.upgrade_24_25.filter.SpringDataJpaAnalyzer;
 import org.springframework.sbm.java.api.MethodCall;
@@ -47,15 +48,15 @@ public Section build(ProjectContext projectContext) {
 
         SpringDataJpaAnalyzer springDataJpaAnalyzer = new SpringDataJpaAnalyzer();
         List<MethodCall> callsToGetOneMethod = springDataJpaAnalyzer.findCallsToGetOneMethod(projectContext);
-        List<SpringDataJpaAnalyzer.MatchingMethod> jpaRepositoriesWithGetByIdMethod = springDataJpaAnalyzer.getJpaRepositoriesWithGetByIdMethod(projectContext);
+        List<MethodPatternMatchingMethod> jpaRepositoriesWithGetByIdMethod = springDataJpaAnalyzer.getJpaRepositoriesWithGetByIdMethod(projectContext);
 
 
         Table.Builder builder = Table.builder()
                 .headerCols("File", "Description", "Proposed change");
 
 
         jpaRepositoriesWithGetByIdMethod.forEach(m -> {
-            Path relativePath = Path.of(".").toAbsolutePath().relativize(m.getJat().getJavaSource().getResource().getAbsolutePath());
+            Path relativePath = Path.of(".").toAbsolutePath().relativize(m.getJavaSource().getResource().getAbsolutePath());
             String description = String.format("defines `%s` returning `%s`", m.getMethodPattern(), m.getMethod().getReturnValue());
             String fix = String.format("Rename method to `get%sById()`", m.getMethod().getReturnValue());
             builder.row(relativePath.toString(), description, fix);
@@ -90,7 +91,7 @@ public Section build(ProjectContext projectContext) {
                                 // FIXME: Create TODOs for all findings
                                 .todo(
                                         TodoList.Todo.builder()
-                                                .text("rename `" + jpaRepositoriesWithGetByIdMethod.get(0).getJat().getJavaSource().getTypes().get(0).getFullyQualifiedName() + "." + jpaRepositoriesWithGetByIdMethod.get(0).getMethodPattern() + "` to " + String.format("`get%sById()`", jpaRepositoriesWithGetByIdMethod.get(0).getMethod().getReturnValue()))
+                                                .text("rename `" + jpaRepositoriesWithGetByIdMethod.get(0).getJavaSource().getTypes().get(0).getFullyQualifiedName() + "." + jpaRepositoriesWithGetByIdMethod.get(0).getMethodPattern() + "` to " + String.format("`get%sById()`", jpaRepositoriesWithGetByIdMethod.get(0).getMethod().getReturnValue()))
                                                 .build()
                                 )
                                 .recipeName("boot-2.4-2.5-spring-data-jpa")
diff --git a/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/checks/CommonsMultipartResolverSectionBuilder.java b/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/checks/CommonsMultipartResolverSectionBuilder.java
@@ -43,7 +43,7 @@ public Section build(ProjectContext projectContext) {
         List<MatchingMethod> matchingMethods = finder.findMatches(projectContext);
         return ChangeSection.RelevantChangeSection.builder()
                 .title("`CommonsMultipartResolver` support has been removed")
-                .paragraph("Support for Spring Framework’s CommonsMultipartResolver has been removed following its removal in Spring Framework 6")
+                .paragraph("Support for Spring Framework’s `CommonsMultipartResolver` has been removed following its removal in Spring Framework 6")
                 .relevanceSection()
                 .paragraph("The scan found bean declarations of type `CommonsMultipartResolver`")
                 .todoSection()
diff --git a/components/sbm-recipes-boot-upgrade/src/test/java/org/springframework/sbm/boot/upgrade_24_25/filter/SpringDataJpaAnalyzerTest.java b/components/sbm-recipes-boot-upgrade/src/test/java/org/springframework/sbm/boot/upgrade_24_25/filter/SpringDataJpaAnalyzerTest.java
@@ -17,6 +17,7 @@
 
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
+import org.springframework.sbm.boot.common.finder.MethodPatternMatchingMethod;
 import org.springframework.sbm.engine.context.ProjectContext;
 import org.springframework.sbm.java.api.MethodCall;
 import org.springframework.sbm.java.api.ProjectJavaSources;
@@ -121,7 +122,7 @@ void testGetJpaRepositoriesWithGetByIdMethod() {
                 .build();
 
         SpringDataJpaAnalyzer sut = new SpringDataJpaAnalyzer();
-        List<SpringDataJpaAnalyzer.MatchingMethod> match = sut.getJpaRepositoriesWithGetByIdMethod(context);
+        List<MethodPatternMatchingMethod> match = sut.getJpaRepositoriesWithGetByIdMethod(context);
         assertThat(match).hasSize(1);
     }
 }
diff --git a/components/sbm-support-boot/src/main/java/org/springframework/sbm/boot/common/finder/MatchingMethod.java b/components/sbm-support-boot/src/main/java/org/springframework/sbm/boot/common/finder/MatchingMethod.java
@@ -16,8 +16,16 @@
 
 package org.springframework.sbm.boot.common.finder;
 
+import lombok.Data;
 import org.springframework.sbm.java.api.JavaSource;
 import org.springframework.sbm.java.api.Method;
 import org.springframework.sbm.java.api.Type;
 
-public record MatchingMethod(JavaSource javaSource, Type type, Method method, String methodPattern) { }
+@Data
+public class MatchingMethod {
+
+    private final JavaSource javaSource;
+    private final Type type;
+    private final Method method;
+
+}
diff --git a/components/sbm-support-boot/src/main/java/org/springframework/sbm/boot/common/finder/MethodPatternMatchingMethod.java b/components/sbm-support-boot/src/main/java/org/springframework/sbm/boot/common/finder/MethodPatternMatchingMethod.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.sbm.boot.common.finder;
+
+import lombok.Data;
+import lombok.Getter;
+import org.springframework.sbm.java.api.JavaSource;
+import org.springframework.sbm.java.api.Method;
+import org.springframework.sbm.java.api.Type;
+
+public class MethodPatternMatchingMethod extends MatchingMethod {
+
+    @Getter
+    private final String methodPattern;
+
+    public MethodPatternMatchingMethod(JavaSource javaSource, Type type, Method method, String methodPattern) {
+        super(javaSource, type, method);
+        this.methodPattern = methodPattern;
+    }
+
+}
diff --git a/components/sbm-support-boot/src/main/java/org/springframework/sbm/boot/common/finder/SpringBeanMethodDeclarationFinder.java b/components/sbm-support-boot/src/main/java/org/springframework/sbm/boot/common/finder/SpringBeanMethodDeclarationFinder.java
@@ -35,6 +35,7 @@ public class SpringBeanMethodDeclarationFinder implements ProjectResourceFinder<
 
     @Override
     public List<MatchingMethod> apply(ProjectResourceSet projectResourceSet) {
+
         List<MatchingMethod> matches = new ArrayList<>();
 
         new JavaSourceListFilter()
@@ -54,7 +55,7 @@ public List<MatchingMethod> apply(ProjectResourceSet projectResourceSet) {
                                     .getMethods()
                                     .stream()
                                     .filter(m -> m.getReturnValue().equals(returnValueFqName))
-                                    .forEach(m -> matches.add(new MatchingMethod(js, t, m, methodPattern))));
+                                    .forEach(m -> matches.add(new MatchingMethod(js, t, m))));
                 });
         return matches;
     }
diff --git a/components/sbm-support-boot/src/test/java/org/springframework/sbm/boot/common/finder/SpringBeanMethodDeclarationFinderTest.java b/components/sbm-support-boot/src/test/java/org/springframework/sbm/boot/common/finder/SpringBeanMethodDeclarationFinderTest.java
@@ -82,10 +82,10 @@ public class SomeBean {}
         void shouldReturnTheMatchingBeanDeclaration() {
             List<MatchingMethod> matches = builder.build().search(sut);
             assertThat(matches).hasSize(1);
-            assertThat(matches.get(0).javaSource().getSourcePath().toString()).isEqualTo("src/main/java/MyConfiguration.java");
-            assertThat(matches.get(0).type().getFullyQualifiedName()).isEqualTo("MyConfiguration");
-            assertThat(matches.get(0).method().getReturnValue()).isEqualTo("a.b.c.SomeBean");
-            assertThat(matches.get(0).method().getName()).isEqualTo("someBean");
+            assertThat(matches.get(0).getJavaSource().getSourcePath().toString()).isEqualTo("src/main/java/MyConfiguration.java");
+            assertThat(matches.get(0).getType().getFullyQualifiedName()).isEqualTo("MyConfiguration");
+            assertThat(matches.get(0).getMethod().getReturnValue()).isEqualTo("a.b.c.SomeBean");
+            assertThat(matches.get(0).getMethod().getName()).isEqualTo("someBean");
         }
     }
 
@@ -99,6 +99,7 @@ void beforeEach() {
                                   import org.springframework.context.annotation.Configuration;
                                   import org.springframework.context.annotation.Bean;
                                   import a.b.c.SomeBean;
+                                  import a.b.c.AnotherBean;
                                   
                                   @Configuration
                                   public class MyConfiguration {
@@ -118,6 +119,7 @@ AnotherBean anotherBean() {
                                    import org.springframework.context.annotation.Configuration;
                                    import org.springframework.context.annotation.Bean;
                                    import a.b.c.SomeBean;
+                                   import a.b.c.AnotherBean;
                                    
                                    @Configuration
                                    public class MyConfiguration2 {
@@ -150,14 +152,14 @@ public class AnotherBean {}
         void shouldReturnTheMatchingBeanDeclarations() {
             List<MatchingMethod> matches = builder.build().search(sut);
             assertThat(matches).hasSize(2);
-            assertThat(matches.get(0).javaSource().getSourcePath().toString()).isEqualTo("src/main/java/MyConfiguration.java");
-            assertThat(matches.get(0).type().getFullyQualifiedName()).isEqualTo("MyConfiguration");
-            assertThat(matches.get(0).method().getReturnValue()).isEqualTo("a.b.c.SomeBean");
-            assertThat(matches.get(0).method().getName()).isEqualTo("someBean");
-            assertThat(matches.get(1).javaSource().getSourcePath().toString()).isEqualTo("src/main/java/MyConfiguration2.java");
-            assertThat(matches.get(1).type().getFullyQualifiedName()).isEqualTo("MyConfiguration2");
-            assertThat(matches.get(1).method().getName()).isEqualTo("someBean2");
-            assertThat(matches.get(1).method().getReturnValue()).isEqualTo("a.b.c.SomeBean");
+            assertThat(matches.get(0).getJavaSource().getSourcePath().toString()).isEqualTo("src/main/java/MyConfiguration.java");
+            assertThat(matches.get(0).getType().getFullyQualifiedName()).isEqualTo("MyConfiguration");
+            assertThat(matches.get(0).getMethod().getReturnValue()).isEqualTo("a.b.c.SomeBean");
+            assertThat(matches.get(0).getMethod().getName()).isEqualTo("someBean");
+            assertThat(matches.get(1).getJavaSource().getSourcePath().toString()).isEqualTo("src/main/java/MyConfiguration2.java");
+            assertThat(matches.get(1).getType().getFullyQualifiedName()).isEqualTo("MyConfiguration2");
+            assertThat(matches.get(1).getMethod().getName()).isEqualTo("someBean2");
+            assertThat(matches.get(1).getMethod().getReturnValue()).isEqualTo("a.b.c.SomeBean");
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`
`18`	`18`	`import org.junit.jupiter.api.Disabled;`
`19`	`19`	`import org.junit.jupiter.api.Test;`
	`20`	`+import org.springframework.sbm.boot.common.finder.MethodPatternMatchingMethod;`
`20`	`21`	`import org.springframework.sbm.engine.context.ProjectContext;`
`21`	`22`	`import org.springframework.sbm.java.api.MethodCall;`
`22`	`23`	`import org.springframework.sbm.java.api.ProjectJavaSources;`
`@@ -121,7 +122,7 @@ void testGetJpaRepositoriesWithGetByIdMethod() {`
`121`	`122`	`.build();`
`122`	`123`
`123`	`124`	`SpringDataJpaAnalyzer sut = new SpringDataJpaAnalyzer();`
`124`		`- List<SpringDataJpaAnalyzer.MatchingMethod> match = sut.getJpaRepositoriesWithGetByIdMethod(context);`
	`125`	`+ List<MethodPatternMatchingMethod> match = sut.getJpaRepositoriesWithGetByIdMethod(context);`
`125`	`126`	`assertThat(match).hasSize(1);`
`126`	`127`	`}`
`127`	`128`	`}`