minor polish

Author: timo-a

src/main/java/org/openrewrite/java/migrate/lombok/SummarizeGetter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors.
+ * Copyright 2024 the original author or authors.
  * <p>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,6 @@ public class SummarizeGetter extends Recipe {
 
     @Override
     public String getDisplayName() {
-        //language=markdown
         return "Summarize @Getter on fields to class level annotation";
     }
 
@@ -100,6 +99,7 @@ public J.VariableDeclarations visitVariableDeclarations(J.VariableDeclarations v
         }
 
         private J.VariableDeclarations fixFormat(J.VariableDeclarations initial, J.VariableDeclarations visited, ExecutionContext ctx) {
+            //as of August 2024 manual fixes to the format are necessary. Hopefully in the future this method becomes obsolete
 
             boolean isAnnotationOnLineAbove = initial.toString().contains("@Getter\n");
 
@@ -121,8 +121,8 @@ public J.Annotation visitAnnotation(J.Annotation annotation, ExecutionContext ct
                     && annotation.getArguments() == null //no Access level, or other arguments
                     //should only trigger on field annotation, not class annotation
                     && getCursor().getParent().getValue() instanceof J.VariableDeclarations
-                    ? null
-                    : annotation;
+                    ? null // -> delete
+                    : annotation; // -> keep
         }
     }
 }

src/main/java/org/openrewrite/java/migrate/lombok/SummarizeSetter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors.
+ * Copyright 2024 the original author or authors.
  * <p>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,6 @@ public class SummarizeSetter extends Recipe {
 
     @Override
     public String getDisplayName() {
-        //language=markdown
         return "Summarize @Setter on fields to class level annotation";
     }
 
@@ -104,6 +103,7 @@ public J.VariableDeclarations visitVariableDeclarations(J.VariableDeclarations v
         }
 
         private J.VariableDeclarations fixFormat(J.VariableDeclarations initial, J.VariableDeclarations visited, ExecutionContext ctx) {
+            //as of August 2024 manual fixes to the format are necessary. Hopefully in the future this method becomes obsolete
 
             boolean isAnnotationOnLineAbove = initial.toString().contains("@Setter\n");
 
@@ -127,8 +127,8 @@ public J.Annotation visitAnnotation(J.Annotation annotation, ExecutionContext ct
             return isSetterAnnotated
                     //should only trigger on field annotation, not class annotation
                     && getCursor().getParent().getValue() instanceof J.VariableDeclarations
-                    ? null
-                    : annotation;
+                    ? null // -> delete
+                    : annotation; // -> keep
         }
     }
 }

src/test/java/org/openrewrite/java/migrate/lombok/SummarizeGetterTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors.
+ * Copyright 2024 the original author or authors.
  * <p>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,22 +17,16 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.DocumentExample;
-import org.openrewrite.java.JavaParser;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.java.Assertions.java;
 
-// This is a test for the ConvertToNoArgsConstructor recipe, as an example of how to write a test for an imperative recipe.
 class SummarizeGetterTest implements RewriteTest {
 
-    // Note, you can define defaults for the RecipeSpec and these defaults will be used for all tests.
-    // In this case, the recipe and the parser are common. See below, on how the defaults can be overridden
-    // per test.
     @Override
     public void defaults(RecipeSpec spec) {
-        spec.recipe(new SummarizeGetter())
-          .parser(JavaParser.fromJavaVersion().logCompilationWarningsAndErrors(true).classpath("lombok"));
+        spec.recipe(new SummarizeGetter());
     }
 
     @DocumentExample

src/test/java/org/openrewrite/java/migrate/lombok/SummarizeSetterTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 the original author or authors.
+ * Copyright 2024 the original author or authors.
  * <p>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,22 +17,16 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.DocumentExample;
-import org.openrewrite.java.JavaParser;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.java.Assertions.java;
 
-// This is a test for the ConvertToNoArgsConstructor recipe, as an example of how to write a test for an imperative recipe.
 class SummarizeSetterTest implements RewriteTest {
 
-    // Note, you can define defaults for the RecipeSpec and these defaults will be used for all tests.
-    // In this case, the recipe and the parser are common. See below, on how the defaults can be overridden
-    // per test.
     @Override
     public void defaults(RecipeSpec spec) {
-        spec.recipe(new SummarizeSetter())
-          .parser(JavaParser.fromJavaVersion().logCompilationWarningsAndErrors(true).classpath("lombok"));
+        spec.recipe(new SummarizeSetter());
     }
 
     @DocumentExample