Adapt to PMD 7.0.0-rc3 changes

adangel · adangel · commit 34d80d303d16 · 2023-05-29T21:10:31.000+02:00
diff --git a/net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/BasicPMDTest.java b/net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/BasicPMDTest.java
@@ -16,6 +16,7 @@
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetLoader;
 import net.sourceforge.pmd.RuleViolation;
+import net.sourceforge.pmd.lang.document.FileId;
 
 /**
  * Test if PMD can be run correctly.
@@ -42,7 +43,7 @@ private void runPmd() {
         final String sourceCode = "public class Foo {\n public void foo() {\nreturn;\n}}";
 
         try (PmdAnalysis pmd = PmdAnalysis.create(configuration)) {
-            pmd.files().addSourceFile(sourceCode, "Foo.java");
+            pmd.files().addSourceFile(FileId.fromPathLikeString("Foo.java"), sourceCode);
             Report result = pmd.performAnalysisAndCollectReport();
 
             Assert.assertFalse("There should be at least one violation", result.getViolations().isEmpty());
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
@@ -46,6 +46,7 @@
 import net.sourceforge.pmd.lang.LanguageRegistry;
 import net.sourceforge.pmd.lang.LanguageVersion;
 import net.sourceforge.pmd.lang.LanguageVersionDiscoverer;
+import net.sourceforge.pmd.lang.document.FileId;
 import net.sourceforge.pmd.lang.java.JavaLanguageModule;
 
 /**
@@ -290,6 +291,7 @@ protected final void reviewResource(IResource resource) {
             configuration().setIgnoreIncrementalAnalysis(true);
 
             final File sourceCodeFile = file.getRawLocation().toFile();
+            final FileId fileId = FileId.fromPathLikeString(sourceCodeFile.getAbsolutePath());
             if (included && InternalRuleSetUtil.ruleSetsApplies(ruleSets, sourceCodeFile) && isFileInWorkingSet(file)
                     && languageVersion != null) {
                 subTask("PMD checking: " + file.getProject() + ": " + file.getName());
@@ -308,7 +310,7 @@ protected final void reviewResource(IResource resource) {
                      PmdAnalysis pmdAnalysis = PmdAnalysis.create(configuration());) {
 
                     String sourceContents = IOUtil.toString(input);
-                    pmdAnalysis.files().addSourceFile(sourceContents, sourceCodeFile.getAbsolutePath());
+                    pmdAnalysis.files().addSourceFile(fileId, sourceContents);
 
                     pmdAnalysis.addRuleSets(getRuleSetList());
 
@@ -331,7 +333,7 @@ protected final void reviewResource(IResource resource) {
                 if (!collectingReport.getProcessingErrors().isEmpty()) {
                     StringBuilder message = new StringBuilder("There were processing errors!\n");
                     for (ProcessingError error : collectingReport.getProcessingErrors()) {
-                        message.append(error.getFile()).append(": ").append(error.getMsg()).append(' ')
+                        message.append(error.getFileId().getOriginalPath()).append(": ").append(error.getMsg()).append(' ')
                         .append(error.getDetail())
                         .append("\n");
                     }
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/FakeRuleViolation.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/FakeRuleViolation.java
@@ -9,6 +9,7 @@
 
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.RuleViolation;
+import net.sourceforge.pmd.lang.document.FileId;
 import net.sourceforge.pmd.lang.document.FileLocation;
 
 /**
@@ -26,7 +27,7 @@ class FakeRuleViolation implements RuleViolation {
     private int endLine;
     private int endColumn;
 
-    private String filename;
+    private FileId fileId;
     private String packageName;
     private String className;
     private String methodName;
@@ -99,12 +100,12 @@ public void setEndLine(int endLine) {
         this.endLine = endLine;
     }
 
+    
     /**
-     * @param filename
-     *            The filename to set.
+     * @param fileId the fileId to set
      */
-    public void setFilename(String filename) {
-        this.filename = filename;
+    public void setFileId(FileId fileId) {
+        this.fileId = fileId;
     }
 
     /**
@@ -137,8 +138,8 @@ public Rule getRule() {
     }
 
     @Override
-    public String getFilename() {
-        return filename;
+    public FileId getFileId() {
+        return fileId;
     }
 
     @Override
@@ -183,7 +184,7 @@ public String getVariableName() {
 
     @Override
     public FileLocation getLocation() {
-        return FileLocation.caret(filename, beginLine, beginColumn);
+        return FileLocation.caret(fileId, beginLine, beginColumn);
     }
 
     @Override
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/RenderReportsCmd.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/RenderReportsCmd.java
@@ -32,6 +32,7 @@
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
 import net.sourceforge.pmd.eclipse.runtime.builder.MarkerUtil;
+import net.sourceforge.pmd.lang.document.FileId;
 import net.sourceforge.pmd.renderers.Renderer;
 
 /**
@@ -206,7 +207,8 @@ private static FakeRuleViolation createViolation(IMarker marker, Rule rule) {
         ruleViolation.setBeginLine(marker.getAttribute(IMarker.LINE_NUMBER, 0));
         ruleViolation.setEndLine(marker.getAttribute(PMDRuntimeConstants.KEY_MARKERATT_LINE2, 0));
         ruleViolation.setVariableName(marker.getAttribute(PMDRuntimeConstants.KEY_MARKERATT_LINE2, ""));
-        ruleViolation.setFilename(marker.getResource().getProjectRelativePath().toString());
+        FileId fileId = FileId.fromPathLikeString(marker.getResource().getProjectRelativePath().toString());
+        ruleViolation.setFileId(fileId);
         ruleViolation.setDescription(marker.getAttribute(IMarker.MESSAGE, rule.getMessage()));
         return ruleViolation;
     }
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewResourceForRuleCommand.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewResourceForRuleCommand.java
@@ -23,6 +23,7 @@
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
 import net.sourceforge.pmd.eclipse.ui.actions.RuleSetUtil;
 import net.sourceforge.pmd.eclipse.util.internal.IOUtil;
+import net.sourceforge.pmd.lang.document.FileId;
 
 /**
  * This command reviews a resource - a file - for a specific rule.
@@ -86,15 +87,16 @@ public void execute() {
             RuleSet ruleSet = RuleSetUtil.newSingle(rule);
 
             File sourceCodeFile = file.getFullPath().toFile();
-            if (ruleSet.applies(sourceCodeFile.toString())) {
+            FileId fileId = FileId.fromPathLikeString(sourceCodeFile.toString());
+            if (ruleSet.applies(fileId)) {
                 PMDConfiguration configuration = new PMDConfiguration();
                 Report report = null;
 
                 try (Reader input = new InputStreamReader(file.getContents(), file.getCharset());
                      PmdAnalysis pmdAnalysis = PmdAnalysis.create(configuration)) {
 
                     pmdAnalysis.addRuleSet(ruleSet);
-                    pmdAnalysis.files().addSourceFile(IOUtil.toString(input), sourceCodeFile.getAbsolutePath());
+                    pmdAnalysis.files().addSourceFile(fileId, IOUtil.toString(input));
 
                     report = pmdAnalysis.performAnalysisAndCollectReport();
                 } catch (Exception e) {
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/ProjectPropertiesImpl.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/impl/ProjectPropertiesImpl.java
@@ -29,7 +29,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PmdAnalysis;
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.eclipse.core.internal.FileModificationUtil;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
@@ -484,7 +484,7 @@ public ClassLoader getAuxClasspath() {
                 if (auxclasspath == null) {
                     PMDPlugin.getDefault()
                             .logInformation("Creating new auxclasspath class loader for project " + project.getName());
-                    auxclasspath = new JavaProjectClassLoader(PMD.class.getClassLoader(), project);
+                    auxclasspath = new JavaProjectClassLoader(PmdAnalysis.class.getClassLoader(), project);
                 }
                 return auxclasspath;
             }
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/PMDGenerateASTAction.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/PMDGenerateASTAction.java
@@ -41,6 +41,7 @@
 import net.sourceforge.pmd.lang.ast.Parser;
 import net.sourceforge.pmd.lang.ast.Parser.ParserTask;
 import net.sourceforge.pmd.lang.ast.SemanticErrorReporter;
+import net.sourceforge.pmd.lang.document.FileId;
 import net.sourceforge.pmd.lang.document.TextDocument;
 import net.sourceforge.pmd.lang.document.TextFile;
 import net.sourceforge.pmd.lang.java.JavaLanguageModule;
@@ -87,7 +88,7 @@ private void generateAST(IFile file) {
         try (Reader reader = new InputStreamReader(file.getContents(), file.getCharset());
                 ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
                 LanguageProcessor javaProcessor = javaLanguage.createProcessor(new JavaLanguageProperties());
-                TextDocument textDocument = TextDocument.create(TextFile.forReader(reader, file.getName(), javaLanguage.getDefaultVersion()));) {
+                TextDocument textDocument = TextDocument.create(TextFile.forReader(reader, FileId.fromPathLikeString(file.getName()), javaLanguage.getDefaultVersion()));) {
 
             Parser parser = javaProcessor.services().getParser();
             ParserTask parserTask = new ParserTask(textDocument, SemanticErrorReporter.noop(), LanguageProcessorRegistry.singleton(javaProcessor));
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/internal/InternalRuleSetUtil.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/internal/InternalRuleSetUtil.java
@@ -18,6 +18,7 @@
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.RuleSetLoader;
 import net.sourceforge.pmd.RuleSets;
+import net.sourceforge.pmd.lang.document.FileId;
 
 public final class InternalRuleSetUtil {
     private InternalRuleSetUtil() {}
@@ -91,8 +92,9 @@ public static Collection<Pattern> convertStringPatterns(Collection<String> patte
     }
 
     public static boolean ruleSetsApplies(List<RuleSet> rulesets, File file) {
+        FileId fileId = FileId.fromPathLikeString(file.toString());
         for (RuleSet ruleSet : rulesets) {
-            if (ruleSet.applies(file.toString())) {
+            if (ruleSet.applies(fileId)) {
                 return true;
             }
         }
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/views/ast/XPathEvaluator.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/views/ast/XPathEvaluator.java
@@ -16,6 +16,7 @@
 import net.sourceforge.pmd.lang.LanguageRegistry;
 import net.sourceforge.pmd.lang.LanguageVersion;
 import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.lang.document.FileId;
 import net.sourceforge.pmd.lang.java.JavaLanguageModule;
 import net.sourceforge.pmd.lang.rule.XPathRule;
 import net.sourceforge.pmd.lang.rule.xpath.XPathVersion;
@@ -25,7 +26,7 @@
  * @author Brian Remedios
  */
 public final class XPathEvaluator {
-    private static final String SNIPPET_FILENAME = "snippet.java";
+    private static final FileId SNIPPET_FILENAME = FileId.fromPathLikeString("snippet.java");
 
     public static final XPathEvaluator INSTANCE = new XPathEvaluator();
 
@@ -43,7 +44,7 @@ public Node getCompilationUnit(String source) {
 
         try (PmdAnalysis pmd = PmdAnalysis.create(configuration)) {
             pmd.addRuleSet(ruleset);
-            pmd.files().addSourceFile(source, SNIPPET_FILENAME);
+            pmd.files().addSourceFile(SNIPPET_FILENAME, source);
             pmd.performAnalysis();
         }
 
@@ -73,7 +74,7 @@ public List<RuleViolation> evaluate(String source, String xpathQuery, String xpa
         configuration.setForceLanguageVersion(getLanguageVersion());
         try (PmdAnalysis pmd = PmdAnalysis.create(configuration)) {
             pmd.addRuleSet(ruleSet);
-            pmd.files().addSourceFile(source, SNIPPET_FILENAME);
+            pmd.files().addSourceFile(SNIPPET_FILENAME, source);
             Report report = pmd.performAnalysisAndCollectReport();
             return report.getViolations();
         }
diff --git a/pom.xml b/pom.xml
@@ -21,7 +21,7 @@
     <!-- https://github.com/eclipse/tycho/blob/master/RELEASE_NOTES.md and https://github.com/eclipse-tycho/tycho/releases -->
     <tycho.version>3.0.4</tycho.version>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <pmd.version>7.0.0-rc2</pmd.version>
+    <pmd.version>7.0.0-SNAPSHOT</pmd.version>
     <pmd.build-tools.version>20</pmd.build-tools.version>
     <checkstyle.version>10.7.0</checkstyle.version>
     <checkstyle.plugin.version>3.2.2</checkstyle.plugin.version>

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`import net.sourceforge.pmd.RuleSet;`
`19`	`19`	`import net.sourceforge.pmd.RuleSetLoader;`
`20`	`20`	`import net.sourceforge.pmd.RuleSets;`
	`21`	`+import net.sourceforge.pmd.lang.document.FileId;`
`21`	`22`
`22`	`23`	`public final class InternalRuleSetUtil {`
`23`	`24`	`private InternalRuleSetUtil() {}`
`@@ -91,8 +92,9 @@ public static Collection<Pattern> convertStringPatterns(Collection<String> patte`
`91`	`92`	`}`
`92`	`93`
`93`	`94`	`public static boolean ruleSetsApplies(List<RuleSet> rulesets, File file) {`
	`95`	`+ FileId fileId = FileId.fromPathLikeString(file.toString());`
`94`	`96`	`for (RuleSet ruleSet : rulesets) {`
`95`		`- if (ruleSet.applies(file.toString())) {`
	`97`	`+ if (ruleSet.applies(fileId)) {`
`96`	`98`	`return true;`
`97`	`99`	`}`
`98`	`100`	`}`