Merge pull request #174 from adangel/upgrade-to-pmd7

Upgrade to PMD 7

Author: adangel

ReleaseNotes.md

@@ -20,10 +20,18 @@ This is a major release.
   For Bugfixes in the PMD Eclipse Plugin only, a new version is released with the same major, minor, and patch,
   but a new qualifier only.
 
+* The minimum required Java version is Java 8.
+
+* The PMD Designer can't be started from within the plugin anymore. Please install
+  [PMD Designer](https://github.com/pmd/pmd-designer) separately when needed.
+
+* Updated to PMD 7.0.0-rc1
+
 ### Fixed Issues
 
 * [#122](https://github.com/pmd/pmd-eclipse-plugin/issues/122): Update PMD 7 Logo in eclipse pmd plugin
 * [#172](https://github.com/pmd/pmd-eclipse-plugin/issues/172): Only support the last 4 eclipse releases
+* [#174](https://github.com/pmd/pmd-eclipse-plugin/pull/174): Upgrade to PMD 7
 
 ### API Changes
 

do-release.sh

@@ -17,7 +17,6 @@ if [ ! -f pom.xml ] || [ ! -d ${PMD_GITHUB_IO_DIR} ]; then
 fi
 
 RELEASE_VERSION=
-DEVELOPMENT_VERSION=
 CURRENT_BRANCH=
 
 echo "-------------------------------------------"
@@ -37,30 +36,37 @@ else
     NEXT_MINOR="${MINOR}"
     NEXT_PATCH=$(("${PATCH}" + 1))
 fi
-DEVELOPMENT_VERSION="$MAJOR.$NEXT_MINOR.$NEXT_PATCH"
-DEVELOPMENT_VERSION="${DEVELOPMENT_VERSION}"
 
-# allow to override the next version, e.g. via "NEXT_VERSION=7.0.0 ./do-release.sh"
-if [ "$NEXT_VERSION" != "" ]; then
-    DEVELOPMENT_VERSION="${NEXT_VERSION}"
+# allow to override the next version, e.g. via "DEVELOPMENT_VERSION=7.0.0-SNAPSHOT ./do-release.sh"
+if [ "$DEVELOPMENT_VERSION" = "" ]; then
+    DEVELOPMENT_VERSION="$MAJOR.$NEXT_MINOR.$NEXT_PATCH-SNAPSHOT"
+fi
+
+# allow to override the build qualifier, e.g. via "BUILDQUALIFIER="$(date -u +v%Y%m%d-%H%M)-rc1" ./do-release.sh"
+if [ "$BUILDQUALIFIER" = "" ]; then
+    # Pick a release BUILDQUALIFIER (e.g. v20170401-0001-r) and update versions
+    # E.g. version is: "4.0.13" and BUILDQUALIFIER is "v20170401-0001-r".
+    # The complete version of the plugin will be "4.0.13.v20170401-0001-r
+    BUILDQUALIFIER="$(date -u +v%Y%m%d-%H%M)-r"
 fi
 
 # http://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch
 CURRENT_BRANCH=$(git symbolic-ref -q HEAD)
 CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/}
 CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD}
 
-# Pick a release BUILDQUALIFIER (e.g. v20170401-0001-r) and update versions
-# E.g. version is: "4.0.13" and BUILDQUALIFIER is "v20170401-0001-r".
-# The complete version of the plugin will be "4.0.13.v20170401-0001-r
-BUILDQUALIFIER="$(date -u +v%Y%m%d-%H%M)-r"
+export DEVELOPMENT_VERSION
 export BUILDQUALIFIER
 
 echo "RELEASE_VERSION: ${RELEASE_VERSION}.${BUILDQUALIFIER} (this release)"
 echo "DEVELOPMENT_VERSION: ${DEVELOPMENT_VERSION} (the next version after the release)"
 echo "CURRENT_BRANCH: ${CURRENT_BRANCH}"
 
-
+echo
+echo "Is this correct?"
+echo
+echo "Press enter to continue... (or CTRL+C to cancel)"
+read -r
 
 echo Update the ReleaseNotes with the release date and version:
 echo 

net.sourceforge.pmd.eclipse.plugin.test.fragment/META-INF/MANIFEST.MF

@@ -5,4 +5,4 @@ Bundle-SymbolicName: net.sourceforge.pmd.eclipse.plugin.test.fragment;singleton:
 Bundle-Version: 7.0.0.qualifier
 Bundle-Vendor: PMD Development Team
 Fragment-Host: net.sourceforge.pmd.eclipse.plugin
-Bundle-RequiredExecutionEnvironment: JavaSE-1.7
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8

net.sourceforge.pmd.eclipse.plugin.test.fragment/src/main/java/test/RuleSetsExtension.java

@@ -6,14 +6,18 @@
 
 import java.util.Set;
 
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.slf4j.event.Level;
 
+import net.sourceforge.pmd.PMDConfiguration;
 import net.sourceforge.pmd.RuleSet;
-import net.sourceforge.pmd.RuleSetFactory;
-import net.sourceforge.pmd.RuleSetNotFoundException;
-import net.sourceforge.pmd.RulesetsFactoryUtils;
+import net.sourceforge.pmd.RuleSetLoadException;
+import net.sourceforge.pmd.RuleSetLoader;
 import net.sourceforge.pmd.eclipse.core.IRuleSetsExtension;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
+import net.sourceforge.pmd.util.log.MessageReporter;
 
 /**
  * Sample of an RuleSets extension.
@@ -40,7 +44,7 @@ public void registerRuleSets(Set<RuleSet> registeredRuleSets) {
             // registeredRuleSets.clear(); // to remove all rulesets already registered
             registeredRuleSets.add(ruleSet1);
             registeredRuleSets.add(ruleSet2);
-        } catch (RuleSetNotFoundException e) {
+        } catch (RuleSetLoadException e) {
             PMDPlugin.getDefault().log(IStatus.ERROR, "Unable to load rulesets", e);
         }
     }
@@ -59,20 +63,22 @@ public void registerDefaultRuleSets(Set<RuleSet> defaultRuleSets) {
             // registeredRuleSets.clear(); // to remove all rulesets already registered
             defaultRuleSets.add(ruleSet1);
             defaultRuleSets.add(ruleSet2);
-        } catch (RuleSetNotFoundException e) {
+        } catch (RuleSetLoadException e) {
             PMDPlugin.getDefault().log(IStatus.ERROR, "Unable to load rulesets", e);
         }
     }
 
     /**
      * Load the 1st ruleset
      * @return the 1st ruleset
-     * @throws RuleSetNotFoundException
+     * @throws RuleSetLoadException
      */
-    private RuleSet getRuleSet1() throws RuleSetNotFoundException {
+    private RuleSet getRuleSet1() throws RuleSetLoadException {
         if (this.ruleSet1 == null) {
-            RuleSetFactory factory = RulesetsFactoryUtils.defaultFactory();
-            this.ruleSet1 = factory.createRuleSets("rulesets/extra1.xml").getAllRuleSets()[0];
+            PMDConfiguration configuration = new PMDConfiguration();
+            configuration.setReporter(new RulesetLoaderMessageReporter());
+            RuleSetLoader ruleSetLoader = RuleSetLoader.fromPmdConfig(configuration);
+            this.ruleSet1 = ruleSetLoader.loadFromResource("rulesets/extra1.xml");
         }
 
         return this.ruleSet1;
@@ -81,15 +87,42 @@ private RuleSet getRuleSet1() throws RuleSetNotFoundException {
     /**
      * Load the 2nd ruleset
      * @return the 2nd ruleset
-     * @throws RuleSetNotFoundException
+     * @throws RuleSetLoadException
      */
-    private RuleSet getRuleSet2() throws RuleSetNotFoundException {
+    private RuleSet getRuleSet2() throws RuleSetLoadException {
         if (this.ruleSet2 == null) {
-            RuleSetFactory factory = RulesetsFactoryUtils.defaultFactory();
-            this.ruleSet2 = factory.createRuleSets("rulesets/extra2.xml").getAllRuleSets()[0];
+            PMDConfiguration configuration = new PMDConfiguration();
+            configuration.setReporter(new RulesetLoaderMessageReporter());
+            RuleSetLoader ruleSetLoader = RuleSetLoader.fromPmdConfig(configuration);
+            this.ruleSet2 = ruleSetLoader.loadFromResource("rulesets/extra2.xml");
         }
 
         return this.ruleSet2;
     }
 
+    private static class RulesetLoaderMessageReporter implements MessageReporter {
+        private int errors = 0;
+
+        @Override
+        public int numErrors() {
+            return errors;
+        }
+
+        @Override
+        public void logEx(Level level, @Nullable String message, Object[] formatArgs, @Nullable Throwable error) {
+            if (Level.ERROR == level) {
+                errors++;
+                PMDPlugin.getDefault().logError(Status.error(message));
+            } else if (Level.WARN == level) {
+                PMDPlugin.getDefault().logWarn(message);
+            } else {
+                PMDPlugin.getDefault().logInformation(message);
+            }
+        }
+
+        @Override
+        public boolean isLoggable(Level level) {
+            return true;
+        }
+    }
 }

net.sourceforge.pmd.eclipse.plugin.test.fragment/src/main/resources/rulesets/extra1.xml

@@ -242,22 +242,45 @@ Some for loops can be simplified to while loops - this makes them more concise.
       </example>
     </rule>
 
-
     <rule name="ExtraUnnecessaryConversionTemporary"
+          language="java"
+          since="0.1"
           message="Avoid unnecessary temporaries when converting primitives to Strings"
-          class="net.sourceforge.pmd.lang.java.rule.errorprone.UnnecessaryConversionTemporaryRule">
-      <description>
-Avoid unnecessary temporaries when converting primitives to Strings
-      </description>
+          class="net.sourceforge.pmd.lang.rule.XPathRule"
+          externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_errorprone.html#unnecessaryconversiontemporary">
+        <description>
+Avoid the use temporary objects when converting primitives to Strings. Use the static conversion methods
+on the wrapper classes instead.
+        </description>
         <priority>3</priority>
-      <example>
-  <![CDATA[public String convert(int x) {
-      // this wastes an object
-      String foo = new Integer(x).toString();
-      // this is better
-      return Integer.toString(x);
-    }]]>
-      </example>
+        <properties>
+            <property name="xpath">
+                <value>
+<![CDATA[
+//MethodCall[@MethodName = 'toString']
+    [ConstructorCall[position() = 1]
+        [
+            pmd-java:typeIs('java.lang.Integer')
+         or pmd-java:typeIs('java.lang.Long')
+         or pmd-java:typeIs('java.lang.Float')
+         or pmd-java:typeIs('java.lang.Byte')
+         or pmd-java:typeIs('java.lang.Double')
+         or pmd-java:typeIs('java.lang.Short')
+        ]
+    ]
+]]>
+                </value>
+            </property>
+        </properties>
+        <example>
+<![CDATA[
+public String convert(int x) {
+    String foo = new Integer(x).toString(); // this wastes an object
+
+    return Integer.toString(x);             // preferred approach
+}
+]]>
+        </example>
     </rule>
 
     <rule name="ExtraOverrideBothEqualsAndHashcode"
@@ -317,6 +340,7 @@ not
     </rule>
 
     <rule name="ExtraDoubleCheckedLocking"
+          language="java"
           message="Double checked locking is not thread safe in Java."
           class="net.sourceforge.pmd.lang.java.rule.multithreading.DoubleCheckedLockingRule">
       <description>

net.sourceforge.pmd.eclipse.plugin.test/META-INF/MANIFEST.MF

@@ -3,7 +3,7 @@ Bundle-ManifestVersion: 2
 Bundle-Version: 7.0.0.qualifier
 Bundle-Name: PMD Test Plugin
 Bundle-SymbolicName: net.sourceforge.pmd.eclipse.plugin.test;singleton:=true
-Bundle-RequiredExecutionEnvironment: JavaSE-1.7
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Bundle-Vendor: PMD Development Team
 Require-Bundle: org.eclipse.ui,
  net.sourceforge.pmd.eclipse.plugin,

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/BasicPMDTest.java

@@ -8,21 +8,20 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.Collections;
+import java.util.Arrays;
 import java.util.List;
 
 import org.junit.Assert;
 import org.junit.Test;
 
-import net.sourceforge.pmd.PMD;
 import net.sourceforge.pmd.PMDConfiguration;
+import net.sourceforge.pmd.PmdAnalysis;
 import net.sourceforge.pmd.Report;
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetLoader;
 import net.sourceforge.pmd.RuleViolation;
 import net.sourceforge.pmd.lang.LanguageRegistry;
-import net.sourceforge.pmd.renderers.Renderer;
+import net.sourceforge.pmd.lang.java.JavaLanguageModule;
 import net.sourceforge.pmd.util.datasource.DataSource;
 
 /**
@@ -69,24 +68,24 @@ public void testDefaulltRuleSets() {
 
     private void runPmd(String javaVersion) {
         PMDConfiguration configuration = new PMDConfiguration();
-        configuration.setDefaultLanguageVersion(LanguageRegistry.findLanguageByTerseName("java").getVersion(javaVersion));
-        configuration.setRuleSets("category/java/codestyle.xml/UnnecessaryReturn");
+        configuration.setDefaultLanguageVersion(
+                LanguageRegistry.PMD.getLanguageById(JavaLanguageModule.TERSE_NAME).getVersion(javaVersion));
+        configuration.setRuleSets(Arrays.asList("category/java/codestyle.xml/UnnecessaryReturn"));
         configuration.setIgnoreIncrementalAnalysis(true);
-        RuleSetLoader rulesetLoader = RuleSetLoader.fromPmdConfig(configuration);
-        List<RuleSet> rulesets = rulesetLoader.loadFromResources(configuration.getRuleSets());
 
-        List<DataSource> files = new ArrayList<>();
         final String sourceCode = "public class Foo {\n public void foo() {\nreturn;\n}}";
-        files.add(new StringDataSource(sourceCode));
 
-        Report result = PMD.processFiles(configuration, rulesets, files,
-                Collections.<Renderer>emptyList());
+        try (PmdAnalysis pmd = PmdAnalysis.create(configuration)) {
+            pmd.files().addSourceFile("Foo.java", sourceCode);
+            Report result = pmd.performAnalysisAndCollectReport();
 
-        Assert.assertFalse("There should be at least one violation", result.getViolations().isEmpty());
+            Assert.assertFalse("There should be at least one violation", result.getViolations().isEmpty());
 
-        final RuleViolation violation = result.getViolations().get(0);
-        Assert.assertEquals(violation.getRule().getName(), "UnnecessaryReturn");
-        Assert.assertEquals(3, violation.getBeginLine());
+            final RuleViolation violation = result.getViolations().get(0);
+            Assert.assertEquals(violation.getRule().getName(), "UnnecessaryReturn");
+            Assert.assertEquals(3, violation.getBeginLine());
+        }
+        
     }
 
     /**

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/EclipseUtils.java

@@ -364,16 +364,22 @@ public static void createFolders(IProject testProject, String fullpath) throws C
         }
     }
 
-    public static void waitForJobs() throws InterruptedException {
+    public static void waitForPMDJobs() throws InterruptedException {
         long start = System.currentTimeMillis();
-        Thread.sleep(500);
-
-        while (!Job.getJobManager().isIdle()) {
+        while (hasPMDJob(Job.getJobManager().find(null))) {
             Thread.sleep(500);
-
             if (System.currentTimeMillis() - start > TimeUnit.SECONDS.toMillis(30)) {
                 Assert.fail("Timeout while waiting for Jobs to finish");
             }
         }
     }
+
+    private static boolean hasPMDJob(Job[] jobs) {
+        for (Job job : jobs) {
+            if (job.getClass().getName().startsWith("net.sourceforge.pmd.eclipse.runtime.cmd.JobCommandProcessor")) {
+                return true;
+            }
+        }
+        return false;
+    }
 }