Light polish

Author: timtebeek

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

@@ -18,6 +18,7 @@
 import lombok.AccessLevel;
 import lombok.EqualsAndHashCode;
 import lombok.Value;
+import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Recipe;
 import org.openrewrite.TreeVisitor;
@@ -29,7 +30,6 @@
 import java.util.HashSet;
 import java.util.Optional;
 import java.util.Set;
-import java.util.StringJoiner;
 
 import static java.util.Comparator.comparing;
 import static org.openrewrite.java.tree.JavaType.Variable;
@@ -40,33 +40,25 @@ public class ConvertGetter extends Recipe {
 
     @Override
     public String getDisplayName() {
-        //language=markdown
         return "Convert getter methods to annotations";
     }
 
     @Override
     public String getDescription() {
         //language=markdown
-        return new StringJoiner("\n")
-                .add("Convert trivial getter methods to `@Getter` annotations on their respective fields.")
-                .add("")
-                .add("Limitations:")
-                .add("")
-                .add(" - Does not add a dependency to Lombok, users need to do that manually")
-                .add(" - Ignores fields that are declared on the same line as others, e.g. `private int foo, bar;" +
-                        "Users who have such fields are advised to separate them beforehand with " +
-                        "[org.openrewrite.staticanalysis.MultipleVariableDeclaration]" +
-                        "(https://docs.openrewrite.org/recipes/staticanalysis/multiplevariabledeclarations).")
-                .add(" - Does not offer any of the configuration keys listed in https://projectlombok.org/features/GetterSetter.")
-                .toString();
+        return "Convert trivial getter methods to `@Getter` annotations on their respective fields.\n\n" +
+                "Limitations:\n\n" +
+                " - Does not add a dependency to Lombok, users need to do that manually\n" +
+                " - Ignores fields that are declared on the same line as others, e.g. `private int foo, bar; " +
+                "Users who have such fields are advised to separate them beforehand with [org.openrewrite.staticanalysis.MultipleVariableDeclaration](https://docs.openrewrite.org/recipes/staticanalysis/multiplevariabledeclarations).\n" +
+                " - Does not offer any of the configuration keys listed in https://projectlombok.org/features/GetterSetter.";
     }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
         return new MethodRemover();
     }
 
-
     @Value
     @EqualsAndHashCode(callSuper = false)
     private static class MethodRemover extends JavaIsoVisitor<ExecutionContext> {
@@ -91,7 +83,7 @@ public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, Ex
         }
 
         @Override
-        public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, ExecutionContext ctx) {
+        public J.@Nullable MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, ExecutionContext ctx) {
             assert method.getMethodType() != null;
 
             if (LombokUtils.isEffectivelyGetter(method)) {
@@ -125,12 +117,11 @@ private JavaTemplate getAnnotation(AccessLevel accessLevel) {
             JavaTemplate.Builder builder = AccessLevel.PUBLIC.equals(accessLevel) ?
                     JavaTemplate.builder("@Getter\n") :
                     JavaTemplate.builder("@Getter(AccessLevel." + accessLevel.name() + ")\n")
-                    .imports("lombok.AccessLevel");
+                            .imports("lombok.AccessLevel");
 
             return builder
                     .imports("lombok.Getter")
-                    .javaParser(JavaParser.fromJavaVersion()
-                            .classpath("lombok"))
+                    .javaParser(JavaParser.fromJavaVersion().classpath("lombok"))
                     .build();
         }
 

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

@@ -28,7 +28,7 @@
 import static lombok.AccessLevel.*;
 import static org.openrewrite.java.tree.J.Modifier.Type.*;
 
-public class LombokUtils {
+class LombokUtils {
 
     public static boolean isEffectivelyGetter(J.MethodDeclaration method) {
         boolean takesNoParameters = method.getParameters().get(0) instanceof J.Empty;
@@ -49,19 +49,16 @@ public static boolean isEffectivelyGetter(J.MethodDeclaration method) {
     }
 
     public static String deriveGetterMethodName(JavaType.Variable fieldType) {
-        boolean isPrimitiveBoolean = JavaType.Variable.Primitive.Boolean.equals(fieldType.getType());
-
-        final String fieldName = fieldType.getName();
-
-        boolean alreadyStartsWithIs = fieldName.length() >= 3 &&
-                fieldName.substring(0, 3).matches("is[A-Z]");
-
-        if (isPrimitiveBoolean)
-            if (alreadyStartsWithIs)
+        String fieldName = fieldType.getName();
+        if (fieldType.getType() == JavaType.Variable.Primitive.Boolean) {
+            boolean alreadyStartsWithIs = fieldName.length() >= 3 &&
+                    fieldName.substring(0, 3).matches("is[A-Z]");
+            if (alreadyStartsWithIs) {
                 return fieldName;
-            else
+            } else {
                 return "is" + StringUtils.capitalize(fieldName);
-
+            }
+        }
         return "get" + StringUtils.capitalize(fieldName);
     }
 

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

@@ -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 ConvertGetterTest 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 ConvertGetter())
-          .parser(JavaParser.fromJavaVersion().logCompilationWarningsAndErrors(true));
+        spec.recipe(new ConvertGetter());
     }
 
     @DocumentExample