Merge pull request #109 from jborgers/master

Order results by rule severity with 5 different levels and icons

Author: amitdev

build.gradle.kts

@@ -28,6 +28,10 @@ dependencies {
     implementation("net.sourceforge.pmd:pmd-kotlin:${pmdVersion}")
     implementation("net.sourceforge.pmd:pmd-xml:${pmdVersion}")
 }
+java {
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
+}
 
 // Configure gradle-intellij-plugin plugin.
 // Read more: https://github.com/JetBrains/gradle-intellij-plugin

src/main/java/com/intellij/plugins/bodhi/pmd/PMDConfigurationForm.java

@@ -13,6 +13,7 @@
 import com.intellij.plugins.bodhi.pmd.core.PMDResultCollector;
 import com.intellij.ui.DocumentAdapter;
 import com.intellij.util.PlatformIcons;
+import org.jetbrains.annotations.NotNull;
 
 import javax.swing.*;
 import javax.swing.event.ChangeEvent;
@@ -46,7 +47,7 @@ public class PMDConfigurationForm {
     private JCheckBox skipTestsCheckBox;
 
     private boolean isModified;
-    private Project project;
+    private final Project project;
 
     public static final String STATISTICS_URL = "Statistics URL";
     private static final String[] columnNames = new String[] {"Option", "Value"};
@@ -63,8 +64,8 @@ public PMDConfigurationForm(final Project project) {
         actionGroup.removeAll();
         //Add the toolbar actions associated to this form to it
         actionGroup.add(new AddRuleSetAction("Add", "Add a custom ruleset", PlatformIcons.ADD_ICON));
-        actionGroup.add(new EditRuleSetAction("Edit", "Edit selected ruleset", IconLoader.getIcon("/actions/editSource.png")));
-        actionGroup.add(new DeleteRuleSetAction("Delete", "Remove selected ruleset", IconLoader.getIcon("/general/remove.png")));
+        actionGroup.add(new EditRuleSetAction("Edit", "Edit selected ruleset", IconLoader.getIcon("/actions/editSource.png", PMDConfigurationForm.class)));
+        actionGroup.add(new DeleteRuleSetAction("Delete", "Remove selected ruleset", IconLoader.getIcon("/general/remove.png", PMDConfigurationForm.class)));
         ActionToolbar toolbar = ActionManager.getInstance().createActionToolbar("modify actions", actionGroup, true);
         toolbar.getComponent().setVisible(true);
         buttonPanel.setLayout(new BorderLayout());
@@ -167,7 +168,7 @@ private void modifyRuleSet(final String defaultValue, AnActionEvent e) {
             if (listModel.data.contains(fileName)) {
                 return;
             }
-            if (defaultValue.length() > 0) {
+            if (defaultValue != null && defaultValue.trim().length() > 0) {
                 listModel.set(ruleList.getSelectedIndex(), fileName);
                 return;
             }
@@ -187,7 +188,7 @@ public AddRuleSetAction(String text, String description, Icon icon) {
             registerCustomShortcutSet(new CustomShortcutSet(KeyStroke.getKeyStroke(KeyEvent.VK_INSERT, KeyEvent.ALT_DOWN_MASK)), rootPanel);
         }
 
-        public void actionPerformed(AnActionEvent e) {
+        public void actionPerformed(@NotNull AnActionEvent e) {
             String defaultValue = "";
             modifyRuleSet(defaultValue, e);
         }
@@ -202,13 +203,13 @@ public EditRuleSetAction(String text, String description, Icon icon) {
             registerCustomShortcutSet(CommonShortcuts.ALT_ENTER, rootPanel);
         }
 
-        public void actionPerformed(AnActionEvent e) {
+        public void actionPerformed(@NotNull AnActionEvent e) {
             String defaultValue;
             defaultValue = (String) ruleList.getSelectedValue();
             modifyRuleSet(defaultValue, e);
         }
 
-        public void update(AnActionEvent e) {
+        public void update(@NotNull AnActionEvent e) {
             super.update(e);
             e.getPresentation().setEnabled(!ruleList.getSelectionModel().isSelectionEmpty());
         }
@@ -223,7 +224,7 @@ public DeleteRuleSetAction(String text, String description, Icon icon) {
             registerCustomShortcutSet(CommonShortcuts.getDelete(), rootPanel);
         }
 
-        public void actionPerformed(AnActionEvent e) {
+        public void actionPerformed(@NotNull AnActionEvent e) {
             int index = ruleList.getSelectedIndex();
             if (index != -1) {
                 ((MyListModel)ruleList.getModel()).remove(index);
@@ -232,7 +233,7 @@ public void actionPerformed(AnActionEvent e) {
             ruleList.repaint();
         }
 
-        public void update(AnActionEvent e) {
+        public void update(@NotNull AnActionEvent e) {
             super.update(e);
             e.getPresentation().setEnabled(ruleList.getSelectedIndex() != -1);
         }
@@ -295,7 +296,7 @@ private void validateStatUrl(String url, int row, int column, Object orig, boole
 
     private class MyListModel extends AbstractListModel {
 
-        private List<String> data;
+        private final List<String> data;
 
         public MyListModel(List<String> data) {
             this.data = data;
@@ -337,17 +338,12 @@ public synchronized void set(int selIndex, String fileName) {
      * select a ruleset file.
      */
     static class BrowsePanel extends JPanel {
-        private JLabel label;
-        private JTextField path;
-        private JButton open;
-
-        private Project project;
+        private final JTextField path;
 
         public BrowsePanel(String defaultValue, final DialogBuilder db, final Project project) {
             super();
-            this.project = project;
             setLayout(new BoxLayout(this, BoxLayout.X_AXIS));
-            label = new JLabel("Choose RuleSet: ");
+            JLabel label = new JLabel("Choose RuleSet: ");
             label.setMinimumSize(new Dimension(100, 20));
             label.setMaximumSize(new Dimension(120, 20));
             label.setPreferredSize(new Dimension(100, 20));
@@ -358,7 +354,7 @@ public BrowsePanel(String defaultValue, final DialogBuilder db, final Project pr
             path.setPreferredSize(new Dimension(200, 20));
             add(path);
             add(Box.createHorizontalStrut(5));
-            open = new JButton("Browse");
+            JButton open = new JButton("Browse");
             label.setMinimumSize(new Dimension(50, 20));
             label.setMaximumSize(new Dimension(150, 20));
             open.setPreferredSize(new Dimension(80, 20));
@@ -381,7 +377,7 @@ public void actionPerformed(ActionEvent e) {
             db.setCenterPanel(this);
 
             path.getDocument().addDocumentListener(new DocumentAdapter() {
-                protected void textChanged(DocumentEvent e) {
+                protected void textChanged(@NotNull DocumentEvent e) {
                     try {
                         Document doc = e.getDocument();
                         db.setOkActionEnabled(doc.getText(0, doc.getLength()).trim().length() > 0);

src/main/java/com/intellij/plugins/bodhi/pmd/PMDInvoker.java

@@ -16,8 +16,7 @@
 import com.intellij.openapi.wm.ToolWindow;
 import com.intellij.openapi.wm.ToolWindowManager;
 import com.intellij.plugins.bodhi.pmd.core.PMDResultCollector;
-import com.intellij.plugins.bodhi.pmd.tree.PMDBranchNode;
-import com.intellij.plugins.bodhi.pmd.tree.PMDRootNode;
+import com.intellij.plugins.bodhi.pmd.tree.*;
 
 import java.io.File;
 import java.util.LinkedList;
@@ -144,7 +143,9 @@ public void runPMD(AnActionEvent actionEvent, String ruleSetPaths, boolean isCus
      */
     public void processFiles(Project project, final String ruleSetPaths, final List<File> files, final boolean isCustomRuleSet, final PMDProjectComponent projectComponent) {
         ToolWindow toolWindow = ToolWindowManager.getInstance(project).getToolWindow(PMDProjectComponent.TOOL_ID);
-        toolWindow.activate(null);
+        if (toolWindow != null) {
+            toolWindow.activate(null);
+        }
 
         //Save all files
         ApplicationManager.getApplication().saveAll();
@@ -170,19 +171,17 @@ public void run() {
                     PMDResultCollector collector = new PMDResultCollector();
 
                     //Get the tree nodes from result collector
-                    List<PMDBranchNode> resultRuleNodes = collector.runPMDAndGetResults(files, ruleSetPath, projectComponent);
-
-                    if (resultRuleNodes.size() != 0) {
-                        String ruleSetName;
-                        if (isCustomRuleSet) {
-                            //For custom rulesets, using a separate format for rendering
-                            ruleSetName = PMDUtil.getBareFileNameFromPath(ruleSetPath) + ";" + ruleSetPath;
-                        } else {
-                            ruleSetName = PMDUtil.getBareFileNameFromPath(ruleSetPath);
-                        }
-                        PMDBranchNode ruleSetNode = resultPanel.addCreateBranchNodeAtRoot(ruleSetName);
+                    List<PMDRuleSetEntryNode> resultRuleNodes = collector.runPMDAndGetResults(files, ruleSetPath, projectComponent);
+                    // sort rules by priority, rule and suppressed nodes are comparable
+                    resultRuleNodes.sort(null);
+
+                    if (!resultRuleNodes.isEmpty()) {
+                        String ruleSetName = PMDUtil.getBareFileNameFromPath(ruleSetPath);
+                        String  desc = PMDResultCollector.getRuleSetDescription(ruleSetPath);
+                        PMDRuleSetNode ruleSetNode = resultPanel.addCreateRuleSetNodeAtRoot(ruleSetName);
+                        ruleSetNode.setToolTip(desc);
                         //Add all rule nodes to the tree
-                        for (PMDBranchNode resultRuleNode : resultRuleNodes) {
+                        for (PMDRuleSetEntryNode resultRuleNode : resultRuleNodes) {
                             resultPanel.addNode(ruleSetNode, resultRuleNode);
                         }
                         rootNode.calculateCounts();

src/main/java/com/intellij/plugins/bodhi/pmd/PMDProjectComponent.java

@@ -18,11 +18,9 @@
 import com.intellij.plugins.bodhi.pmd.core.PMDResultCollector;
 import com.intellij.ui.content.Content;
 import com.intellij.ui.content.ContentFactory;
-import net.sourceforge.pmd.RuleSet;
 import org.jetbrains.annotations.NonNls;
 import org.jetbrains.annotations.NotNull;
 
-import javax.swing.*;
 import java.util.*;
 
 /**
@@ -115,14 +113,7 @@ void updateCustomRulesMenu() {
         List<AnAction> newActionList = new ArrayList<>();
         boolean hasDuplicate = hasDuplicateBareFileName(customRuleSetPaths);
         for (final String ruleSetPath : customRuleSetPaths) {
-            String ruleSetName;
-            try {
-                RuleSet ruleSet = PMDResultCollector.loadRuleSet(ruleSetPath);
-                ruleSetName = ruleSet.getName(); // from the xml
-            } catch (PMDResultCollector.InvalidRuleSetException e) {
-                String msg = (e.getCause() == null) ? e.getMessage(): e.getCause().getMessage();
-                ruleSetName = msg.substring(0, Math.min(25, msg.length()));
-            }
+            String ruleSetName = PMDResultCollector.getRuleSetName(ruleSetPath);
             String extFileName = PMDUtil.getExtendedFileNameFromPath(ruleSetPath);
             String bareFileName = PMDUtil.getBareFileNameFromPath(ruleSetPath);
             String actionText = ruleSetName;

src/main/java/com/intellij/plugins/bodhi/pmd/PMDResultPanel.java

@@ -1,5 +1,6 @@
 package com.intellij.plugins.bodhi.pmd;
 
+import com.intellij.CommonBundle;
 import com.intellij.ide.*;
 import com.intellij.openapi.actionSystem.*;
 import com.intellij.openapi.application.ApplicationManager;
@@ -24,6 +25,7 @@
 import com.intellij.util.ui.tree.TreeUtil;
 import net.sourceforge.pmd.Report;
 import net.sourceforge.pmd.renderers.HTMLRenderer;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import javax.swing.*;
@@ -52,12 +54,12 @@
  */
 public class PMDResultPanel extends JPanel {
 
-    private JTree resultTree;
-    private PMDProjectComponent projectComponent;
+    private final JTree resultTree;
+    private final PMDProjectComponent projectComponent;
     private PMDRootNode rootNode;
-    private PMDBranchNode processingErrorsNode;
+    private PMDErrorBranchNode processingErrorsNode;
     private boolean scrolling;
-    private PMDPopupMenu popupMenu;
+    private final PMDPopupMenu popupMenu;
     public static final String PMD_SUPPRESSION = "//NOPMD";
 
     /**
@@ -122,7 +124,9 @@ public void actionPerformed(ActionEvent e) {
                     for (PMDViolation result : unique.values()) {
                         //Suppress the violation
                         final Editor editor = openEditor(result);
-                        executeWrite(editor, result);
+                        if (editor != null) {
+                            executeWrite(editor, result);
+                        }
                     }
                 } else if (e.getActionCommand().equals(PMDPopupMenu.DETAILS)) {
                     Set<String> urls = new HashSet<>();
@@ -278,11 +282,11 @@ protected Navigatable createDescriptorForNode(DefaultMutableTreeNode node) {
             }
 
             public String getNextOccurenceActionName() {
-                return null;
+                return UsageViewBundle.message("action.next.occurrence");
             }
 
             public String getPreviousOccurenceActionName() {
-                return null;
+                return UsageViewBundle.message("action.previous.occurrence");
             }
         };
 
@@ -303,13 +307,13 @@ public JComponent getSettingsEditor() {
                 return null;
             }
 
-            public void addSettingsChangedListener(ChangeListener listener) throws TooManyListenersException {
+            public void addSettingsChangedListener(ChangeListener listener) {
             }
 
             public void removeSettingsChangedListener(ChangeListener listener) {
             }
 
-            public String getReportText() {
+            public @NotNull String getReportText() {
                 Report r = PMDResultCollector.getReport();
                 HTMLRenderer renderer = new HTMLRenderer();
                 StringWriter w = new StringWriter();
@@ -322,11 +326,11 @@ public String getReportText() {
                 return "";
             }
 
-            public String getDefaultFilePath() {
+            @NotNull public String getDefaultFilePath() {
                 return "report.html";
             }
 
-            public void exportedTo(String filePath) {
+            public void exportedTo(@NotNull String filePath) {
             }
 
             public boolean canExport() {
@@ -351,7 +355,7 @@ public final void initializeTree() {
      * @param treeNode The tree node having the violation/suppressed/error
      */
     public void highlightFindingInEditor(DefaultMutableTreeNode treeNode) {
-        if (treeNode != null && treeNode instanceof Navigatable) {
+        if (treeNode instanceof Navigatable) {
             ((Navigatable)treeNode).navigate(true);
         }
     }
@@ -387,13 +391,13 @@ private Editor openEditor(HasPositionInFile finding) {
     }
 
     /**
-     * Adds a branch node to the tree as a direct child of the root, and return it
+     * Adds a rule set node to the tree as a direct child of the root, and return it
      *
      * @param name the rule name
      * @return the created rule set node
      */
-    public PMDBranchNode addCreateBranchNodeAtRoot(String name) {
-        return (PMDBranchNode)addNode(rootNode, new PMDBranchNode(name));
+    public PMDRuleSetNode addCreateRuleSetNodeAtRoot(String name) {
+        return (PMDRuleSetNode)addNode(rootNode, new PMDRuleSetNode(name));
     }
 
     /**
@@ -429,10 +433,11 @@ public PMDRootNode getRootNode() {
     /**
      * Creates and returns the processingErrors branch node.
      *
-     * @return the new processingErrors brnach node
+     * @return the new processingErrors branch node
      */
-    public PMDBranchNode getNewProcessingErrorsNode() {
-        return processingErrorsNode = new PMDBranchNode("Processing errors");
+    public PMDErrorBranchNode getNewProcessingErrorsNode() {
+        processingErrorsNode = new PMDErrorBranchNode("Processing errors");
+        return processingErrorsNode;
     }
 
     /**
@@ -449,7 +454,7 @@ public void addProcessingErrorsNodeToRootIfHasAny() {
      */
     private class ReRunAction extends AnAction {
         public ReRunAction() {
-            super(UsageViewBundle.message("action.rerun"), UsageViewBundle.message("action.description.rerun"), IconLoader.getIcon("/actions/refreshUsages.png"));
+            super(CommonBundle.message("action.rerun"), UsageViewBundle.message("action.description.rerun"), IconLoader.getIcon("/actions/refreshUsages.png", ReRunAction.class));
             registerCustomShortcutSet(CommonShortcuts.getRerun(), PMDResultPanel.this);
         }
 
@@ -471,18 +476,20 @@ public void actionPerformed(AnActionEvent e) {
     /**
      * Inner class for close action.
      */
-    private class CloseAction extends AnAction {
+    private static class CloseAction extends AnAction {
         private static final String ACTION_CLOSE = "action.close";
 
         private CloseAction() {
-            super(UsageViewBundle.message(ACTION_CLOSE), null, IconLoader.getIcon("/actions/cancel.png"));
+            super(CommonBundle.message(ACTION_CLOSE), null, IconLoader.getIcon("/actions/cancel.png", CloseAction.class));
         }
 
         public void actionPerformed(AnActionEvent e) {
             Project project = e.getData(PlatformDataKeys.PROJECT);
             if (project != null) {
                 ToolWindow toolWindow = ToolWindowManager.getInstance(project).getToolWindow(PMDProjectComponent.TOOL_ID);
-                toolWindow.activate(null);
+                if (toolWindow != null) {
+                    toolWindow.activate(null);
+                }
                 PMDProjectComponent plugin = project.getComponent(PMDProjectComponent.class);
                 plugin.closeResultWindow();
             }