hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

pmd (build): ignore rule definitions without a name in our documentation

Browse Source 
This basically adds the question, how to deal with deprecated rule definitions.
We should document this, maybe in an own section per ruleset.
This commit is contained in:
Andreas Dangel
2012-11-20 18:12:42 +01:00
parent bed009c779
commit b0c2721c22
4 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
maven-plugin-pmd-build/src/main/resources/xslt/rule-format.xsl
View File

@@ -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"/>

2
maven-plugin-pmd-build/src/main/resources/xslt/rules-index.xsl
View File

@@ -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>

7
maven-plugin-pmd-build/src/test/java/net/sourceforge/pmd/maven/PmdPreSiteTest.java
View File

@@ -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\""));

2
maven-plugin-pmd-build/src/test/resources/sample-pmd/src/main/resources/rulesets/java/basic.xml
View File

@@ -47,4 +47,6 @@ public class JumbledIncrementerRule1 {
]]>
</example>
</rule>
<rule deprecated="true" ref="rulesets/java/codesize.xml/NPathComplexity"/>
</ruleset>