Use CPDRenderer instead of Renderer

adangel · adangel · commit a96b7845ccbe · 2020-12-10T10:34:37.000+01:00
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -28,6 +28,7 @@ This is a minor release.
     *   `net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences.getMaxViolationsPerFilePerRule()`
     *   `net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences.setMaxViolationsPerFilePerRule(int)`
     *   `net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences.MAX_VIOLATIONS_PFPR_DEFAULT`
+*   `net.sourceforge.pmd.eclipse.runtime.cmd.DetectCutAndPasteCmd.setRenderer(Renderer)` is deprecated.
 
 
 ### External Contributions
diff --git a/net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/DetectCutAndPasteCmdTest.java b/net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/DetectCutAndPasteCmdTest.java
@@ -70,7 +70,7 @@ public void tearDown() throws Exception {
     public void testDetectCutAndPasteCmdBasic1() throws CoreException {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(this.testProject);
-        cmd.setRenderer(new SimpleRenderer());
+        cmd.setCPDRenderer(new SimpleRenderer());
         cmd.setReportName(PMDRuntimeConstants.SIMPLE_CPDREPORT_NAME);
         cmd.setCreateReport(true);
         cmd.setLanguage("java");
@@ -121,7 +121,7 @@ public void testDetectCutAndPasteCmdBasic2() throws CoreException {
     public void testDetectCutAndPasteCmdNullArg1() {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(null);
-        cmd.setRenderer(new SimpleRenderer());
+        cmd.setCPDRenderer(new SimpleRenderer());
         cmd.setReportName(PMDRuntimeConstants.SIMPLE_CPDREPORT_NAME);
         cmd.performExecute();
     }
@@ -133,7 +133,7 @@ public void testDetectCutAndPasteCmdNullArg1() {
     public void testDetectCutAndPasteCmdNullArg2() {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(this.testProject);
-        cmd.setRenderer(null);
+        cmd.setCPDRenderer(null);
         cmd.setReportName(PMDRuntimeConstants.SIMPLE_CPDREPORT_NAME);
         cmd.performExecute();
     }
@@ -145,7 +145,7 @@ public void testDetectCutAndPasteCmdNullArg2() {
     public void testDetectCutAndPasteCmdNullArg3() {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(this.testProject);
-        cmd.setRenderer(new SimpleRenderer());
+        cmd.setCPDRenderer(new SimpleRenderer());
         cmd.setReportName(null);
         cmd.performExecute();
     }
@@ -157,7 +157,7 @@ public void testDetectCutAndPasteCmdNullArg3() {
     public void testDetectCutAndPasteCmdNullArg4() {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(null);
-        cmd.setRenderer(null);
+        cmd.setCPDRenderer(null);
         cmd.setReportName(PMDRuntimeConstants.SIMPLE_CPDREPORT_NAME);
         cmd.performExecute();
     }
@@ -169,7 +169,7 @@ public void testDetectCutAndPasteCmdNullArg4() {
     public void testDetectCutAndPasteCmdNullArg5() {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(null);
-        cmd.setRenderer(new SimpleRenderer());
+        cmd.setCPDRenderer(new SimpleRenderer());
         cmd.setReportName(null);
         cmd.performExecute();
     }
@@ -181,7 +181,7 @@ public void testDetectCutAndPasteCmdNullArg5() {
     public void testDetectCutAndPasteCmdNullArg6() {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(this.testProject);
-        cmd.setRenderer(null);
+        cmd.setCPDRenderer(null);
         cmd.setReportName(null);
         cmd.performExecute();
     }
@@ -193,7 +193,7 @@ public void testDetectCutAndPasteCmdNullArg6() {
     public void testDetectCutAndPasteCmdNullArg7() {
         final DetectCutAndPasteCmd cmd = new DetectCutAndPasteCmd();
         cmd.setProject(null);
-        cmd.setRenderer(null);
+        cmd.setCPDRenderer(null);
         cmd.setReportName(null);
         cmd.performExecute();
     }
diff --git a/net.sourceforge.pmd.eclipse.plugin/META-INF/MANIFEST.MF b/net.sourceforge.pmd.eclipse.plugin/META-INF/MANIFEST.MF
@@ -83,6 +83,7 @@ Export-Package: name.herlin.command,
    net.sourceforge.pmd.lang.rule.properties,
    net.sourceforge.pmd.lang.dfa.report",
  net.sourceforge.pmd.cpd,
+ net.sourceforge.pmd.cpd.renderer,
  net.sourceforge.pmd.eclipse.core;uses:="net.sourceforge.pmd",
  net.sourceforge.pmd.eclipse.core.impl,
  net.sourceforge.pmd.eclipse.plugin;
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/DetectCutAndPasteCmd.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/DetectCutAndPasteCmd.java
@@ -5,9 +5,12 @@
 package net.sourceforge.pmd.eclipse.runtime.cmd;
 
 import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
@@ -28,11 +31,11 @@
 import net.sourceforge.pmd.cpd.LanguageFactory;
 import net.sourceforge.pmd.cpd.Match;
 import net.sourceforge.pmd.cpd.Renderer;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
 import net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties;
 import net.sourceforge.pmd.eclipse.runtime.properties.PropertiesException;
-import net.sourceforge.pmd.eclipse.util.IOUtil;
 
 /**
  * This command produces a report of the Cut And Paste detector
@@ -44,7 +47,7 @@ public class DetectCutAndPasteCmd extends AbstractProjectCommand {
 
     private Language language;
     private int minTileSize;
-    private Renderer renderer;
+    private CPDRenderer renderer;
     private String reportName;
     private boolean createReport;
     private List<IPropertyListener> listeners;
@@ -114,7 +117,7 @@ public void reset() {
 
         setTerminated(false);
         setReportName(null);
-        setRenderer(null);
+        setCPDRenderer(null);
         setLanguage("java");
         setMinTileSize(PMDPlugin.getDefault().loadPreferences().getMinTileSize());
         setCreateReport(false);
@@ -139,10 +142,22 @@ public void setMinTileSize(final int tilesize) {
     }
 
     /**
-     * @param renderer
-     *            The renderer to set.
+     * @deprecated Use {@link #setCPDRenderer(CPDRenderer)} instead.
      */
     public void setRenderer(final Renderer renderer) {
+        if (renderer != null) {
+            this.setCPDRenderer(new CPDRenderer() {
+                @Override
+                public void render(Iterator<Match> matches, Writer writer) throws IOException {
+                    writer.write(renderer.render(matches));
+                }
+            });
+        } else {
+            this.setCPDRenderer(null);
+        }
+    }
+
+    public void setCPDRenderer(CPDRenderer renderer) {
         this.renderer = renderer;
     }
 
@@ -254,38 +269,48 @@ private CPD newCPD() {
      *            matches of the CPD
      */
     private void renderReport(Iterator<Match> matches) {
-        InputStream contentsStream = null;
-
         try {
             LOG.debug("Rendering CPD report");
             subTask("Rendering CPD report");
-            final String reportString = renderer.render(matches);
 
             // Create the report folder if not already existing
             LOG.debug("Create the report folder");
             final IFolder folder = getProjectFolder(PMDRuntimeConstants.REPORT_FOLDER);
             if (!folder.exists()) {
                 folder.create(true, true, getMonitor());
             }
-
             // Create the report file
             LOG.debug("Create the report file");
             final IFile reportFile = folder.getFile(reportName);
-            contentsStream = new ByteArrayInputStream(reportString.getBytes());
-            if (reportFile.exists()) {
-                LOG.debug("   Overwriting report file");
-                reportFile.setContents(contentsStream, true, false, getMonitor());
-            } else {
-                LOG.debug("   Creating report file");
-                reportFile.create(contentsStream, true, getMonitor());
+
+            byte[] data = new byte[0];
+            try (ByteArrayOutputStream renderedReport = new ByteArrayOutputStream();
+                 Writer writer = new OutputStreamWriter(renderedReport);) {
+                renderer.render(matches, writer);
+                data = renderedReport.toByteArray();
+            } catch (IOException e) {
+                LOG.error("Error while renderering CPD Report", e);
+                throw new RuntimeException(e);
             }
+
+            try (InputStream contentsStream = new ByteArrayInputStream(data)) {
+                if (reportFile.exists()) {
+                    LOG.debug("   Overwriting report file");
+                    reportFile.setContents(contentsStream, true, false, getMonitor());
+                } else {
+                    LOG.debug("   Creating report file");
+                    reportFile.create(contentsStream, true, getMonitor());
+                }
+            } catch (IOException e) {
+                LOG.error("Error while writing CPD Report", e);
+                throw new RuntimeException(e);
+            }
+
             reportFile.refreshLocal(IResource.DEPTH_INFINITE, getMonitor());
 
         } catch (CoreException e) {
             LOG.debug("Core Exception: " + e.getMessage(), e);
             throw new RuntimeException(e);
-        } finally {
-            IOUtil.closeQuietly(contentsStream);
         }
     }
 }
diff --git a/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/CPDCheckProjectAction.java b/net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/CPDCheckProjectAction.java
@@ -22,9 +22,9 @@
 
 import net.sourceforge.pmd.cpd.CSVRenderer;
 import net.sourceforge.pmd.cpd.LanguageFactory;
-import net.sourceforge.pmd.cpd.Renderer;
 import net.sourceforge.pmd.cpd.SimpleRenderer;
 import net.sourceforge.pmd.cpd.XMLRenderer;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
 import net.sourceforge.pmd.eclipse.runtime.cmd.DetectCutAndPasteCmd;
 import net.sourceforge.pmd.eclipse.ui.PMDUiConstants;
@@ -105,7 +105,7 @@ private void detectCutAndPaste(final IProject project, CPDCheckDialog dialog) {
         final String selectedLanguage = dialog.getSelectedLanguage();
         final int tilesize = dialog.getTileSize();
         final boolean createReport = dialog.isCreateReportSelected();
-        final Renderer selectedRenderer = this.createRenderer(dialog.getSelectedFormat());
+        final CPDRenderer selectedRenderer = this.createRenderer(dialog.getSelectedFormat());
         final String fileName = this.createFileName(dialog.getSelectedFormat());
         final CPDView2 view = showView();
 
@@ -115,7 +115,7 @@ private void detectCutAndPaste(final IProject project, CPDCheckDialog dialog) {
             detectCmd.setCreateReport(createReport);
             detectCmd.setLanguage(selectedLanguage);
             detectCmd.setMinTileSize(tilesize);
-            detectCmd.setRenderer(selectedRenderer);
+            detectCmd.setCPDRenderer(selectedRenderer);
             detectCmd.setReportName(fileName);
             detectCmd.setUserInitiated(true);
             detectCmd.addPropertyListener(view);
@@ -145,8 +145,8 @@ private CPDView2 showView() {
      * @param rendererKey xml, simple or cvs key
      * @return Renderer
      */
-    private Renderer createRenderer(final String rendererKey) {
-        Renderer renderer = null;
+    private CPDRenderer createRenderer(final String rendererKey) {
+        CPDRenderer renderer = null;
         if (XML_KEY.equals(rendererKey)) {
             renderer = new XMLRenderer();
         } else if (SIMPLE_KEY.equals(rendererKey)) {
