Issue checkstyle#8179: Inability to use xpath for violation for Empty…

…LineSeparator Check
AkMo3 · Mar 15, 2021 · 73a764f · 73a764f
1 parent 9df8837
commit 73a764f
Show file tree

Hide file tree

Showing 14 changed files with 103 additions and 29 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java
@@ -477,12 +477,34 @@ private void processMultipleLinesInside(DetailAST ast) {
         if (isClassMemberBlock(astType)) {
             final List<Integer> emptyLines = getEmptyLines(ast);
             final List<Integer> emptyLinesToLog = getEmptyLinesToLog(emptyLines);
-
             for (Integer lineNo : emptyLinesToLog) {
                 // Checkstyle counts line numbers from 0 but IDE from 1
-                log(lineNo + 1, MSG_MULTIPLE_LINES_INSIDE);
+                log(getLastElementBeforeEmptyLines(ast, lineNo), MSG_MULTIPLE_LINES_INSIDE,
+                        lineNo + 2);
+            }
+        }
+    }
+
+    /**
+     * Returns the element after which empty lines exist.
+     *
+     * @param ast the ast to check.
+     * @param line the empty line which gives violation.
+     * @return The DetailAST after which empty lines are present.
+     */
+    private static DetailAST getLastElementBeforeEmptyLines(DetailAST ast, int line) {
+        DetailAST travelAST = ast;
+        if (ast.getFirstChild().getLineNo() <= line) {
+            travelAST = ast.getFirstChild();
+            while (travelAST.getNextSibling() != null
+                    && travelAST.getNextSibling().getLineNo() <= line) {
+                travelAST = travelAST.getNextSibling();
+            }
+            if (travelAST.hasChildren()) {
+                travelAST = getLastElementBeforeEmptyLines(travelAST, line);
             }
         }
+        return travelAST;
     }
 
     /**
@@ -534,7 +556,7 @@ private static List<Integer> getEmptyLinesToLog(List<Integer> emptyLines) {
             int previousEmptyLineNo = emptyLines.get(0);
             for (int emptyLineNo : emptyLines) {
                 if (previousEmptyLineNo + 1 == emptyLineNo) {
-                    emptyLinesToLog.add(emptyLineNo);
+                    emptyLinesToLog.add(previousEmptyLineNo);
                 }
                 previousEmptyLineNo = emptyLineNo;
             }

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages.properties
@@ -2,7 +2,7 @@ containsTab=Line contains a tab character.
 empty.line.separator=''{0}'' should be separated from previous statement.
 empty.line.separator.multiple.lines=''{0}'' has more than 1 empty lines before.
 empty.line.separator.multiple.lines.after=''{0}'' has more than 1 empty lines after.
-empty.line.separator.multiple.lines.inside=There is more than 1 empty line one after another.
+empty.line.separator.multiple.lines.inside=Line ''{0}'' has more than 1 empty line one after another.
 file.containsTab=File contains tab characters (this is the first instance).
 line.new=''{0}'' should be on a new line.
 line.previous=''{0}'' should be on the previous line.

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_de.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_de.properties
@@ -2,7 +2,7 @@ containsTab=Die Zeile enthält ein Tabulatorzeichen.
 empty.line.separator=''{0}'' sollte von der vorherigen Anweisung durch eine leere Zeile getrennt werden.
 empty.line.separator.multiple.lines=Vor ''{0}'' steht mehr als eine leere Zeile.
 empty.line.separator.multiple.lines.after=Hinter ''{0}'' steht mehr als eine leere Zeile.
-empty.line.separator.multiple.lines.inside=Es stehen mehrere leere Zeilen hintereinander.
+empty.line.separator.multiple.lines.inside=Zeile '' {0} '' enthält nacheinander mehr als eine leere Zeile.
 file.containsTab=Die Datei enthält Tabulatorzeichen (dies ist das erste Vorkommen).
 line.new=''{0}'' sollte in einer neuen Zeile stehen.
 line.previous=''{0}'' sollte in der vorherigen Zeile stehen.

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_es.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_es.properties
@@ -2,7 +2,7 @@ containsTab=La línea contiene un carácter de tabulación.
 empty.line.separator=''{0}'' debe ser separado de la declaración anterior.
 empty.line.separator.multiple.lines=''{0}'' cuenta con más de 1 líneas vacías antes.
 empty.line.separator.multiple.lines.after=''{0}'' cuenta con más de 1 líneas vacías después.
-empty.line.separator.multiple.lines.inside=Hay más de 1 una línea vacía después de otra.
+empty.line.separator.multiple.lines.inside=La línea '' {0} '' tiene más de 1 línea vacía una tras otra.
 file.containsTab=Archivo contiene caracteres de tabulación (este es el primer ejemplo).
 line.new=''{0}'' debería estar en una línea nueva.
 line.previous=''{0}'' debería estar en la línea anterior.

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_fi.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_fi.properties
@@ -2,7 +2,7 @@ containsTab=Rivi sisältää sarkainmerkin.
 empty.line.separator=''{0}'' olisi erotettava edellisen selonteon.
 empty.line.separator.multiple.lines=''{0}'' on yli 1 tyhjää riviä ennen.
 empty.line.separator.multiple.lines.after=''{0}'' on yli 1 tyhjää riviä jälkeen.
-empty.line.separator.multiple.lines.inside=On enemmän kuin 1 tyhjä rivi yksi toisensa jälkeen.
+empty.line.separator.multiple.lines.inside=Rivillä '' {0} '' on enemmän kuin yksi tyhjä rivi peräkkäin.
 file.containsTab=Tiedosto sisältää sarkainmerkeillä (tämä on ensisijaisesti).
 line.new=''{0}'' pitää olla uudella rivillä.
 line.previous=''{0}'' pitää olla edellisellä rivillä.

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_fr.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_fr.properties
@@ -2,7 +2,7 @@ containsTab=La ligne contient un caractère tabulation.
 empty.line.separator=''{0}'' doit être séparé de la déclaration précédente.
 empty.line.separator.multiple.lines=''{0}'' a plus d''une ligne vide avant.
 empty.line.separator.multiple.lines.after=''{0}'' compte plus d''une ligne vide après.
-empty.line.separator.multiple.lines.inside=Il y a plus d''une ligne vide une après l'autre.
+empty.line.separator.multiple.lines.inside=La ligne '' {0} '' a plus d'une ligne vide l'une après l'autre.
 file.containsTab=Le fichier contient des caractères de tabulation (ce n''est que la première occurence).
 line.new=''{0}'' devrait être sur une nouvelle ligne.
 line.previous=''{0}'' devrait être sur la ligne précédente.

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_ja.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_ja.properties
@@ -2,7 +2,7 @@ containsTab=行にタブ文字が含まれています。
 empty.line.separator=''{0}'' は前の文から分離する必要があります。
 empty.line.separator.multiple.lines=''{0}'' の前に空行が複数あります。
 empty.line.separator.multiple.lines.after=''{0}'' の後に空行が複数あります。
-empty.line.separator.multiple.lines.inside=空行が複数続いています。
+empty.line.separator.multiple.lines.inside=行 '' {0} ''には、次々に複数の空の行があります。
 file.containsTab=ファイルにタブ文字が含まれています（ここが最初の出現箇所です）。
 line.new=''{0}'' は新しい行にあるべきです。
 line.previous=''{0}'' は前の行にあるべきです。

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_pt.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_pt.properties
@@ -2,7 +2,7 @@ containsTab=A linha contém um caractere de tabulação.
 empty.line.separator=''{0}'' deveria ser separado da instrução anterior.
 empty.line.separator.multiple.lines=''{0}'' é precedido por mais do que 1 linha vazia.
 empty.line.separator.multiple.lines.after=''{0}'' é sucedido por mais do que 1 linha vazia.
-empty.line.separator.multiple.lines.inside=Há duas ou mais linhas vazias consecutivas.
+empty.line.separator.multiple.lines.inside=A linha '' {0} '' tem mais de 1 linha vazia, uma após a outra.
 file.containsTab=O arquivo contém caracteres de tabulação (esta é a primeira ocorrência).
 line.new=''{0}'' deveria estar numa nova linha.
 line.previous=''{0}'' deveria estar na linha anterior.

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_tr.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_tr.properties
@@ -3,7 +3,7 @@ containsTab=Satır, sekme karakteri içermekte.
 empty.line.separator={0} 'Bir önceki deyimi ayrılmalıdır.
 empty.line.separator.multiple.lines={0} daha önce en fazla 1 boş hatları vardır.
 empty.line.separator.multiple.lines.after=''{0}'' sonra 1'den fazla boş hatları vardır.
-empty.line.separator.multiple.lines.inside=birbiri ardına 1'den fazla boş satır biri var.
+empty.line.separator.multiple.lines.inside='' {0} '' satırında birbiri ardına 1'den fazla boş satır var.
 file.containsTab=Dosya, sekme karakterleri içermekte (sadece ilk bulunan gösteriliyor).
 line.new=''{0}'' ifadesi yeni bir satırda olmalı.
 line.previous=''{0}'' ifadesi önceki satırda olmalı.

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_zh.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/messages_zh.properties
@@ -2,7 +2,7 @@ containsTab=行内含有制表符 tab 。
 empty.line.separator=''{0}' 前应有空行。
 empty.line.separator.multiple.lines=''{0}'' 前只应有一个空行。
 empty.line.separator.multiple.lines.after=''{0}'' 后只应有一个空行。
-empty.line.separator.multiple.lines.inside=还有陆续超过1空行之一。
+empty.line.separator.multiple.lines.inside=行''{0}''一个接一个地有多个空行。
 file.containsTab=文件含有制表符 tab （这只是第一例）。
 line.new=''{0}'' 应另起一行。
 line.previous=''{0}'' 应在前一行。

diff --git a/...t/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheckTest.java b/...t/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheckTest.java
@@ -256,10 +256,12 @@ public void testPreviousLineEmptiness() throws Exception {
         final DefaultConfiguration checkConfig = createModuleConfig(EmptyLineSeparatorCheck.class);
         checkConfig.addAttribute("allowMultipleEmptyLinesInsideClassMembers", "false");
         final String[] expected = {
-            "11: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "16: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "22: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "31: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
+            "9:26: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 11),
+            "14:5: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 16),
+            "20:67: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 22),
+            "29:44: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 31),
+            "39:17: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 41),
+
         };
         verify(checkConfig,
                 getPath("InputEmptyLineSeparatorPreviousLineEmptiness.java"), expected);
@@ -270,12 +272,12 @@ public void testDisAllowMultipleEmptyLinesInsideClassMembers() throws Exception
         final DefaultConfiguration checkConfig = createModuleConfig(EmptyLineSeparatorCheck.class);
         checkConfig.addAttribute("allowMultipleEmptyLinesInsideClassMembers", "false");
         final String[] expected = {
-            "27: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "39: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "45: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "50: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "55: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "56: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
+            "25:11: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 27),
+            "37:11: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 39),
+            "43:11: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 45),
+            "48:31: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 50),
+            "53:11: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 55),
+            "53:11: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 56),
             "60:1: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CLASS_DEF"),
         };
         verify(checkConfig,
@@ -464,8 +466,8 @@ public void testEmptyLineSeparatorRecordsAndCompactCtorsNoEmptyLines() throws Ex
 
         final String[] expected = {
             "2:1: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "package"),
-            "16: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
-            "22: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE),
+            "14:27: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 16),
+            "20:29: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 22),
         };
 
         verify(checkConfig,
@@ -486,4 +488,16 @@ public void testEmptyLineSeparatorMultipleSingleTypeVariables() throws Exception
                 expected);
     }
 
+    @Test
+    public void testEmptyLineSeparatorEmptyLinesInsideClassMembersRecursive() throws Exception {
+        final DefaultConfiguration checkConfig = createModuleConfig(EmptyLineSeparatorCheck.class);
+        checkConfig.addAttribute("allowMultipleEmptyLinesInsideClassMembers", "false");
+        final String[] expected = {
+            "20:15: " + getCheckMessage(MSG_MULTIPLE_LINES_INSIDE, 22),
+        };
+        verify(checkConfig,
+                getPath("InputEmptyLineSeparatorRecursive.java"),
+                expected);
+    }
+
 }
diff --git a/...tespace/emptylineseparator/InputEmptyLineSeparatorRecordsAndCompactCtorsNoEmptyLines.java b/...tespace/emptylineseparator/InputEmptyLineSeparatorRecordsAndCompactCtorsNoEmptyLines.java
@@ -11,15 +11,15 @@
  *
  */
 public class InputEmptyLineSeparatorRecordsAndCompactCtorsNoEmptyLines {
-    public void foo() {
+    public void foo() { // violation
 
 
-    } // ^ violation
+    }
 
     public record MyRecord1(){
-        public MyRecord1{
+        public MyRecord1{ // violation
 
 
-        } // ^ violation
+        }
     }
 }
diff --git a/...le/checks/whitespace/emptylineseparator/InputEmptyLineSeparatorPreviousLineEmptiness.java b/...le/checks/whitespace/emptylineseparator/InputEmptyLineSeparatorPreviousLineEmptiness.java
@@ -1,7 +1,7 @@
 package com.puppycrawl.tools.checkstyle.checks.whitespace.emptylineseparator;
 
 public class InputEmptyLineSeparatorPreviousLineEmptiness {
-    private static final int MULTIPLICATOR;
+    private static final int MULTIPLICATOR ;
 
     private int base;
 
@@ -31,4 +31,13 @@ public static int increment(int value) {
 
         return value * MULTIPLICATOR + 1;
     }
+
+    void foo2() {
+    }
+
+
+    void foo3() {
+
+
+    }
 }
diff --git a/...ols/checkstyle/checks/whitespace/emptylineseparator/InputEmptyLineSeparatorRecursive.java b/...ols/checkstyle/checks/whitespace/emptylineseparator/InputEmptyLineSeparatorRecursive.java
@@ -0,0 +1,29 @@
+package com.puppycrawl.tools.checkstyle.checks.whitespace.emptylineseparator;
+
+import java.io.IOException;
+
+/**
+ * Config:
+ * attribute - allowMultipleEmptyLinesInsideClassMembers
+ * value - false
+ */
+public class InputEmptyLineSeparatorRecursive {
+
+    int foo1() throws Exception {
+        int a = 1;
+        int b = 2;
+        try {
+            if (a != b) {
+                throw new IOException();
+            }
+            // empty lines below should cause a violation
+            // violation
+
+
+        } catch(IOException e) {
+            System.out.println("IO error: " + e.getMessage());
+            return 1;
+        }
+        return 0;
+    }
+}