Merge branch 'pr-91'

adangel · adangel · commit 036544a9ffb7 · 2019-03-07T20:38:03.000+01:00
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -19,6 +19,9 @@ This is a minor release.
     The project property "Handle high priority violations as Eclipse errors" now works again.
 *   The PMD markers are now also visible on the overview ruler. They can be customized or disabled via
     workspace preferences, General, Editors, Text Editors, Annotations.
+*   In PMD's general preferences, there is a new option "Determine applicable file types automatically". This new
+    option is enabled by default. When enabled, only the files of the languages, for which rules are active,
+    are considered. This is a fix for [bug #88](https://github.com/pmd/pmd-eclipse-plugin/issues/88).
 
 ### Fixed Issues
 
@@ -27,6 +30,7 @@ This is a minor release.
 *   [#76](https://github.com/pmd/pmd-eclipse-plugin/issues/76): Global rule management is saved even if cancelled
 *   [#78](https://github.com/pmd/pmd-eclipse-plugin/issues/78): Project properties cannot be loaded anymore
 *   [#86](https://github.com/pmd/pmd-eclipse-plugin/issues/86): Add Markers next to Scroll bar
+*   [#88](https://github.com/pmd/pmd-eclipse-plugin/issues/88): PMD is executed for all file types regardless of active rules
 *   [#89](https://github.com/pmd/pmd-eclipse-plugin/issues/89): Upgrade to PMD 6.12.0
 *   [#1359](https://sourceforge.net/p/pmd/bugs/1359/): PMD violations in eclipse should be shown on editor by scrollbar
 
diff --git a/net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCmdTest.java b/net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCmdTest.java
@@ -27,6 +27,7 @@
 import net.sourceforge.pmd.eclipse.EclipseUtils;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
+import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences;
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties;
 import net.sourceforge.pmd.eclipse.ui.actions.RuleSetUtil;
 
@@ -174,4 +175,64 @@ public void testReviewCmdNullResource() {
         cmd.setResourceDelta(null);
         cmd.performExecute();
     }
+
+    private static Rule findRuleByName(RuleSet ruleset, String ruleName, String language) {
+        for (Rule rule : ruleset.getRules()) {
+            if (rule.getName().equals(ruleName) && rule.getLanguage().getTerseName().equals(language)) {
+                return rule;
+            }
+        }
+        return null;
+    }
+
+    @Test
+    public void testReviewCmdBasicAllFilesDefault() throws Exception {
+        // add a second file
+        EclipseUtils.createTestSourceFile(testProject, "/src/Test.js", "function(arg) { notDeclaredVariable = 1; }");
+        testProject.refreshLocal(IResource.DEPTH_INFINITE, null);
+
+        IProjectProperties projectProperties = PMDPlugin.getDefault().getPropertiesManager().loadProjectProperties(testProject);
+        RuleSet projectRuleSet = projectProperties.getProjectRuleSet();
+        Rule emptyCatchBlock = findRuleByName(projectRuleSet, "EmptyCatchBlock", "java");
+        projectRuleSet = RuleSetUtil.clearRules(projectRuleSet);
+        projectRuleSet = RuleSetUtil.addRule(projectRuleSet, emptyCatchBlock);
+        projectProperties.setProjectRuleSet(projectRuleSet);
+        PMDPlugin.getDefault().getPropertiesManager().storeProjectProperties(projectProperties);
+
+        final ReviewCodeCmd cmd = new ReviewCodeCmd();
+        cmd.addResource(this.testProject);
+        cmd.performExecute();
+        cmd.join();
+
+        Assert.assertEquals(1, cmd.getFileCount()); // only one file analyzed
+    }
+
+    @Test
+    public void testReviewCmdBasicAllFiles() throws Exception {
+        try {
+            // add a second file
+            EclipseUtils.createTestSourceFile(testProject, "/src/Test.js", "function(arg) { notDeclaredVariable = 1; }");
+            testProject.refreshLocal(IResource.DEPTH_INFINITE, null);
+
+            PMDPlugin.getDefault().loadPreferences().setDetermineFiletypesAutomatically(false);
+
+            IProjectProperties projectProperties = PMDPlugin.getDefault().getPropertiesManager().loadProjectProperties(testProject);
+            RuleSet projectRuleSet = projectProperties.getProjectRuleSet();
+            Rule emptyCatchBlock = findRuleByName(projectRuleSet, "EmptyCatchBlock", "java");
+            projectRuleSet = RuleSetUtil.clearRules(projectRuleSet);
+            projectRuleSet = RuleSetUtil.addRule(projectRuleSet, emptyCatchBlock);
+            projectProperties.setProjectRuleSet(projectRuleSet);
+            PMDPlugin.getDefault().getPropertiesManager().storeProjectProperties(projectProperties);
+
+            final ReviewCodeCmd cmd = new ReviewCodeCmd();
+            cmd.addResource(this.testProject);
+            cmd.performExecute();
+            cmd.join();
+
+            Assert.assertEquals(2, cmd.getFileCount()); // both files analyzed, although unnecessary, since only
+            // the one java rule is active and no javascript rules
+        } finally {
+            PMDPlugin.getDefault().loadPreferences().setDetermineFiletypesAutomatically(IPreferences.DETERMINE_FILETYPES_AUTOMATICALLY_DEFAULT);
+        }
+    }
 }
diff --git a/net.sourceforge.pmd.eclipse.plugin.test/src/main/resources/test.template b/net.sourceforge.pmd.eclipse.plugin.test/src/main/resources/test.template
@@ -9,6 +9,7 @@ public class Test {
 
     public void foo() {
         try {
+        // EmptyCatchBlock!!
         } catch (Exception e) {
 
         }
diff --git a/net.sourceforge.pmd.eclipse.plugin/messages.properties b/net.sourceforge.pmd.eclipse.plugin/messages.properties
@@ -30,6 +30,7 @@ preference.pmd.label.check_after_saving = Check code after saving
 preference.pmd.label.use_dfa = Enable dataflow anomaly analysis (experimental)
 preference.pmd.label.use_project_build_path = Enable using Java Project Build Path.  Disable if your Eclipse JVM version is incompatible with .class file versions.
 preference.pmd.label.max_violations_pfpr = Maximum reported violations per file per rule
+preference.pmd.label.determine_filetypes_automatically = Determine applicable file types automatically (based on rule languages)
 preference.pmd.tooltip.max_violations_pfpr = This helps limit report sizes and improves overall performance
 preference.pmd.message.invalid_numeric_value = Incorrect numeric value entered
 preference.pmd.label.review_pmd_style = Use PMD style (// NOPMD comment)
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/BaseVisitor.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/BaseVisitor.java
@@ -15,6 +15,7 @@
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Set;
 import java.util.Stack;
@@ -72,6 +73,7 @@ public class BaseVisitor {
     private Map<IFile, Set<MarkerInfo2>> accumulator;
     // private PMDEngine pmdEngine;
     private RuleSets ruleSets;
+    private Set<String> fileExtensions;
     private int fileCount;
     private long pmdDuration;
     private IProjectProperties projectProperties;
@@ -225,6 +227,10 @@ public void setRuleSets(final RuleSets ruleSets) {
         this.ruleSets = ruleSets;
     }
 
+    public void setFileExtensions(Set<String> fileExtensions) {
+        this.fileExtensions = fileExtensions;
+    }
+
     /**
      * @return the number of files that has been processed
      */
@@ -264,6 +270,18 @@ protected final void reviewResource(IResource resource) {
             return;
         }
 
+        if (PMDPlugin.getDefault().loadPreferences().isDetermineFiletypesAutomatically()) {
+            if (fileExtensions != null) {
+                if (!fileExtensions.contains(file.getFileExtension().toLowerCase(Locale.ROOT))) {
+                    PMDPlugin.getDefault().logInformation("Skipping file " + file.getName() + " based on file extension");
+                    LOG.debug("Skipping file " + file.getName() + " based on file extension");
+                    return;
+                }
+            } else {
+                LOG.warn("Can't check for file extensions.");
+            }
+        }
+
         Reader input = null;
         try {
             boolean included = isIncluded(file);
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCodeCmd.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCodeCmd.java
@@ -9,6 +9,7 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Set;
 
@@ -49,6 +50,7 @@
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties;
 import net.sourceforge.pmd.eclipse.runtime.properties.PropertiesException;
 import net.sourceforge.pmd.eclipse.ui.actions.RuleSetUtil;
+import net.sourceforge.pmd.lang.Language;
 import net.sourceforge.pmd.util.StringUtil;
 
 /**
@@ -419,6 +421,7 @@ private void processResource(IResource resource) {
             }
 
             RuleSets ruleSets = rulesetsFrom(resource);
+            Set<String> fileExtensions = determineFileExtensions(ruleSets);
             // final PMDEngine pmdEngine = getPmdEngineForProject(project);
             int targetCount = 0;
             if (resource.exists()) {
@@ -432,6 +435,7 @@ private void processResource(IResource resource) {
                     final ResourceVisitor visitor = new ResourceVisitor();
                     visitor.setMonitor(getMonitor());
                     visitor.setRuleSets(ruleSets);
+                    visitor.setFileExtensions(fileExtensions);
                     // visitor.setPmdEngine(pmdEngine);
                     visitor.setAccumulator(markersByFile);
                     visitor.setUseTaskMarker(taskMarker);
@@ -459,6 +463,22 @@ private void processResource(IResource resource) {
         }
     }
 
+    private Set<String> determineFileExtensions(RuleSets ruleSets) {
+        Set<Language> languages = new HashSet<Language>();
+        for (Rule rule : ruleSets.getAllRules()) {
+            languages.add(rule.getLanguage());
+        }
+        Set<String> fileExtensions = new HashSet<String>();
+        for (Language language : languages) {
+            for (String extension : language.getExtensions()) {
+                fileExtensions.add(extension.toLowerCase(Locale.ROOT));
+            }
+        }
+        logInfo("Determined applicable file extensions: " + fileExtensions);
+        LOG.debug("Determined applicable file extensions: " + fileExtensions);
+        return fileExtensions;
+    }
+
     /**
      * Review an entire project
      */
@@ -576,6 +596,7 @@ private void processResourceDelta() {
                     + project.getName());
 
             final RuleSets ruleSets = rulesetsFromResourceDelta();
+            Set<String> fileExtensions = determineFileExtensions(ruleSets);
 
             // PMDEngine pmdEngine = getPmdEngineForProject(project);
             int targetCount = countDeltaElement(resourceDelta);
@@ -587,6 +608,7 @@ private void processResourceDelta() {
                 DeltaVisitor visitor = new DeltaVisitor();
                 visitor.setMonitor(getMonitor());
                 visitor.setRuleSets(ruleSets);
+                visitor.setFileExtensions(fileExtensions);
                 // visitor.setPmdEngine(pmdEngine);
                 visitor.setAccumulator(markersByFile);
                 visitor.setUseTaskMarker(taskMarker);
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/IPreferences.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/IPreferences.java
@@ -29,6 +29,7 @@ public interface IPreferences {
     boolean PMD_CHECK_AFTER_SAVE_DEFAULT = false;
     boolean PMD_USE_CUSTOM_PRIORITY_NAMES_DEFAULT = true;
     int MAX_VIOLATIONS_PFPR_DEFAULT = 5;
+    boolean DETERMINE_FILETYPES_AUTOMATICALLY_DEFAULT = true;
     String REVIEW_ADDITIONAL_COMMENT_DEFAULT = "by {0} on {1}";
     boolean REVIEW_PMD_STYLE_ENABLED_DEFAULT = true;
     int MIN_TILE_SIZE_DEFAULT = 25;
@@ -143,6 +144,19 @@ public interface IPreferences {
      */
     void setMaxViolationsPerFilePerRule(int maxViolationPerFilePerRule);
 
+    /**
+     * If true: When checking, whether a given file should be analyzed by PMD, take
+     * the rule's language and the language's file extensions into account.
+     * @return
+     */
+    boolean isDetermineFiletypesAutomatically();
+
+    /**
+     * Sets whether the rule's language file extensions should be considered or not.
+     * @param determineFiletypesAutomatically
+     */
+    void setDetermineFiletypesAutomatically(boolean determineFiletypesAutomatically);
+
     /**
      * Get the review additional comment. This comment is a text appended to the
      * review comment that is inserted into the code when a violation is
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesImpl.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesImpl.java
@@ -39,6 +39,7 @@ class PreferencesImpl implements IPreferences {
     private boolean checkAfterSaveEnabled;
     private boolean useCustomPriorityNames;
     private int maxViolationsPerFilePerRule;
+    private boolean determineFiletypesAutomatically;
     private String reviewAdditionalComment;
     private boolean reviewPmdStyleEnabled;
     private int minTileSize;
@@ -146,6 +147,16 @@ public void setMaxViolationsPerFilePerRule(int maxViolationPerFilePerRule) {
         this.maxViolationsPerFilePerRule = maxViolationPerFilePerRule;
     }
 
+    @Override
+    public boolean isDetermineFiletypesAutomatically() {
+        return determineFiletypesAutomatically;
+    }
+
+    @Override
+    public void setDetermineFiletypesAutomatically(boolean determineFiletypesAutomatically) {
+        this.determineFiletypesAutomatically = determineFiletypesAutomatically;
+    }
+
     /**
      * @see net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences#getReviewAdditionalComment()
      */
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesManagerImpl.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesManagerImpl.java
@@ -68,6 +68,7 @@ class PreferencesManagerImpl implements IPreferencesManager {
     private static final String PMD_VIOLATIONS_OUTLINE_ENABLED = PMDPlugin.PLUGIN_ID + ".pmd_outline_enabled";
     private static final String PMD_CHECK_AFTER_SAVE_ENABLED = PMDPlugin.PLUGIN_ID + ".pmd_check_after_save_enabled";
     private static final String MAX_VIOLATIONS_PFPR = PMDPlugin.PLUGIN_ID + ".max_violations_pfpr";
+    private static final String DETERMINE_FILETYPES_AUTOMATICALLY = PMDPlugin.PLUGIN_ID + ".determine_filetypes_automatically";
     private static final String REVIEW_ADDITIONAL_COMMENT = PMDPlugin.PLUGIN_ID + ".review_additional_comment";
     private static final String REVIEW_PMD_STYLE_ENABLED = PMDPlugin.PLUGIN_ID + ".review_pmd_style_enabled";
     private static final String PMD_USE_CUSTOM_PRIORITY_NAMES = PMDPlugin.PLUGIN_ID + ".use_custom_priority_names";
@@ -159,6 +160,7 @@ public IPreferences reloadPreferences() {
         loadCheckAfterSaveEnabled();
         loadUseCustomPriorityNames();
         loadMaxViolationsPerFilePerRule();
+        loadDetermineFiletypesAutomatically();
         loadReviewAdditionalComment();
         loadReviewPmdStyleEnabled();
         loadMinTileSize();
@@ -231,6 +233,7 @@ public void storePreferences(IPreferences thePreferences) {
         storeCheckAfterSaveEnabled();
         storeUseCustomPriorityNames();
         storeMaxViolationsPerFilePerRule();
+        storeDetermineFiletypesAutomatically();
         storeReviewAdditionalComment();
         storeReviewPmdStyleEnabled();
         storeMinTileSize();
@@ -305,6 +308,11 @@ private void loadMaxViolationsPerFilePerRule() {
         loadPreferencesStore.setDefault(MAX_VIOLATIONS_PFPR, IPreferences.MAX_VIOLATIONS_PFPR_DEFAULT);
         preferences.setMaxViolationsPerFilePerRule(loadPreferencesStore.getInt(MAX_VIOLATIONS_PFPR));
     }
+    
+    private void loadDetermineFiletypesAutomatically() {
+        loadPreferencesStore.setDefault(DETERMINE_FILETYPES_AUTOMATICALLY, IPreferences.DETERMINE_FILETYPES_AUTOMATICALLY_DEFAULT);
+        preferences.setDetermineFiletypesAutomatically(loadPreferencesStore.getBoolean(DETERMINE_FILETYPES_AUTOMATICALLY));
+    }
 
     private void loadReviewAdditionalComment() {
         loadPreferencesStore.setDefault(REVIEW_ADDITIONAL_COMMENT, IPreferences.REVIEW_ADDITIONAL_COMMENT_DEFAULT);
@@ -486,6 +494,10 @@ private void storeMaxViolationsPerFilePerRule() {
         storePreferencesStore.setValue(MAX_VIOLATIONS_PFPR, preferences.getMaxViolationsPerFilePerRule());
     }
 
+    private void storeDetermineFiletypesAutomatically() {
+        storePreferencesStore.setValue(DETERMINE_FILETYPES_AUTOMATICALLY, preferences.isDetermineFiletypesAutomatically());
+    }
+
     private void storeReviewAdditionalComment() {
         storePreferencesStore.setValue(REVIEW_ADDITIONAL_COMMENT, preferences.getReviewAdditionalComment());
     }
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/nls/StringKeys.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/nls/StringKeys.java
@@ -41,6 +41,7 @@ public class StringKeys {
     public static final String PREF_GENERAL_LABEL_USE_DFA = "preference.pmd.label.use_dfa";
     public static final String PREF_GENERAL_LABEL_USE_PROJECT_BUILD_PATH = "preference.pmd.label.use_project_build_path";
     public static final String PREF_GENERAL_LABEL_MAX_VIOLATIONS_PFPR = "preference.pmd.label.max_violations_pfpr";
+    public static final String PREF_GENERAL_LABEL_DETERMINE_FILETYPES_AUTOMATICALLY = "preference.pmd.label.determine_filetypes_automatically";
     public static final String PREF_GENERAL_TOOLTIP_MAX_VIOLATIONS_PFPR = "preference.pmd.tooltip.max_violations_pfpr";
     public static final String PREF_GENERAL_MESSAGE_INVALID_NUMERIC_VALUE = "preference.pmd.message.invalid_numeric_value";
     public static final String PREF_GENERAL_REVIEW_PMD_STYLE = "preference.pmd.label.review_pmd_style";
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/GeneralPreferencesPage.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/GeneralPreferencesPage.java
@@ -100,6 +100,7 @@ public class GeneralPreferencesPage extends PreferencePage implements IWorkbench
     private TableViewer tableViewer;
     private IPreferences preferences;
     private BasicTableManager priorityTableMgr;
+    private Button determineFiletypesAutomatically;
 
     private Control[] nameFields;
 
@@ -165,6 +166,7 @@ private Group buildGeneralGroup(final Composite parent) {
         showViolationsOutlineViewBox = buildShowViolationOutlineBoxButton(group);
         useProjectBuildPath = buildUseProjectBuildPathButton(group);
         checkCodeOnSave = buildCheckCodeOnSaveButton(group);
+        determineFiletypesAutomatically = buildDetermineFiletypesAutomatically(group);
         Label separator = new Label(group, SWT.SEPARATOR | SWT.SHADOW_IN | SWT.HORIZONTAL);
         maxViolationsPerFilePerRule = buildMaxViolationsPerFilePerRuleText(group);
 
@@ -709,6 +711,13 @@ private Spinner buildMaxViolationsPerFilePerRuleText(Composite parent) {
         return spinner;
     }
 
+    private Button buildDetermineFiletypesAutomatically(Composite viewGroup) {
+        Button button = new Button(viewGroup, SWT.CHECK);
+        button.setText(getMessage(StringKeys.PREF_GENERAL_LABEL_DETERMINE_FILETYPES_AUTOMATICALLY));
+        button.setSelection(preferences.isDetermineFiletypesAutomatically());
+        return button;
+    }
+
     /**
      * Build the check box for enabling PMD review style
      * 
@@ -752,6 +761,7 @@ protected void performDefaults() {
         setSelection(useCustomPriorityNames, IPreferences.PMD_USE_CUSTOM_PRIORITY_NAMES_DEFAULT);
         setSelection(useProjectBuildPath, IPreferences.PROJECT_BUILD_PATH_ENABLED_DEFAULT);
         setSelection(reviewPmdStyleBox, IPreferences.REVIEW_PMD_STYLE_ENABLED_DEFAULT);
+        setSelection(determineFiletypesAutomatically, IPreferences.DETERMINE_FILETYPES_AUTOMATICALLY_DEFAULT);
 
         if (maxViolationsPerFilePerRule != null) {
             maxViolationsPerFilePerRule.setMinimum(IPreferences.MAX_VIOLATIONS_PFPR_DEFAULT);
@@ -886,6 +896,10 @@ public boolean performOk() {
                     .setMaxViolationsPerFilePerRule(Integer.valueOf(maxViolationsPerFilePerRule.getText()).intValue());
         }
 
+        if (determineFiletypesAutomatically != null) {
+            preferences.setDetermineFiletypesAutomatically(determineFiletypesAutomatically.getSelection());
+        }
+
         if (reviewPmdStyleBox != null) {
             preferences.setReviewPmdStyleEnabled(reviewPmdStyleBox.getSelection());
         }

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ public class Test {`
`9`	`9`
`10`	`10`	`public void foo() {`
`11`	`11`	`try {`
	`12`	`+ // EmptyCatchBlock!!`
`12`	`13`	`} catch (Exception e) {`
`13`	`14`
`14`	`15`	`}`