stuff

Author: Anmol202005

src/main/java/org/checkstyle/autofix/recipe/FinalLocalVariable.java

@@ -21,6 +21,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.UUID;
 
 import org.checkstyle.autofix.PositionHelper;
 import org.checkstyle.autofix.parser.CheckstyleViolation;
@@ -32,6 +33,7 @@
 import org.openrewrite.java.tree.J;
 import org.openrewrite.java.tree.Space;
 import org.openrewrite.java.tree.Statement;
+import org.openrewrite.marker.Marker;
 import org.openrewrite.marker.Markers;
 
 /**
@@ -44,6 +46,7 @@ public class FinalLocalVariable extends Recipe {
 
     public FinalLocalVariable(List<CheckstyleViolation> violations) {
         this.violations = violations;
+        System.out.println("Created FinalLocalVariable");
     }
 
     @Override
@@ -58,16 +61,90 @@ public String getDescription() {
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
-        return new FinalLocalVariableVisitor();
+        return new JavaIsoVisitor<>() {
+            @Override
+            public J.CompilationUnit visitCompilationUnit(J.CompilationUnit cu, ExecutionContext ctx) {
+                cu = new MarkViolationVisitor().visitCompilationUnit(cu, ctx);
+
+                cu = new FinalLocalVariableVisitor().visitCompilationUnit(cu, ctx);
+
+                return cu;
+            }
+        };
     }
 
-    private final class FinalLocalVariableVisitor extends JavaIsoVisitor<ExecutionContext> {
+    public static class FinalLocalVariableMarker implements Marker {
+        private final UUID id;
+
+        public FinalLocalVariableMarker(UUID id) {
+            this.id = id;
+        }
+
+        @Override
+        public UUID getId() {
+            return id;
+        }
+
+        @Override
+        public <M extends Marker> M withId(UUID id) {
+            return (M) new FinalLocalVariableMarker(id);
+        }
+
+    }
+
+    private class MarkViolationVisitor extends JavaIsoVisitor<ExecutionContext> {
 
         private Path sourcePath;
+        private J.CompilationUnit currentCompilationUnit;
 
         @Override
         public J.CompilationUnit visitCompilationUnit(J.CompilationUnit cu, ExecutionContext ctx) {
             this.sourcePath = cu.getSourcePath().toAbsolutePath();
+            this.currentCompilationUnit = cu;
+            return super.visitCompilationUnit(cu, ctx);
+        }
+
+        @Override
+        public J.VariableDeclarations.NamedVariable visitVariable(J.VariableDeclarations.NamedVariable variable,
+                                                                  ExecutionContext ctx) {
+
+
+            if (isAtViolationLocation(variable)) {
+                return variable.withMarkers(
+                        variable.getMarkers().add(new FinalLocalVariableMarker(UUID.randomUUID()))
+                );
+            }
+            return variable;
+        }
+
+        private boolean isAtViolationLocation(J.VariableDeclarations.NamedVariable variable) {
+
+            final int line = PositionHelper.computeLinePosition(currentCompilationUnit, variable, getCursor());
+            final int column = PositionHelper.computeColumnPosition(currentCompilationUnit, variable, getCursor());
+
+            System.out.println("Variable: " + variable.getSimpleName() +
+                    " at " + line + ":" + column);
+
+            violations.forEach(v -> {
+                if (v.getFileName().contains("InputSingleLocalTest")) {
+                    System.out.println("  Looking for violation at " + v.getLine() + ":" + v.getColumn());
+                }
+            });
+
+            return violations.removeIf(violation -> {
+                final Path absolutePath = Path.of(violation.getFileName()).toAbsolutePath();
+                return violation.getLine() == line
+                        && violation.getColumn() == column
+                        && absolutePath.equals(sourcePath);
+            });
+        }
+    }
+
+    private final class FinalLocalVariableVisitor extends JavaIsoVisitor<ExecutionContext> {
+
+
+        @Override
+        public J.CompilationUnit visitCompilationUnit(J.CompilationUnit cu, ExecutionContext ctx) {
             return super.visitCompilationUnit(cu, ctx);
         }
 
@@ -85,7 +162,7 @@ public J.VariableDeclarations visitVariableDeclarations(
 
                 boolean hasViolation = false;
                 for (J.VariableDeclarations.NamedVariable variable : declarations.getVariables()) {
-                    if (isAtViolationLocation(variable)) {
+                    if (variable.getMarkers().findFirst(FinalLocalVariableMarker.class).isPresent()) {
                         hasViolation = true;
                         break;
                     }
@@ -142,7 +219,7 @@ private boolean handleMultiVariableDeclaration(J.VariableDeclarations varDecl,
             final List<J.VariableDeclarations.NamedVariable> nonViolations = new ArrayList<>();
 
             for (J.VariableDeclarations.NamedVariable variable : varDecl.getVariables()) {
-                if (isAtViolationLocation(variable)) {
+                if (variable.getMarkers().findFirst(FinalLocalVariableMarker.class).isPresent()) {
                     violationsList.add(variable.withPrefix(Space.SINGLE_SPACE));
                 }
                 else {
@@ -186,18 +263,5 @@ private J.VariableDeclarations addFinalModifier(J.VariableDeclarations varDecl)
 
             return result;
         }
-
-        private boolean isAtViolationLocation(J.VariableDeclarations.NamedVariable variable) {
-            final J.CompilationUnit cu = getCursor().firstEnclosing(J.CompilationUnit.class);
-
-            final int line = PositionHelper.computeLinePosition(cu, variable, getCursor());
-            final int column = PositionHelper.computeColumnPosition(cu, variable, getCursor());
-
-            return violations.stream().anyMatch(violation -> {
-                return violation.getLine() == line
-                        && violation.getColumn() == column
-                        && Path.of(violation.getFileName()).equals(sourcePath);
-            });
-        }
     }
 }

src/test/resources/org/checkstyle/autofix/recipe/finallocalvariable/multiplevariable/InputMultipleVariable.java

@@ -16,8 +16,9 @@ public void multipleDeclarations() {
 
         String name = "John", city = "NYC";   // 2 violations
 
-        double price = 19.99, tax = 0.08;     // 2 violations
+        double price = 19.99, tax = 0.08;     // violation, "should be declared final"
 
+        tax = 50;
         System.out.println("Sum: " + (x + y + z));
         System.out.println(name + " lives in " + city);
         System.out.println("Total: " + (price + (price * tax)));