Skip RenamePrivateFieldsToCamelCase when using lombok (#268)

Fixes #267
openrewrite · Mar 12, 2024 · 9bb285a · 9bb285a
1 parent 3dac84a
commit 9bb285a
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 0 deletions.
diff --git a/src/main/java/org/openrewrite/staticanalysis/RenamePrivateFieldsToCamelCase.java b/src/main/java/org/openrewrite/staticanalysis/RenamePrivateFieldsToCamelCase.java
@@ -17,6 +17,8 @@
 
 import org.openrewrite.*;
 import org.openrewrite.internal.ListUtils;
+import org.openrewrite.java.AnnotationMatcher;
+import org.openrewrite.java.service.AnnotationService;
 import org.openrewrite.java.tree.Flag;
 import org.openrewrite.java.tree.J;
 import org.openrewrite.java.tree.JavaType;
@@ -40,6 +42,7 @@
  * - The recipe will not rename fields if the result already exists in a class or the result will be a java reserved keyword.
  */
 public class RenamePrivateFieldsToCamelCase extends Recipe {
+    private static final AnnotationMatcher LOMBOK_ANNOTATION = new AnnotationMatcher("@lombok.*");
 
     @Override
     public String getDisplayName() {
@@ -83,6 +86,15 @@ protected boolean shouldRename(Set<String> hasNameKey, J.VariableDeclarations.Na
                 );
             }
 
+            @Override
+            public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, ExecutionContext ctx) {
+                // Skip classes annotated with Lombok annotations, as their fields might be set or exposed by Lombok.
+                if (service(AnnotationService.class).matches(getCursor(), LOMBOK_ANNOTATION)) {
+                    return classDecl;
+                }
+                return super.visitClassDeclaration(classDecl, ctx);
+            }
+
             @SuppressWarnings("all")
             @Override
             public J.VariableDeclarations.NamedVariable visitVariable(J.VariableDeclarations.NamedVariable variable, ExecutionContext ctx) {
@@ -123,6 +135,10 @@ public J.VariableDeclarations.NamedVariable visitVariable(J.VariableDeclarations
 
             @Override
             public J.VariableDeclarations visitVariableDeclarations(J.VariableDeclarations multiVariable, ExecutionContext ctx) {
+                if (service(AnnotationService.class).matches(getCursor(), LOMBOK_ANNOTATION)) {
+                    return multiVariable;
+                }
+
                 J.VariableDeclarations vds = super.visitVariableDeclarations(multiVariable, ctx);
                 if (getCursor().getMessage("ADD_STATIC", false)) {
                     return vds.withModifiers(ListUtils.insert(vds.getModifiers(),

diff --git a/src/test/java/org/openrewrite/staticanalysis/RenamePrivateFieldsToCamelCaseTest.java b/src/test/java/org/openrewrite/staticanalysis/RenamePrivateFieldsToCamelCaseTest.java
@@ -19,6 +19,7 @@
 import org.openrewrite.DocumentExample;
 import org.openrewrite.Issue;
 import org.openrewrite.Recipe;
+import org.openrewrite.java.JavaParser;
 import org.openrewrite.java.marker.JavaVersion;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
@@ -585,4 +586,38 @@ public record MyRecord(
           )
         );
     }
+
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite-static-analysis/issues/267")
+    void doNotChangeLombokAnnotatedClasses() {
+        rewriteRun(
+          spec -> spec.parser(JavaParser.fromJavaVersion().classpath("lombok")),
+          //language=java
+          java(
+            """
+              @lombok.RequiredArgsConstructor
+              class Test {
+                  private String D_TYPE_CONNECT = "";
+              }
+              """
+          )
+        );
+    }
+
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite-static-analysis/issues/267")
+    void doNotChangeLombokAnnotatedFields() {
+        rewriteRun(
+          spec -> spec.parser(JavaParser.fromJavaVersion().classpath("lombok")),
+          //language=java
+          java(
+            """
+              class Test {
+                  @lombok.Setter
+                  private String D_TYPE_CONNECT = "";
+              }
+              """
+          )
+        );
+    }
 }