From b0c2721c22dd03fd4c4fb1579b75f3005afd229b Mon Sep 17 00:00:00 2001
From: Andreas Dangel <adangel@users.sourceforge.net>
Date: Tue, 20 Nov 2012 18:12:42 +0100
Subject: [PATCH] pmd (build): ignore rule definitions without a name in our
 documentation This basically adds the question, how to deal with deprecated
 rule definitions. We should document this, maybe in an own section per
 ruleset.

---
 .../src/main/resources/xslt/rule-format.xsl                | 2 +-
 .../src/main/resources/xslt/rules-index.xsl                | 2 +-
 .../java/net/sourceforge/pmd/maven/PmdPreSiteTest.java     | 7 +++++++
 .../sample-pmd/src/main/resources/rulesets/java/basic.xml  | 2 ++
 4 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/maven-plugin-pmd-build/src/main/resources/xslt/rule-format.xsl b/maven-plugin-pmd-build/src/main/resources/xslt/rule-format.xsl
index e4e764b3d3..8600b45fe9 100644
--- a/maven-plugin-pmd-build/src/main/resources/xslt/rule-format.xsl
+++ b/maven-plugin-pmd-build/src/main/resources/xslt/rule-format.xsl
@@ -33,7 +33,7 @@
 		</document>
 	</xsl:template>
 
-	<xsl:template match="rule">
+	<xsl:template match="rule[@name]">
 		<xsl:variable name="rulename" select="@name"/>
 		<xsl:variable name="classname" select="@class"/>
 
diff --git a/maven-plugin-pmd-build/src/main/resources/xslt/rules-index.xsl b/maven-plugin-pmd-build/src/main/resources/xslt/rules-index.xsl
index 8c7a2c6cd2..0d3e25f72d 100644
--- a/maven-plugin-pmd-build/src/main/resources/xslt/rules-index.xsl
+++ b/maven-plugin-pmd-build/src/main/resources/xslt/rules-index.xsl
@@ -40,7 +40,7 @@
               <subsection>
                 <xsl:attribute name="name"><xsl:value-of select="@name"/> (<xsl:value-of select="$language"/>)</xsl:attribute>
                 <ul>
-                  <xsl:for-each select="./rule">
+                  <xsl:for-each select="./rule[@name]">
                     <li> <xsl:value-of select="@name"/>: <xsl:value-of select="description"/></li>
                   </xsl:for-each>
                 </ul>
diff --git a/maven-plugin-pmd-build/src/test/java/net/sourceforge/pmd/maven/PmdPreSiteTest.java b/maven-plugin-pmd-build/src/test/java/net/sourceforge/pmd/maven/PmdPreSiteTest.java
index a55e120b89..201a19300c 100644
--- a/maven-plugin-pmd-build/src/test/java/net/sourceforge/pmd/maven/PmdPreSiteTest.java
+++ b/maven-plugin-pmd-build/src/test/java/net/sourceforge/pmd/maven/PmdPreSiteTest.java
@@ -5,6 +5,7 @@ import java.io.File;
 import org.apache.commons.io.IOUtils;
 import org.apache.maven.plugin.testing.AbstractMojoTestCase;
 import org.codehaus.plexus.util.FileUtils;
+import org.codehaus.plexus.util.StringUtils;
 import org.junit.Before;
 import org.junit.Test;
 
@@ -34,6 +35,12 @@ public class PmdPreSiteTest extends AbstractMojoTestCase {
 	String codeSizeRuleset = IOUtils.toString(new File("target/unit/sample-pmd/target/generated-xdocs/rules/java/codesize.xml").toURI());
 	assertTrue(codeSizeRuleset.contains("minimum"));
 
+	String basicRuleset = IOUtils.toString(new File("target/unit/sample-pmd/target/generated-xdocs/rules/java/basic.xml").toURI());
+	assertEquals(1, StringUtils.countMatches(basicRuleset, "<subsection"));
+
+	String indexPage = IOUtils.toString(new File("target/unit/sample-pmd/target/generated-xdocs/rules/index.xml").toURI());
+	assertFalse(indexPage.contains("<li>: </li>"));
+
 	String site = IOUtils.toString(new File("target/unit/sample-pmd/src/site/site.xml").toURI());
 	assertTrue(site.contains("<item name=\"Basic\""));
 	assertTrue(site.contains("<item name=\"Code Size\""));
diff --git a/maven-plugin-pmd-build/src/test/resources/sample-pmd/src/main/resources/rulesets/java/basic.xml b/maven-plugin-pmd-build/src/test/resources/sample-pmd/src/main/resources/rulesets/java/basic.xml
index 3f4812f853..d18140d28e 100644
--- a/maven-plugin-pmd-build/src/test/resources/sample-pmd/src/main/resources/rulesets/java/basic.xml
+++ b/maven-plugin-pmd-build/src/test/resources/sample-pmd/src/main/resources/rulesets/java/basic.xml
@@ -47,4 +47,6 @@ public class JumbledIncrementerRule1 {
  ]]>
      </example>
      </rule>
+
+     <rule deprecated="true" ref="rulesets/java/codesize.xml/NPathComplexity"/>
 </ruleset>