Merge branch '__rultor'

Author: rultor

qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocTagsCheck.java

@@ -36,9 +36,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 import java.util.regex.Pattern;
 
 /**
@@ -69,7 +67,7 @@ public final class JavadocTagsCheck extends AbstractCheck {
     /**
      * Map of tag and its pattern.
      */
-    private final Map<String, Pattern> tags = new HashMap<>();
+    private final List<RequiredJavaDocTag> required = new ArrayList<>(1);
 
     /**
      * List of prohibited javadoc tags.
@@ -97,10 +95,13 @@ public int[] getRequiredTokens() {
 
     @Override
     public void init() {
-        this.tags.put(
-            "since",
-            Pattern.compile(
+        this.required.add(
+            new RequiredJavaDocTag(
+                "since",
+                Pattern.compile(
                 "^\\d+(\\.\\d+){1,2}(\\.[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"
+                ),
+                this::log
             )
         );
     }
@@ -115,34 +116,26 @@ public void visitToken(final DetailAST ast) {
             for (final String tag : this.prohibited) {
                 this.findProhibited(lines, start, cstart, cend, tag);
             }
-            for (final String tag : this.tags.keySet()) {
-                this.matchTagFormat(lines, cstart, cend, tag);
+            for (final RequiredJavaDocTag tag : this.required) {
+                tag.matchTagFormat(lines, cstart, cend);
             }
         } else {
             this.log(0, "Problem finding class/interface comment");
         }
     }
 
-    /**
-     * Get the text of the given tag.
-     * @param line Line with the tag.
-     * @return The text of the tag.
-     */
-    private static String getTagText(final String line) {
-        return line.substring(
-            line.indexOf(' ', line.indexOf('@')) + 1
-        );
-    }
-
     /**
      * Find a text in lines, by going up.
      * @param lines List of lines to check.
      * @param start Start searching from this line number.
      * @param text Text to find.
      * @return Line number with found text, or -1 if it wasn't found.
      */
-    private static int findTrimmedTextUp(final String[] lines,
-        final int start, final String text) {
+    private static int findTrimmedTextUp(
+        final String[] lines,
+        final int start,
+        final String text
+    ) {
         int found = -1;
         for (int pos = start - 1; pos >= 0; pos -= 1) {
             if (lines[pos].trim().equals(text)) {
@@ -182,8 +175,13 @@ private static int findCommentEnd(final String[] lines, final int start) {
      * @param tag Name of the tag.
      * @checkstyle ParameterNumber (3 lines)
      */
-    private void findProhibited(final String[] lines, final int start,
-        final int cstart, final int cend, final String tag) {
+    private void findProhibited(
+        final String[] lines,
+        final int start,
+        final int cstart,
+        final int cend,
+        final String tag
+    ) {
         final List<Integer> found =
             this.findTagLineNum(lines, cstart, cend, tag);
         if (!found.isEmpty()) {
@@ -195,38 +193,6 @@ private void findProhibited(final String[] lines, final int start,
         }
     }
 
-    /**
-     * Check if the tag text matches the format from pattern.
-     * @param lines List of all lines.
-     * @param start Line number where comment starts.
-     * @param end Line number where comment ends.
-     * @param tag Name of the tag.
-     * @checkstyle ParameterNumber (3 lines)
-     */
-    private void matchTagFormat(final String[] lines, final int start,
-        final int end, final String tag) {
-        final List<Integer> found = this.findTagLineNum(lines, start, end, tag);
-        if (found.isEmpty()) {
-            this.log(
-                start + 1,
-                "Missing ''@{0}'' tag in class/interface comment",
-                tag
-            );
-            return;
-        }
-        for (final Integer item : found) {
-            final String text = JavadocTagsCheck.getTagText(lines[item]);
-            if (!this.tags.get(tag).matcher(text).matches()) {
-                this.log(
-                    item + 1,
-                    "Tag text ''{0}'' does not match the pattern ''{1}''",
-                    text,
-                    this.tags.get(tag).toString()
-                );
-            }
-        }
-    }
-
     /**
      * Find given tag in comment lines.
      * @param lines Lines to search for the tag.
@@ -236,8 +202,12 @@ private void matchTagFormat(final String[] lines, final int start,
      * @return Line number with found tag or -1 otherwise.
      * @checkstyle ParameterNumber (3 lines)
      */
-    private List<Integer> findTagLineNum(final String[] lines, final int start,
-        final int end, final String tag) {
+    private List<Integer> findTagLineNum(
+        final String[] lines,
+        final int start,
+        final int end,
+        final String tag
+    ) {
         final String prefix = String.format(" * @%s ", tag);
         final List<Integer> found = new ArrayList<>(1);
         for (int pos = start; pos <= end; pos += 1) {

qulice-checkstyle/src/main/java/com/qulice/checkstyle/MultiLineCommentCheck.java

@@ -0,0 +1,128 @@
+/*
+ * Copyright (c) 2011-2024 Qulice.com
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met: 1) Redistributions of source code must retain the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer. 2) Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution. 3) Neither the name of the Qulice.com nor
+ * the names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior written
+ * permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+ * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.qulice.checkstyle;
+
+import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
+import com.puppycrawl.tools.checkstyle.api.DetailAST;
+import com.puppycrawl.tools.checkstyle.api.TokenTypes;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * Multi line comment checker.
+ * Used by the checkstyle process multiple times as a singleton.
+ * @since 0.23.1
+ */
+public final class MultiLineCommentCheck extends AbstractCheck {
+    /**
+     * Pattern for check.
+     * It is not final as it is initialized from the configuration.
+     */
+    private Pattern format = Pattern.compile("^$");
+
+    /**
+     * The message to report for a match.
+     * It is not final as it is initialized from the configuration.
+     */
+    private String message = "";
+
+    /**
+     * Comment line.
+     * It is not final because the visitToken method is called many times
+     * during the class under test and the field is reinitialized with a new object.
+     */
+    @SuppressWarnings("PMD.AvoidStringBufferField")
+    private StringBuilder text;
+
+    @Override
+    public boolean isCommentNodesRequired() {
+        return true;
+    }
+
+    @Override
+    public int[] getDefaultTokens() {
+        return new int[]{
+            TokenTypes.BLOCK_COMMENT_BEGIN,
+            TokenTypes.COMMENT_CONTENT,
+            TokenTypes.BLOCK_COMMENT_END,
+        };
+    }
+
+    @Override
+    public int[] getAcceptableTokens() {
+        return this.getDefaultTokens();
+    }
+
+    @Override
+    public int[] getRequiredTokens() {
+        return this.getDefaultTokens();
+    }
+
+    @Override
+    public void visitToken(final DetailAST ast) {
+        if (ast.getType() == TokenTypes.BLOCK_COMMENT_BEGIN) {
+            this.text = new StringBuilder(ast.getText());
+        } else if (ast.getType() == TokenTypes.COMMENT_CONTENT) {
+            this.text.append(ast.getText());
+        } else {
+            this.text.append(ast.getText());
+            final Matcher matcher = this.format.matcher(this.text.toString());
+            if (matcher.matches()) {
+                this.log(ast, this.message);
+            }
+        }
+    }
+
+    /**
+     * The method is called from checkstyle to configure this class.
+     * The parameter is set from the checks.xml file
+     * <module name="com.qulice.checkstyle.MultiLineCommentCheck"/> and
+     * <property name="format" value=" this regexp "/> property
+     *
+     * @param fmt Validatig regexp.
+     */
+    public void setFormat(final String fmt) {
+        this.format = Pattern.compile(fmt);
+    }
+
+    /**
+     * The method is called from checkstyle to configure this class.
+     * The parameter is set from the checks.xml file
+     * <module name="com.qulice.checkstyle.MultiLineCommentCheck"/> and
+     * <property name="message" value="First sentence in a comment should start with ....."/>
+     * property
+     *
+     * @param msg Error message.
+     */
+    public void setMessage(final String msg) {
+        this.message = msg;
+    }
+}