Add grouping of results by the source check (#670).

Author: jshiell

CHANGELOG.md

@@ -1,6 +1,7 @@
 
 # CheckStyle-IDEA Changelog
 
+* **5.109.1** New: Added grouping of results by the source check (#670).
 * **5.109.0** New: Added Checkstyle 10.26.1.
 * **5.108.1** Fixed: Resolved edge case if Piccolo is in the project classpath (#668).
 * **5.108.0** New: Added Checkstyle 10.25.1 & 10.26.0.

build.gradle.kts

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

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

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

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

@@ -5,6 +5,7 @@ public enum ResultGrouping {
     BY_FILE,
     BY_PACKAGE,
     BY_SEVERITY,
-    BY_CONFIGURATION_LOCATION
+    BY_CONFIGURATION_LOCATION,
+    BY_SOURCE_CHECK
 
 }

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

@@ -2,6 +2,7 @@
 
 import java.io.Serial;
 import java.util.*;
+import java.util.function.Function;
 import javax.swing.tree.DefaultMutableTreeNode;
 import javax.swing.tree.DefaultTreeModel;
 import javax.swing.tree.TreeNode;
@@ -87,7 +88,8 @@ private void rebuildTree() {
         switch (grouping) {
             case BY_PACKAGE -> groupResultsByPackage();
             case BY_SEVERITY -> groupResultsBySeverity();
-            case BY_CONFIGURATION_LOCATION -> groupResultsByConfigurationLocation();
+            case BY_CONFIGURATION_LOCATION -> groupResultsBy(ResultProblem::locationDescription);
+            case BY_SOURCE_CHECK -> groupResultsBy(ResultProblem::sourceCheck);
             default -> groupResultsByFile();
         }
 
@@ -295,14 +297,14 @@ private SortedMap<SeverityLevel, Map<PsiFile, List<ResultProblem>>> groupBySever
         return groupedBySeverity;
     }
 
-    private void groupResultsByConfigurationLocation() {
+    private void groupResultsBy(final Function<ResultProblem, String> groupingKeyFunction) {
         int problemCount = 0;
 
-        var groupedByConfigurationLocation = groupByConfigurationLocation(lastResults);
-        for (String locationDescription : groupedByConfigurationLocation.keySet()) {
+        var groupsResults = groupBy(lastResults, groupingKeyFunction);
+        for (String locationDescription : groupsResults.keySet()) {
             final var locationNode = new ToggleableTreeNode();
 
-            final var fileToProblems = groupedByConfigurationLocation.get(locationDescription);
+            final var fileToProblems = groupsResults.get(locationDescription);
             final var childProblemCount = createFileNodes(sortByFileName(fileToProblems), fileToProblems, locationNode);
             if (childProblemCount > 0) {
                 final var packageInfo = new ConfigurationLocationGroupTreeInfo(locationDescription, childProblemCount);
@@ -316,19 +318,20 @@ private void groupResultsByConfigurationLocation() {
         setRootMessage(problemCount);
     }
 
-    private SortedMap<String, Map<PsiFile, List<ResultProblem>>> groupByConfigurationLocation(final Map<PsiFile, List<ResultProblem>> results) {
+    private SortedMap<String, Map<PsiFile, List<ResultProblem>>> groupBy(final Map<PsiFile, List<ResultProblem>> results,
+                                                                         final Function<ResultProblem, String> groupingKeyFunction) {
         if (results == null || results.isEmpty()) {
             return Collections.emptySortedMap();
         }
-        final var groupedByConfigurationLocation = new TreeMap<String, Map<PsiFile, List<ResultProblem>>>();
+        final var groupedProblems = new TreeMap<String, Map<PsiFile, List<ResultProblem>>>();
         results.forEach((file, problems) -> {
             for (ResultProblem problem : problems) {
-                groupedByConfigurationLocation
-                        .computeIfAbsent(problem.locationDescription(), locationKey -> new HashMap<>())
+                groupedProblems
+                        .computeIfAbsent(groupingKeyFunction.apply(problem), key -> new HashMap<>())
                         .computeIfAbsent(file, keyFile -> new ArrayList<>()).add(problem);
             }
         });
-        return groupedByConfigurationLocation;
+        return groupedProblems;
     }
 
     private void setRootMessage(final int problemCount) {

src/main/resources/META-INF/plugin.xml

@@ -25,6 +25,7 @@
     <change-notes>
         <![CDATA[
 <ul>
+    <li>5.109.1: New: Added grouping of results by the source check (#670).</li>
     <li>5.109.0: New: Added Checkstyle 10.26.1.</li>
     <li>5.108.1: Fixed: Resolved edge case if Piccolo is in the project classpath (#668).</li>
     <li>5.108.0: New: Added Checkstyle 10.25.1 & 10.26.0.</li>
@@ -169,6 +170,12 @@
                     text="Group Results By Rules File"
                     description="Group the displayed results by the rules files that contained the rule"
                     icon="/actions/GroupByPrefix.svg"/>
+
+            <action id="CheckStyleGroupBySourceCheckAction"
+                    class="org.infernus.idea.checkstyle.actions.GroupBySourceCheck"
+                    text="Group Results By Source Check"
+                    description="Group the displayed results by their check that was the source of the problem"
+                    icon="/actions/GroupByClass.svg"/>
         </group>
 
         <group id="CheckStylePluginActions" text="CheckStyle" popup="true">