Detect trailing whitespace within comments in TrailingWhitespace

Author: cirras

delphi-checks/src/main/java/au/com/integradev/delphi/checks/TrailingWhitespaceCheck.java

@@ -20,9 +20,9 @@
 
 import static java.util.regex.Pattern.compile;
 
+import com.google.common.base.CharMatcher;
 import com.google.common.base.Splitter;
 import java.util.regex.Pattern;
-import org.apache.commons.lang3.StringUtils;
 import org.sonar.check.Rule;
 import org.sonar.plugins.communitydelphi.api.check.DelphiCheck;
 import org.sonar.plugins.communitydelphi.api.check.DelphiCheckContext;
@@ -36,9 +36,19 @@ public class TrailingWhitespaceCheck extends DelphiCheck {
   private static final String MESSAGE = "Remove this trailing whitespace.";
 
   private static final Pattern NEW_LINE_DELIMITER = compile("\r\n?|\n");
+  private static final Splitter NEW_LINE_SPLITTER = Splitter.on(NEW_LINE_DELIMITER);
+  private static final CharMatcher WHITESPACE_MATCHER =
+      CharMatcher.inRange((char) 0x00, (char) 0x20)
+          .and(CharMatcher.isNot('\r'))
+          .and(CharMatcher.isNot('\n'));
 
   @Override
   public void visitToken(DelphiToken token, DelphiCheckContext context) {
+    visitWhitespace(token, context);
+    visitComment(token, context);
+  }
+
+  private static void visitWhitespace(DelphiToken token, DelphiCheckContext context) {
     if (!token.isWhitespace()) {
       return;
     }
@@ -50,8 +60,8 @@ public void visitToken(DelphiToken token, DelphiCheckContext context) {
     int line = token.getBeginLine();
     int column = token.getBeginColumn();
 
-    String image = StringUtils.stripEnd(token.getImage(), " \t\f");
-    var parts = Splitter.on(NEW_LINE_DELIMITER).split(image);
+    String image = WHITESPACE_MATCHER.trimTrailingFrom(token.getImage());
+    var parts = NEW_LINE_SPLITTER.split(image);
     for (String whitespace : parts) {
       if (!whitespace.isEmpty()) {
         context
@@ -64,4 +74,29 @@ public void visitToken(DelphiToken token, DelphiCheckContext context) {
       column = 0;
     }
   }
+
+  private static void visitComment(DelphiToken token, DelphiCheckContext context) {
+    if (!token.isComment()) {
+      return;
+    }
+
+    var commentLines = NEW_LINE_SPLITTER.splitToList(token.getImage());
+
+    for (int i = 0; i < commentLines.size(); ++i) {
+      String commentLine = commentLines.get(i);
+      String trimmedCommentLine = WHITESPACE_MATCHER.trimTrailingFrom(commentLine);
+      int whitespaceLength = commentLine.length() - trimmedCommentLine.length();
+
+      if (whitespaceLength > 0) {
+        int line = token.getBeginLine() + i;
+        int column = trimmedCommentLine.length();
+
+        context
+            .newIssue()
+            .onFilePosition(FilePosition.from(line, column, line, column + whitespaceLength))
+            .withMessage(MESSAGE)
+            .report();
+      }
+    }
+  }
 }

delphi-checks/src/test/java/au/com/integradev/delphi/checks/TrailingWhitespaceCheckTest.java

@@ -71,4 +71,73 @@ void testLeadingWhitespaceShouldNotAddIssue() {
         .onFile(new DelphiTestUnitBuilder().appendImpl("\t   \t \t var Foo: TObject;"))
         .verifyNoIssues();
   }
+
+  @Test
+  void testNoTrailingSpaceInLineCommentShouldNotAddIssue() {
+    CheckVerifier.newVerifier()
+        .withCheck(new TrailingWhitespaceCheck())
+        .onFile(
+            new DelphiTestUnitBuilder().appendImpl("// there is no trailing whitespace in here"))
+        .verifyNoIssues();
+  }
+
+  @Test
+  void testTrailingSpaceInLineCommentShouldAddIssue() {
+    CheckVerifier.newVerifier()
+        .withCheck(new TrailingWhitespaceCheck())
+        .onFile(
+            new DelphiTestUnitBuilder()
+                .appendImpl("// Noncompliant@+1")
+                .appendImpl("// hey, there's a trailing spaces in here! "))
+        .verifyIssues();
+  }
+
+  @Test
+  void testTrailingTabsInLineCommentShouldAddIssue() {
+    CheckVerifier.newVerifier()
+        .withCheck(new TrailingWhitespaceCheck())
+        .onFile(
+            new DelphiTestUnitBuilder()
+                .appendImpl("// Noncompliant@+1")
+                .appendImpl("// hey, there's a trailing tab in here!\t"))
+        .verifyIssues();
+  }
+
+  @Test
+  void testNoTrailingSpaceInMultilineCommentShouldNotAddIssue() {
+    CheckVerifier.newVerifier()
+        .withCheck(new TrailingWhitespaceCheck())
+        .onFile(
+            new DelphiTestUnitBuilder()
+                .appendImpl("{")
+                .appendImpl("  there is no trailing whitespace in here")
+                .appendImpl("}"))
+        .verifyNoIssues();
+  }
+
+  @Test
+  void testTrailingSpaceInMultilineCommentShouldAddIssue() {
+    CheckVerifier.newVerifier()
+        .withCheck(new TrailingWhitespaceCheck())
+        .onFile(
+            new DelphiTestUnitBuilder()
+                .appendImpl("// Noncompliant@+2")
+                .appendImpl("{")
+                .appendImpl("  hey, there's a trailing space in here! ")
+                .appendImpl("}"))
+        .verifyIssues();
+  }
+
+  @Test
+  void testTrailingTabInMultilineCommentShouldAddIssue() {
+    CheckVerifier.newVerifier()
+        .withCheck(new TrailingWhitespaceCheck())
+        .onFile(
+            new DelphiTestUnitBuilder()
+                .appendImpl("// Noncompliant@+2")
+                .appendImpl("{")
+                .appendImpl("  hey, there's a trailing space in here!\t")
+                .appendImpl("}"))
+        .verifyIssues();
+  }
 }