From 5386f83f07654a1d5915c80a2ae05932e097b67f Mon Sep 17 00:00:00 2001
From: vmassol <vmassol@13f79535-47bb-0310-9956-ffa450edef68>
Date: Mon, 4 Apr 2005 17:32:23 +0000
Subject: [PATCH] MPCLOVER-31: Added PDF report generation

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@160064 13f79535-47bb-0310-9956-ffa450edef68
---
 clover/plugin.jelly                           | 97 ++++++++++++++-----
 clover/plugin.properties                      |  1 +
 .../testGenerateHistoryReport/maven.xml       |  1 +
 .../project.properties                        |  3 +
 .../maven.xml                                 |  3 +-
 .../project.properties                        |  2 +
 .../project.xml                               |  4 +-
 .../org/apache/maven/clover/test/Simple.java  |  0
 .../apache/maven/clover/test/SimpleTest.java  |  0
 clover/xdocs/changes.xml                      |  3 +
 clover/xdocs/properties.xml                   | 10 ++
 11 files changed, 96 insertions(+), 28 deletions(-)
 rename clover/src/plugin-test/{testSiteReportAndXmlReportGeneration => testSiteReportAndGenerationOfDifferentFormats}/maven.xml (89%)
 rename clover/src/plugin-test/{testSiteReportAndXmlReportGeneration => testSiteReportAndGenerationOfDifferentFormats}/project.properties (93%)
 rename clover/src/plugin-test/{testSiteReportAndXmlReportGeneration => testSiteReportAndGenerationOfDifferentFormats}/project.xml (87%)
 rename clover/src/plugin-test/{testSiteReportAndXmlReportGeneration => testSiteReportAndGenerationOfDifferentFormats}/src/main/org/apache/maven/clover/test/Simple.java (100%)
 rename clover/src/plugin-test/{testSiteReportAndXmlReportGeneration => testSiteReportAndGenerationOfDifferentFormats}/src/test/org/apache/maven/clover/test/SimpleTest.java (100%)

diff --git a/clover/plugin.jelly b/clover/plugin.jelly
index 13a6aa79..71b70e8f 100644
--- a/clover/plugin.jelly
+++ b/clover/plugin.jelly
@@ -19,13 +19,13 @@
  -->
 
 <project 
-  xmlns:j="jelly:core" 
-  xmlns:ant="jelly:ant" 
-  xmlns:maven="jelly:maven"
-  xmlns:java="java"
-  xmlns:test="test"
-  xmlns:doc="doc"
-  xmlns:u="jelly:util">
+    xmlns:j="jelly:core" 
+    xmlns:ant="jelly:ant" 
+    xmlns:maven="jelly:maven"
+    xmlns:java="java"
+    xmlns:test="test"
+    xmlns:doc="doc"
+    xmlns:u="jelly:util">
 
   <!--
      ========================================================================
@@ -275,7 +275,10 @@
         <j:if test="${context.getVariable('maven.clover.report.swing') == 'true'}">
           <attainGoal name="clover:swing-report-internal"/>
         </j:if>
-        
+        <j:if test="${context.getVariable('maven.clover.report.pdf') == 'true'}">
+          <attainGoal name="clover:pdf-report-internal"/>
+        </j:if> 
+              
       </j:when>
       <j:otherwise>
         <ant:echo>No Clover database found, skipping report generation</ant:echo>
@@ -292,7 +295,7 @@
   <goal name="clover:xml-report-internal">
     <ant:clover-report>
       <ant:current outfile="${maven.build.dir}/clover.xml" 
-      	title="${pom.name} - ${pom.currentVersion}">
+        	title="${pom.name} - ${pom.currentVersion}">
         <ant:format type="xml" orderBy="${maven.clover.orderBy}">
 
           <!-- Add context filtering -->
@@ -305,10 +308,9 @@
       </ant:current>
     </ant:clover-report>
   </goal>
-  <goal 
-    name="clover:xml-report" 
-    description="Generate XML test coverage reports with Clover"
-    prereqs="clover:test,clover:xml-report-internal"/>
+  <goal name="clover:xml-report" 
+      description="Generate XML test coverage reports with Clover"
+      prereqs="clover:test,clover:xml-report-internal"/>
 
   <!--
      ========================================================================
@@ -323,8 +325,8 @@
     <ant:clover-report>
 
       <ant:current 
-      	outfile="${cloverReportDirectory}" 
-      	title="${pom.name} - ${pom.currentVersion}">
+        	outfile="${cloverReportDirectory}" 
+        	title="${pom.name} - ${pom.currentVersion}">
         <ant:format type="html" orderBy="${maven.clover.orderBy}">
 
           <!-- Add context filtering -->
@@ -343,8 +345,8 @@
         <ant:mkdir dir="${cloverHistoryReportDirectory}"/>
       
         <ant:historical outfile="${cloverHistoryReportDirectory}" 
-          historyDir="${maven.clover.history.dir}"
-        	title="${pom.name} - ${pom.currentVersion} - History">
+            historyDir="${maven.clover.history.dir}"
+          	title="${pom.name} - ${pom.currentVersion} - History">
           <ant:format type="html"/>
         </ant:historical>
 
@@ -353,10 +355,9 @@
     </ant:clover-report>
 
   </goal>
-  <goal 
-    name="clover:html-report" 
-    description="Generate HTML test coverage reports with Clover"
-    prereqs="clover:test,clover:html-report-internal"/>
+  <goal name="clover:html-report" 
+      description="Generate HTML test coverage reports with Clover"
+      prereqs="clover:test,clover:html-report-internal"/>
 
   <!--
      ========================================================================
@@ -366,10 +367,56 @@
   <goal name="clover:swing-report-internal">
     <ant:clover-view initString="${clover.initstring}"/>
   </goal>
-  <goal
-    name="clover:swing-report"
-    description="Generate Swing test coverage reports with Clover"
-    prereqs="clover:test,clover:swing-report-internal"/>
+  <goal name="clover:swing-report"
+      description="Generate Swing test coverage reports with Clover"
+      prereqs="clover:test,clover:swing-report-internal"/>
+
+  <!--
+     ========================================================================
+       Generate PDF test coverage report.
+     ========================================================================
+  -->
+  <goal name="clover:pdf-report-internal">
+
+    <j:set var="cloverReportDirectory" value="${maven.docs.dest}/clover"/>
+    <j:set var="cloverPDFReportFile" value="${cloverReportDirectory}/clover.pdf"/>   
+    <ant:mkdir dir="${cloverReportDirectory}"/>
+
+    <ant:clover-report>
+      <ant:current outfile="${cloverPDFReportFile}" 
+          title="${pom.name} - ${pom.currentVersion}" summary="true">
+        <ant:format type="pdf" orderBy="${maven.clover.orderBy}">
+
+          <!-- Add context filtering -->
+          <j:set var="contextFilters" value="${maven.clover.context.method.names} ${maven.clover.context.statement.names} ${maven.clover.context.block.names}"/>
+          <j:if test="${!empty(contextFilters.trim())}">
+            <ant:setProperty name="filter" value="${contextFilters}"/>
+          </j:if>
+
+        </ant:format>
+      </ant:current>
+
+      <!-- Only generate history report if there is at least one history point -->
+      <j:if test="${historyDirAsFile.exists() and !empty(historyDirAsFile.listFiles())}">
+
+        <j:set var="cloverHistoryReportDirectory" value="${maven.docs.dest}/clover/history"/>
+        <j:set var="cloverPDFHistoryReportFile" value="${cloverHistoryReportDirectory}/clover-history.pdf"/>
+        <ant:mkdir dir="${cloverHistoryReportDirectory}"/>
+
+        <ant:historical outfile="${cloverPDFHistoryReportFile}" 
+            historyDir="${maven.clover.history.dir}" 
+            title="${pom.name} - ${pom.currentVersion} - History">
+          <ant:format type="pdf"/>
+        </ant:historical>
+
+      </j:if>
+
+    </ant:clover-report>
+  
+  </goal>
+  <goal name="clover:pdf-report" 
+      description="Generate PDF test coverage reports with Clover" 
+      prereqs="clover:test,clover:pdf-report-internal"/>
 
   <!--
      ========================================================================
diff --git a/clover/plugin.properties b/clover/plugin.properties
index 7707f21a..288aa329 100644
--- a/clover/plugin.properties
+++ b/clover/plugin.properties
@@ -50,6 +50,7 @@ maven.clover.license.path = ${plugin.resources}/clover.license
 maven.clover.report.html = true
 maven.clover.report.xml = false
 maven.clover.report.swing = false
+maven.clover.report.pdf = false
 
 # Decide whether to execute generate Clover data during the site report 
 # generation or not. If false, the plugin will only generate Clover reports
diff --git a/clover/src/plugin-test/testGenerateHistoryReport/maven.xml b/clover/src/plugin-test/testGenerateHistoryReport/maven.xml
index a482c11f..f1b7dd1f 100644
--- a/clover/src/plugin-test/testGenerateHistoryReport/maven.xml
+++ b/clover/src/plugin-test/testGenerateHistoryReport/maven.xml
@@ -34,6 +34,7 @@
 
     <!-- Verifications -->
     <assert:assertFileExists file="${maven.docs.dest}/clover/history/historical.html"/>
+    <assert:assertFileExists file="${maven.docs.dest}/clover/history/clover-history.pdf"/>
 
   </goal>
 
diff --git a/clover/src/plugin-test/testGenerateHistoryReport/project.properties b/clover/src/plugin-test/testGenerateHistoryReport/project.properties
index e7d9c413..c8db14ff 100644
--- a/clover/src/plugin-test/testGenerateHistoryReport/project.properties
+++ b/clover/src/plugin-test/testGenerateHistoryReport/project.properties
@@ -13,3 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # -------------------------------------------------------------------
+
+# Also generate PDF history reports
+maven.clover.report.pdf = true
diff --git a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/maven.xml b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/maven.xml
similarity index 89%
rename from clover/src/plugin-test/testSiteReportAndXmlReportGeneration/maven.xml
rename to clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/maven.xml
index 692bb2d8..70bb51fa 100644
--- a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/maven.xml
+++ b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/maven.xml
@@ -43,11 +43,12 @@
     <!-- Verifications -->
     <assert:assertFileExists file="${maven.docs.dest}/clover/index.html"/>
 
-    <!-- Call report which will generate both the HTML and XML reports -->
+    <!-- Call report which will generate the HTML, XML and PDF reports -->
     <attainGoal name="clover"/>
 
     <!-- Verifications -->
     <assert:assertFileExists file="${maven.build.dir}/clover.xml"/>
+    <assert:assertFileExists file="${maven.docs.dest}/clover/clover.pdf"/>
 
   </goal>
 
diff --git a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/project.properties b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/project.properties
similarity index 93%
rename from clover/src/plugin-test/testSiteReportAndXmlReportGeneration/project.properties
rename to clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/project.properties
index 70385182..4132e4ca 100644
--- a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/project.properties
+++ b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/project.properties
@@ -15,4 +15,6 @@
 # -------------------------------------------------------------------
 
 maven.clover.report.xml = true
+maven.clover.report.pdf = true
+
 maven.clover.instrument.tests = true
diff --git a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/project.xml b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/project.xml
similarity index 87%
rename from clover/src/plugin-test/testSiteReportAndXmlReportGeneration/project.xml
rename to clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/project.xml
index 7474f40e..9aa71600 100644
--- a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/project.xml
+++ b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/project.xml
@@ -20,8 +20,8 @@
 
 <project>
   <extend>${basedir}/../project.xml</extend>
-  <id>testSiteReportAndXmlReportGeneration</id>
-  <name>testSiteReportAndXmlReportGeneration</name>
+  <id>testSiteReportAndGenerationOfDifferentFormats</id>
+  <name>testSiteReportAndGenerationOfDifferentFormats</name>
   <build>
     <sourceDirectory>src/main</sourceDirectory>
     <unitTestSourceDirectory>src/test</unitTestSourceDirectory>
diff --git a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/src/main/org/apache/maven/clover/test/Simple.java b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/src/main/org/apache/maven/clover/test/Simple.java
similarity index 100%
rename from clover/src/plugin-test/testSiteReportAndXmlReportGeneration/src/main/org/apache/maven/clover/test/Simple.java
rename to clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/src/main/org/apache/maven/clover/test/Simple.java
diff --git a/clover/src/plugin-test/testSiteReportAndXmlReportGeneration/src/test/org/apache/maven/clover/test/SimpleTest.java b/clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/src/test/org/apache/maven/clover/test/SimpleTest.java
similarity index 100%
rename from clover/src/plugin-test/testSiteReportAndXmlReportGeneration/src/test/org/apache/maven/clover/test/SimpleTest.java
rename to clover/src/plugin-test/testSiteReportAndGenerationOfDifferentFormats/src/test/org/apache/maven/clover/test/SimpleTest.java
diff --git a/clover/xdocs/changes.xml b/clover/xdocs/changes.xml
index f2fb9ad8..e7367553 100644
--- a/clover/xdocs/changes.xml
+++ b/clover/xdocs/changes.xml
@@ -26,6 +26,9 @@
   </properties>
   <body>
     <release version="1.9-SNAPSHOT" date="in SVN">
+      <action dev="vmassol" type="add" issue="MPCLOVER-31" due-to="Olivier Jacob">
+        Added PDF report generation.
+      </action>
     </release>
     <release version="1.8" date="2005-03-04">
       <action dev="vmassol" type="add">Added support for historical reports by adding a new
diff --git a/clover/xdocs/properties.xml b/clover/xdocs/properties.xml
index 2fe6e0d3..5927490c 100644
--- a/clover/xdocs/properties.xml
+++ b/clover/xdocs/properties.xml
@@ -86,6 +86,16 @@
             <code>false</code>
           </td>
         </tr>
+        <tr>
+          <td>maven.clover.report.pdf</td>
+          <td>Yes</td>
+          <td>
+            Decides whether a PDF report will be generated.
+          </td>
+          <td>
+            <code>false</code>
+          </td>
+        </tr>
         <tr>
           <td>maven.clover.database</td>
           <td>Yes</td>