Add basic support for grouping results by package (#3)

CHANGELOG.md

@@ -1,6 +1,7 @@
 
 # CheckStyle-IDEA Changelog
 
+* **5.99.0** New: Added option to group results by package (#3).
 * **5.98.0** New: Added Checkstyle 10.20.1.
 * **5.97.0** Fixed: Refactored code to fix exception around API dependencies at initialisation (#655).
 * **5.97.0** New: Added Checkstyle 10.19.0.

build.gradle.kts

@@ -19,7 +19,7 @@ plugins {
     id("org.infernus.idea.checkstyle.build")
 }
 
-version = "5.98.0"
+version = "5.99.0"
 
 intellijPlatform {
     pluginConfiguration {

buildSrc/src/main/java/org/infernus/idea/checkstyle/build/GradlePluginMain.java

@@ -21,8 +21,6 @@
 import org.gradle.language.base.plugins.LifecycleBasePlugin;
 import org.jetbrains.annotations.NotNull;
 
-import static org.codehaus.groovy.runtime.DefaultGroovyMethods.println;
-
 /**
  * The main plugin class. The action starts here.
  */

src/main/java/org/infernus/idea/checkstyle/actions/GroupByFile.java

@@ -0,0 +1,10 @@
+package org.infernus.idea.checkstyle.actions;
+
+import org.infernus.idea.checkstyle.toolwindow.ResultGrouping;
+
+public class GroupByFile extends GroupingAction {
+
+    public GroupByFile() {
+        super(ResultGrouping.BY_FILE);
+    }
+}

src/main/java/org/infernus/idea/checkstyle/actions/GroupByPackage.java

@@ -0,0 +1,10 @@
+package org.infernus.idea.checkstyle.actions;
+
+import org.infernus.idea.checkstyle.toolwindow.ResultGrouping;
+
+public class GroupByPackage extends GroupingAction {
+
+    public GroupByPackage() {
+        super(ResultGrouping.BY_PACKAGE);
+    }
+}

src/main/java/org/infernus/idea/checkstyle/actions/GroupingAction.java

@@ -0,0 +1,49 @@
+package org.infernus.idea.checkstyle.actions;
+
+import com.intellij.openapi.actionSystem.ActionUpdateThread;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.project.DumbAwareToggleAction;
+import com.intellij.openapi.project.Project;
+import org.infernus.idea.checkstyle.toolwindow.ResultGrouping;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Objects;
+
+import static org.infernus.idea.checkstyle.actions.ToolWindowAccess.*;
+
+abstract class GroupingAction extends DumbAwareToggleAction {
+
+    private final ResultGrouping grouping;
+
+    GroupingAction(@NotNull final ResultGrouping grouping) {
+        this.grouping = grouping;
+    }
+
+    @Override
+    public boolean isSelected(final @NotNull AnActionEvent event) {
+        final Project project = getEventProject(event);
+        if (project == null) {
+            return false;
+        }
+
+        Boolean selected = getFromToolWindowPanel(toolWindow(project), panel -> panel.groupedBy() == grouping);
+        return Objects.requireNonNullElse(selected, false);
+    }
+
+    @Override
+    public void setSelected(final @NotNull AnActionEvent event, final boolean selected) {
+        final Project project = getEventProject(event);
+        if (project == null) {
+            return;
+        }
+
+        actOnToolWindowPanel(toolWindow(project), panel -> {
+            panel.groupBy(grouping);
+        });
+    }
+
+    @Override
+    public @NotNull ActionUpdateThread getActionUpdateThread() {
+        return ActionUpdateThread.EDT;
+    }
+}

src/main/java/org/infernus/idea/checkstyle/toolwindow/CheckStyleToolWindowPanel.java

@@ -40,10 +40,8 @@
 import javax.swing.tree.TreePath;
 import java.awt.*;
 import java.awt.event.*;
-import java.util.ArrayList;
-import java.util.HashMap;
+import java.util.*;
 import java.util.List;
-import java.util.Map;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -297,7 +295,7 @@ private void clearProgress() {
      */
     private void scrollToError(final TreePath treePath) {
         final DefaultMutableTreeNode treeNode = (DefaultMutableTreeNode) treePath.getLastPathComponent();
-        if (treeNode == null || !(treeNode.getUserObject() instanceof ProblemResultTreeNode nodeInfo)) {
+        if (treeNode == null || !(treeNode.getUserObject() instanceof ProblemResultTreeInfo nodeInfo)) {
             return;
         }
 
@@ -326,11 +324,11 @@ private void scrollToError(final TreePath treePath) {
         }, ModalityState.NON_MODAL);
     }
 
-    private int lineFor(final ProblemResultTreeNode nodeInfo) {
+    private int lineFor(final ProblemResultTreeInfo nodeInfo) {
         return nodeInfo.getProblem().line();
     }
 
-    private int columnFor(final ProblemResultTreeNode nodeInfo) {
+    private int columnFor(final ProblemResultTreeInfo nodeInfo) {
         return nodeInfo.getProblem().column();
     }
 
@@ -521,8 +519,8 @@ public void displayErrorResult(final Throwable error) {
         clearProgress();
     }
 
-    private SeverityLevel[] getDisplayedSeverities() {
-        final List<SeverityLevel> severityLevels = new ArrayList<>();
+    private Set<SeverityLevel> getDisplayedSeverities() {
+        final var severityLevels = new HashSet<SeverityLevel>();
 
         if (displayingErrors) {
             severityLevels.add(SeverityLevel.Error);
@@ -536,7 +534,7 @@ private SeverityLevel[] getDisplayedSeverities() {
             severityLevels.add(SeverityLevel.Info);
         }
 
-        return severityLevels.toArray(new SeverityLevel[0]);
+        return severityLevels;
     }
 
     /**
@@ -586,6 +584,14 @@ public void setDisplayingInfo(final boolean displayingInfo) {
         this.displayingInfo = displayingInfo;
     }
 
+    public void groupBy(final ResultGrouping grouping) {
+        treeModel.groupBy(grouping);
+    }
+
+    public ResultGrouping groupedBy() {
+        return treeModel.groupedBy();
+    }
+
     private PluginConfigurationManager configurationManager() {
         return project.getService(PluginConfigurationManager.class);
     }

src/main/java/org/infernus/idea/checkstyle/toolwindow/FileResultTreeNode.java → src/main/java/org/infernus/idea/checkstyle/toolwindow/FileResultTreeInfo.java

@@ -3,7 +3,7 @@
 import com.intellij.icons.AllIcons;
 import org.infernus.idea.checkstyle.CheckStyleBundle;
 
-public class FileResultTreeNode extends ResultTreeNode {
+public class FileResultTreeInfo extends ResultTreeNode {
 
     private final String fileName;
     private final int totalProblems;
@@ -15,7 +15,7 @@ public class FileResultTreeNode extends ResultTreeNode {
      * @param fileName     the name of the file.
      * @param problemCount the number of problems in the file.
      */
-    public FileResultTreeNode(final String fileName, final int problemCount) {
+    public FileResultTreeInfo(final String fileName, final int problemCount) {
         super(CheckStyleBundle.message("plugin.results.scan-file-result", fileName, problemCount));
 
         if (fileName == null) {

src/main/java/org/infernus/idea/checkstyle/toolwindow/PackageTreeInfo.java

@@ -0,0 +1,47 @@
+package org.infernus.idea.checkstyle.toolwindow;
+
+import com.intellij.icons.AllIcons;
+import org.infernus.idea.checkstyle.CheckStyleBundle;
+
+public class PackageTreeInfo extends ResultTreeNode {
+
+    private final String packageName;
+    private final int totalProblems;
+    private int visibleProblems;
+
+    /**
+     * Construct a package node.
+     *
+     * @param packageName     the name of the package.
+     * @param problemCount the number of problems in the file.
+     */
+    public PackageTreeInfo(final String packageName, final int problemCount) {
+        super(CheckStyleBundle.message("plugin.results.scan-file-result", packageName, problemCount));
+
+        if (packageName == null) {
+            throw new IllegalArgumentException("Package name may not be null");
+        }
+
+        this.packageName = packageName;
+        this.totalProblems = problemCount;
+        this.visibleProblems = problemCount;
+
+        updateDisplayText();
+
+        setIcon(AllIcons.Nodes.Package);
+    }
+
+    private void updateDisplayText() {
+        if (totalProblems == visibleProblems) {
+            setText(CheckStyleBundle.message("plugin.results.scan-package-result", packageName, totalProblems));
+        } else {
+            setText(CheckStyleBundle.message("plugin.results.scan-package-result.filtered", packageName, visibleProblems, totalProblems - visibleProblems));
+        }
+    }
+
+    void setVisibleProblems(final int visibleProblems) {
+        this.visibleProblems = visibleProblems;
+
+        updateDisplayText();
+    }
+}

src/main/java/org/infernus/idea/checkstyle/toolwindow/ProblemResultTreeNode.java → src/main/java/org/infernus/idea/checkstyle/toolwindow/ProblemResultTreeInfo.java

@@ -7,7 +7,7 @@
 import org.infernus.idea.checkstyle.csapi.SeverityLevel;
 import org.jetbrains.annotations.NotNull;
 
-public class ProblemResultTreeNode extends ResultTreeNode {
+public class ProblemResultTreeInfo extends ResultTreeNode {
 
     private final PsiFile file;
     private final Problem problem;
@@ -19,7 +19,7 @@ public class ProblemResultTreeNode extends ResultTreeNode {
      * @param file    the file the problem exists in.
      * @param problem the problem.
      */
-    public ProblemResultTreeNode(@NotNull final PsiFile file,
+    public ProblemResultTreeInfo(@NotNull final PsiFile file,
                                  @NotNull final Problem problem) {
         super(CheckStyleBundle.message("plugin.results.file-result",
                 file.getName(),

src/main/java/org/infernus/idea/checkstyle/toolwindow/ResultGrouping.java

@@ -0,0 +1,8 @@
+package org.infernus.idea.checkstyle.toolwindow;
+
+public enum ResultGrouping {
+
+    BY_FILE,
+    BY_PACKAGE
+
+}