Implemented Violations to upperEll recipe

Anmol202005 · Anmol202005 · commit 26816cfb501c · 2025-06-28T14:07:14.000+05:30
diff --git a/config/import-control-test.xml b/config/import-control-test.xml
@@ -11,4 +11,5 @@
     <allow pkg="java.util"/>
     <allow pkg="java.nio"/>
     <allow pkg="java.lang"/>
+    <allow pkg="javax.xml.stream"/>
 </import-control>
diff --git a/src/main/java/org/checkstyle/autofix/recipe/UpperEll.java b/src/main/java/org/checkstyle/autofix/recipe/UpperEll.java
@@ -17,9 +17,19 @@
 
 package org.checkstyle.autofix.recipe;
 
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.CancellationException;
+import java.util.function.Function;
+
+import org.checkstyle.autofix.parser.CheckstyleViolation;
+import org.openrewrite.Cursor;
 import org.openrewrite.ExecutionContext;
+import org.openrewrite.PrintOutputCapture;
 import org.openrewrite.Recipe;
 import org.openrewrite.TreeVisitor;
+import org.openrewrite.internal.RecipeRunException;
 import org.openrewrite.java.JavaIsoVisitor;
 import org.openrewrite.java.tree.J;
 import org.openrewrite.java.tree.JavaType;
@@ -30,6 +40,16 @@
  */
 public class UpperEll extends Recipe {
 
+    private List<CheckstyleViolation> violations;
+
+    public UpperEll() {
+        this.violations = new ArrayList<>();
+    }
+
+    public UpperEll(List<CheckstyleViolation> violations) {
+        this.violations = violations;
+    }
+
     @Override
     public String getDisplayName() {
         return "UpperEll recipe";
@@ -43,23 +63,108 @@ public String getDescription() {
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
-        return new UpperEllVisitor();
+        return new UpperEllVisitor(violations);
     }
 
-    /**
-     * Visitor that replaces lowercase 'l' suffixes in long literals with uppercase 'L'.
-     */
     private static final class UpperEllVisitor extends JavaIsoVisitor<ExecutionContext> {
+
+        private final List<CheckstyleViolation> violations;
+        private String currentFileName;
+
+        UpperEllVisitor(List<CheckstyleViolation> violations) {
+            this.violations = violations;
+        }
+
+        @Override
+        public J.CompilationUnit visitCompilationUnit(J.CompilationUnit cu, ExecutionContext ctx) {
+            this.currentFileName = cu.getSourcePath().toString();
+            return super.visitCompilationUnit(cu, ctx);
+        }
+
         @Override
         public J.Literal visitLiteral(J.Literal literal, ExecutionContext ctx) {
             J.Literal result = super.visitLiteral(literal, ctx);
             final String valueSource = result.getValueSource();
 
             if (valueSource != null && valueSource.endsWith("l")
-                    && result.getType() == JavaType.Primitive.Long) {
+                    && result.getType() == JavaType.Primitive.Long
+                    && isAtViolationLocation(result)) {
+
                 final String numericPart = valueSource.substring(0, valueSource.length() - 1);
-                final String newValueSource = numericPart + "L";
-                result = result.withValueSource(newValueSource);
+                result = result.withValueSource(numericPart + "L");
+            }
+
+            return result;
+        }
+
+        private boolean isAtViolationLocation(J.Literal literal) {
+            final J.CompilationUnit cursor = getCursor().firstEnclosing(J.CompilationUnit.class);
+
+            final int line = computeLinePosition(cursor, literal, getCursor());
+            final int column = computeColumnPosition(cursor, literal, getCursor());
+
+            return violations.stream().anyMatch(violation -> {
+                return violation.getLine() == line
+                        && violation.getColumn() == column
+                        && Path.of(violation.getFileName()).equals(Path.of(currentFileName));
+            });
+        }
+
+        private int computePosition(
+                J tree,
+                J targetElement,
+                Cursor cursor,
+                Function<String, Integer> positionCalculator
+        ) {
+            final TreeVisitor<?, PrintOutputCapture<TreeVisitor<?, ?>>> printer =
+                    tree.printer(cursor);
+
+            final PrintOutputCapture<TreeVisitor<?, ?>> capture =
+                    new PrintOutputCapture<>(printer) {
+                        @Override
+                        public PrintOutputCapture<TreeVisitor<?, ?>> append(String text) {
+                            if (targetElement.isScope(getContext().getCursor().getValue())) {
+                                super.append(targetElement.getPrefix().getWhitespace());
+                                throw new CancellationException();
+                            }
+                            return super.append(text);
+                        }
+                    };
+
+            final int result;
+            try {
+                printer.visit(tree, capture, cursor.getParentOrThrow());
+                throw new IllegalStateException("Target element not found in tree");
+            }
+            catch (CancellationException | RecipeRunException exception) {
+                if (exception instanceof CancellationException
+                        || exception.getCause() instanceof CancellationException) {
+                    result = positionCalculator.apply(capture.getOut());
+                }
+                else {
+                    throw exception;
+                }
+            }
+            return result;
+        }
+
+        private int computeLinePosition(J tree, J targetElement, Cursor cursor) {
+            return computePosition(tree, targetElement, cursor,
+                    out -> 1 + (int) out.chars().filter(chr -> chr == '\n').count());
+        }
+
+        private int computeColumnPosition(J tree, J targetElement, Cursor cursor) {
+            return computePosition(tree, targetElement, cursor, this::calculateColumnOffset);
+        }
+
+        private int calculateColumnOffset(String out) {
+            final int lineBreakIndex = out.lastIndexOf('\n');
+            final int result;
+            if (lineBreakIndex == -1) {
+                result = out.length();
+            }
+            else {
+                result = out.length() - lineBreakIndex - 1;
             }
             return result;
         }
diff --git a/src/test/java/org/checkstyle/autofix/recipe/AbstractRecipeTest.java b/src/test/java/org/checkstyle/autofix/recipe/AbstractRecipeTest.java
@@ -24,6 +24,8 @@
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
+import javax.xml.stream.XMLStreamException;
+
 import org.checkstyle.autofix.InputClassRenamer;
 import org.openrewrite.Recipe;
 import org.openrewrite.test.RewriteTest;
@@ -53,7 +55,7 @@ private Recipe createPreprocessingRecipe() {
      *
      * @return the main recipe to test
      */
-    protected abstract Recipe getRecipe();
+    protected abstract Recipe getRecipe() throws XMLStreamException, IOException;
 
     /**
      * Tests a recipe with the given recipe path and test case name.
@@ -67,7 +69,8 @@ private Recipe createPreprocessingRecipe() {
      * @param testCaseName the name of the test case (should match directory and file names)
      * @throws IOException if files cannot be read
      */
-    protected void testRecipe(String recipePath, String testCaseName) throws IOException {
+    protected void testRecipe(String recipePath, String testCaseName)
+            throws IOException, XMLStreamException {
         final String testCaseDir = testCaseName.toLowerCase();
         final String inputFileName = "Input" + testCaseName + ".java";
         final String outputFileName = "Output" + testCaseName + ".java";
diff --git a/src/test/java/org/checkstyle/autofix/recipe/UpperEllTest.java b/src/test/java/org/checkstyle/autofix/recipe/UpperEllTest.java
@@ -18,29 +18,40 @@
 package org.checkstyle.autofix.recipe;
 
 import java.io.IOException;
+import java.nio.file.Path;
+import java.util.List;
 
+import javax.xml.stream.XMLStreamException;
+
+import org.checkstyle.autofix.parser.CheckstyleReportsParser;
+import org.checkstyle.autofix.parser.CheckstyleViolation;
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Recipe;
 
 public class UpperEllTest extends AbstractRecipeTest {
 
     @Override
-    protected Recipe getRecipe() {
-        return new UpperEll();
+    protected Recipe getRecipe() throws XMLStreamException, IOException {
+        final String reportPath = "src/test/resources/org/checkstyle/autofix/recipe/upperell"
+                + "/report.xml";
+
+        final List<CheckstyleViolation> violations =
+                CheckstyleReportsParser.parse(Path.of(reportPath));
+        return new UpperEll(violations);
     }
 
     @Test
-    void hexOctalLiteralTest() throws IOException {
+    void hexOctalLiteralTest() throws IOException, XMLStreamException {
         testRecipe("upperell", "HexOctalLiteral");
     }
 
     @Test
-    void complexLongLiterals() throws IOException {
+    void complexLongLiterals() throws IOException, XMLStreamException {
         testRecipe("upperell", "ComplexLongLiterals");
     }
 
     @Test
-    void stringAndCommentTest() throws IOException {
+    void stringAndCommentTest() throws IOException, XMLStreamException {
         testRecipe("upperell", "StringAndComments");
     }
 }
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/upperell/complexlongliterals/InputComplexLongLiterals.java b/src/test/resources/org/checkstyle/autofix/recipe/upperell/complexlongliterals/InputComplexLongLiterals.java
@@ -11,8 +11,8 @@ public class InputComplexLongLiterals {
     private Long simpleLong = 1234l;
     private Long negativeLong = -5678l;
     private Long underscoreLong = 1_000_000l;
-    Long maxLongObject = 9223372036854775807l;
-    Long minLongObject = -9223372036854775808l;
+    Long maxLongObject = 9223372036854775807l;    //suppressed violation
+    Long minLongObject = -9223372036854775808l;    //suppressed violation
 
     public long calculate(long input1, long input2) {
         return input1 + input2 + 1000l;
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/upperell/complexlongliterals/OutputComplexLongLiterals.java b/src/test/resources/org/checkstyle/autofix/recipe/upperell/complexlongliterals/OutputComplexLongLiterals.java
@@ -11,8 +11,8 @@ public class OutputComplexLongLiterals {
     private Long simpleLong = 1234L;
     private Long negativeLong = -5678L;
     private Long underscoreLong = 1_000_000L;
-    Long maxLongObject = 9223372036854775807L;
-    Long minLongObject = -9223372036854775808L;
+    Long maxLongObject = 9223372036854775807l;    //suppressed violation
+    Long minLongObject = -9223372036854775808l;    //suppressed violation
 
     public long calculate(long input1, long input2) {
         return input1 + input2 + 1000L;
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/upperell/hexoctalliteral/InputHexOctalLiteral.java b/src/test/resources/org/checkstyle/autofix/recipe/upperell/hexoctalliteral/InputHexOctalLiteral.java
@@ -2,14 +2,14 @@
 
 public class InputHexOctalLiteral {
     private long hexLower = 0x1ABCl;
-        private long hexUpper = 0X2DEFl;
-        private long octal = 0777l;
-        private long binary = 0b1010l;
-        private long decimal = 12345l;
+    private long hexUpper = 0X2DEFl;
+    private long octal = 0777l;
+    private long binary = 0b1010l;
+    private long decimal = 12345l;
 
     public void calculateValues() {
-        long hexResult = 0xDEADBEEFl;
-        long octalResult = 01234l;
+        long hexResult = 0xDEADBEEFl + 0xDEADBEFl; //suppressed violation for 0xDEADBEFl
+        long octalResult = 01234l + 0xDEADBEEFl;   //suppressed violation for 0xDEADBEFl
         long binaryResult = 0b11110000l;
     }
 }
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/upperell/hexoctalliteral/OutputHexOctalLiteral.java b/src/test/resources/org/checkstyle/autofix/recipe/upperell/hexoctalliteral/OutputHexOctalLiteral.java
@@ -2,14 +2,14 @@
 
 public class OutputHexOctalLiteral {
     private long hexLower = 0x1ABCL;
-        private long hexUpper = 0X2DEFL;
-        private long octal = 0777L;
-        private long binary = 0b1010L;
-        private long decimal = 12345L;
+    private long hexUpper = 0X2DEFL;
+    private long octal = 0777L;
+    private long binary = 0b1010L;
+    private long decimal = 12345L;
 
     public void calculateValues() {
-        long hexResult = 0xDEADBEEFL;
-        long octalResult = 01234L;
+        long hexResult = 0xDEADBEEFL + 0xDEADBEFl; //suppressed violation for 0xDEADBEFl
+        long octalResult = 01234L + 0xDEADBEEFl;   //suppressed violation for 0xDEADBEFl
         long binaryResult = 0b11110000L;
     }
 }
diff --git a/src/test/resources/org/checkstyle/autofix/recipe/upperell/report.xml b/src/test/resources/org/checkstyle/autofix/recipe/upperell/report.xml
