From fc304bf70cce24359b8fc58f1ca757ccff2e3927 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Sun, 22 Mar 2020 04:32:33 +0100 Subject: [PATCH 01/10] Add XPath version maker --- .../sourceforge/pmd/lang/XPathHandler.java | 9 +++ .../pmd/lang/rule/xpath/XPathVersion.java | 77 +++++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java index 95728185d7..e2f92e8e42 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java @@ -6,6 +6,7 @@ package net.sourceforge.pmd.lang; import org.jaxen.Navigator; +import net.sourceforge.pmd.Rule; import net.sourceforge.pmd.annotation.InternalApi; import net.sourceforge.pmd.lang.xpath.Initializer; @@ -36,16 +37,24 @@ public interface XPathHandler { } }; + Rule newXPathRule() + /** * Initialize. This is intended to be called by {@link Initializer} to * perform Language specific initialization. + * + * @deprecated Jaxen support will be removed in 7.0.0 */ + @Deprecated void initialize(); /** * Initialize. This is intended to be called by {@link Initializer} to * perform Language specific initialization for Saxon. + * + * @deprecated Internal API */ + @Deprecated void initialize(IndependentContext context); /** diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java new file mode 100644 index 0000000000..d1871784b8 --- /dev/null +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java @@ -0,0 +1,77 @@ +/* + * BSD-style license; for more info see http://pmd.sourceforge.net/license.html + */ + +package net.sourceforge.pmd.lang.rule.xpath; + +import java.util.HashMap; +import java.util.Map; + +/** + * Constants for XPath language version used in XPath queries. + */ +public enum XPathVersion { + /** + * XPath 1.0. + * + * @deprecated not supported anymore + */ + @Deprecated + XPATH_1_0("1.0"), + /** + * XPath 1.0 compatibility mode. + * + * @deprecated Not supported any more. + */ + @Deprecated + XPATH_1_0_COMPATIBILITY("1.0 compatibility"), + + /** XPath 2.0. */ + XPATH_2_0("2.0"), + /** XPath 3.1. */ + XPATH_3_1("3.1"); + + private static final Map BY_NAME = new HashMap<>(); + private final String version; + + + static { + for (XPathVersion value : values()) { + BY_NAME.put(value.getXmlName(), value); + } + } + + + XPathVersion(String version) { + this.version = version; + } + + + /** + * Returns the string used to represent the version in the XML. + * + * @return A string representation + */ + public String getXmlName() { + return version; + } + + + /** + * Gets an XPath version from the string used to represent + * it in the XML. + * + * @param version A version string + * + * @return An XPath version + * + * @throws IllegalArgumentException If the argument doesn't match any known version + */ + public static XPathVersion fromString(String version) { + XPathVersion v = BY_NAME.get(version); + if (v == null) { + throw new IllegalArgumentException("Version '" + version + "' is not a valid XPath version"); + } + return v; + } +} From bcf90ceb8ad1ef37af3c0a5c8d10ea4b26392bf5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Sun, 22 Mar 2020 04:36:31 +0100 Subject: [PATCH 02/10] Externalize creator for XPath rule --- .../pmd/lang/apex/ApexHandler.java | 8 --- .../lang/AbstractLanguageVersionHandler.java | 3 +- .../sourceforge/pmd/lang/XPathHandler.java | 52 +++++++++++-------- .../ast/xpath/DefaultASTXPathHandler.java | 9 ++++ .../sourceforge/pmd/lang/rule/XPathRule.java | 50 ++++++++++++++---- .../rule/xpath/AbstractXPathRuleQuery.java | 5 ++ .../lang/rule/xpath/JaxenXPathRuleQuery.java | 5 ++ .../lang/rule/xpath/SaxonXPathRuleQuery.java | 5 ++ .../pmd/lang/rule/xpath/XPathRuleQuery.java | 15 ++++++ .../pmd/lang/rule/xpath/XPathVersion.java | 8 ++- .../lang/ecmascript/Ecmascript3Handler.java | 7 --- .../sourceforge/pmd/lang/jsp/JspHandler.java | 7 --- .../pmd/lang/modelica/ModelicaHandler.java | 6 --- .../pmd/lang/plsql/PLSQLHandler.java | 9 ---- .../sourceforge/pmd/lang/vf/VfHandler.java | 7 --- .../sourceforge/pmd/lang/vm/VmHandler.java | 7 --- .../sourceforge/pmd/lang/xml/XmlHandler.java | 7 --- 17 files changed, 116 insertions(+), 94 deletions(-) diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java index 561ec95e63..00bfdff2d9 100644 --- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java +++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java @@ -12,7 +12,6 @@ import net.sourceforge.pmd.lang.AbstractLanguageVersionHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.apex.ast.ASTMethod; import net.sourceforge.pmd.lang.apex.ast.ASTUserClassOrInterface; import net.sourceforge.pmd.lang.apex.ast.ApexNode; @@ -22,7 +21,6 @@ import net.sourceforge.pmd.lang.apex.metrics.api.ApexClassMetricKey; import net.sourceforge.pmd.lang.apex.metrics.api.ApexOperationMetricKey; import net.sourceforge.pmd.lang.apex.multifile.ApexMultifileVisitorFacade; import net.sourceforge.pmd.lang.apex.rule.ApexRuleViolationFactory; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider; import net.sourceforge.pmd.lang.metrics.internal.AbstractLanguageMetricsProvider; import net.sourceforge.pmd.lang.rule.RuleViolationFactory; @@ -38,12 +36,6 @@ public class ApexHandler extends AbstractLanguageVersionHandler { return rootNode -> new ApexMultifileVisitorFacade().initializeWith((ApexNode) rootNode); } - - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } - @Override public RuleViolationFactory getRuleViolationFactory() { return ApexRuleViolationFactory.INSTANCE; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java index 9fb7fb820f..f28567827b 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java @@ -18,6 +18,7 @@ import net.sourceforge.pmd.util.designerbindings.DesignerBindings; */ public abstract class AbstractLanguageVersionHandler implements LanguageVersionHandler { + @Override public DataFlowHandler getDataFlowHandler() { return DataFlowHandler.DUMMY; @@ -25,7 +26,7 @@ public abstract class AbstractLanguageVersionHandler implements LanguageVersionH @Override public XPathHandler getXPathHandler() { - return XPathHandler.DUMMY; + return XPathHandler.DEFAULT; } @Override diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java index e2f92e8e42..108a473eb5 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java @@ -7,43 +7,53 @@ package net.sourceforge.pmd.lang; import org.jaxen.Navigator; import net.sourceforge.pmd.Rule; -import net.sourceforge.pmd.annotation.InternalApi; +import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; +import net.sourceforge.pmd.lang.rule.XPathRule; +import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; import net.sourceforge.pmd.lang.xpath.Initializer; import net.sf.saxon.sxpath.IndependentContext; /** - * Interface for performing Language specific XPath handling, such as - * initialization and navigation. + * Handles the XPath-specific behaviour of a language. */ -@InternalApi -@Deprecated +// TODO move to rule.xpath package public interface XPathHandler { - XPathHandler DUMMY = new XPathHandler() { - @Override - public void initialize() { - // empty handler - does nothing - } + /** + * @deprecated Use {@link #DEFAULT}. + */ + @Deprecated + XPathHandler DUMMY = new DefaultASTXPathHandler(); - @Override - public void initialize(IndependentContext context) { - // empty handler - does nothing - } + /** + * Default instance. Declares no additional XPath functions. + */ + XPathHandler DEFAULT = new DefaultASTXPathHandler(); - @Override - public Navigator getNavigator() { - return null; - } - }; - Rule newXPathRule() + /** + * Creates a new XPath rule for the given version and expression. + * Note: this isn't used by the ruleset factory for the moment, + * XPath rules are created like normal rules. Programmatic usages + * of {@link XPathRule} should be replaced with calls to this method. + * The ruleset schema will get a new syntax for XPath rules in 7.0.0. + * + * @param version Version of the XPath language + * @param xpathExpression XPath expression + * + * @return A new rule + * + * @throws NullPointerException If any of the arguments is null + */ + Rule newXPathRule(XPathVersion version, String xpathExpression); + /** * Initialize. This is intended to be called by {@link Initializer} to * perform Language specific initialization. * - * @deprecated Jaxen support will be removed in 7.0.0 + * @deprecated Support for Jaxen will be removed come 7.0.0 */ @Deprecated void initialize(); diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java index 974d426e80..9510e04f84 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java @@ -4,7 +4,10 @@ package net.sourceforge.pmd.lang.ast.xpath; +import net.sourceforge.pmd.Rule; import net.sourceforge.pmd.annotation.InternalApi; +import net.sourceforge.pmd.lang.rule.XPathRule; +import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; import net.sf.saxon.sxpath.IndependentContext; @@ -12,6 +15,12 @@ import net.sf.saxon.sxpath.IndependentContext; @Deprecated @InternalApi public class DefaultASTXPathHandler extends AbstractASTXPathHandler { + + @Override + public Rule newXPathRule(XPathVersion version, String xpathExpression) { + return new XPathRule(version, xpathExpression); + } + @Override public void initialize() { // override if needed diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java index 773d64a5c0..f616d9ab66 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java @@ -12,25 +12,29 @@ import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.Objects; import org.apache.commons.lang3.StringUtils; import net.sourceforge.pmd.RuleContext; +import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.lang.rule.xpath.JaxenXPathRuleQuery; import net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery; import net.sourceforge.pmd.lang.rule.xpath.XPathRuleQuery; +import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; import net.sourceforge.pmd.properties.EnumeratedProperty; import net.sourceforge.pmd.properties.StringProperty; /** * Rule that tries to match an XPath expression against a DOM view of an AST. - * - *

This rule needs a "xpath" property value in order to function.

*/ public class XPathRule extends AbstractRule { - // TODO 7.0.0 use PropertyDescriptor + /** + * @deprecated Use {@link XPathHandler#newXPathRule(XPathVersion, String)} + */ + @Deprecated public static final StringProperty XPATH_DESCRIPTOR = StringProperty.named("xpath") .desc("XPath expression") .defaultValue("") @@ -47,7 +51,11 @@ public class XPathRule extends AbstractRule { XPATH_VERSIONS = Collections.unmodifiableMap(tmp); } - // published, can't be converted + + /** + * @deprecated Use {@link XPathHandler#newXPathRule(XPathVersion, String)} + */ + @Deprecated public static final EnumeratedProperty VERSION_DESCRIPTOR = EnumeratedProperty.named("version") .desc("XPath specification version") .mappings(XPATH_VERSIONS) @@ -63,6 +71,8 @@ public class XPathRule extends AbstractRule { /** * Creates a new XPathRule without the corresponding XPath query. + * + * @deprecated Use {@link #XPathRule(XPathVersion, String)} */ public XPathRule() { definePropertyDescriptor(XPATH_DESCRIPTOR); @@ -73,6 +83,8 @@ public class XPathRule extends AbstractRule { /** * Creates a new XPathRule and associates the XPath query. + * + * @deprecated Use {@link #XPathRule(XPathVersion, String)} */ public XPathRule(final String xPath) { this(); @@ -80,21 +92,38 @@ public class XPathRule extends AbstractRule { } /** - * Sets the XPath to query against the desired nodes in {@link #apply(List, RuleContext)}. + * Make a new XPath rule with the given version + expression * - * @param xPath the XPath query + * @param version Version of the XPath language + * @param expression XPath expression + * + * @throws NullPointerException If any of the arguments is null */ + public XPathRule(XPathVersion version, String expression) { + Objects.requireNonNull(version, "XPath version is null"); + Objects.requireNonNull(expression, "XPath expression is null"); + setXPath(expression); + setVersion(version.getXmlName()); + } + + /** + * @deprecated Use the constructor {@link #XPathRule(XPathVersion, String)}, + * don't set the expression after the fact. + */ + @Deprecated public void setXPath(final String xPath) { setProperty(XPathRule.XPATH_DESCRIPTOR, xPath); } + /** + * @deprecated Use the constructor {@link #XPathRule(XPathVersion, String)}, + * don't set the version after the fact. + */ + @Deprecated public void setVersion(final String version) { setProperty(XPathRule.VERSION_DESCRIPTOR, version); } - /** - * Apply the rule to all nodes. - */ @Override public void apply(List nodes, RuleContext ctx) { for (Node node : nodes) { @@ -107,7 +136,10 @@ public class XPathRule extends AbstractRule { * * @param node The Node that to be checked. * @param data The RuleContext. + * + * @deprecated Use {@link #apply(List, RuleContext)} */ + @Deprecated public void evaluate(final Node node, final RuleContext data) { if (xPathRuleQueryNeedsInitialization()) { initXPathRuleQuery(); diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java index 69c6d0afdf..5647fb9ec8 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java @@ -9,12 +9,17 @@ import java.util.List; import java.util.Map; import net.sourceforge.pmd.RuleContext; +import net.sourceforge.pmd.annotation.InternalApi; import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.properties.PropertyDescriptor; /** * This implementation of XPathRuleQuery provides support for RuleChain visits. + * + * @deprecated Internal API */ +@Deprecated +@InternalApi public abstract class AbstractXPathRuleQuery implements XPathRuleQuery { /** diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java index 2ecd213c9a..1e331a7b28 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java @@ -31,12 +31,17 @@ import org.jaxen.expr.XPathFactory; import org.jaxen.saxpath.Axis; import net.sourceforge.pmd.RuleContext; +import net.sourceforge.pmd.annotation.InternalApi; import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.properties.PropertyDescriptor; /** * This is a Jaxen based XPathRule query. + * + * @deprecated Internal API */ +@Deprecated +@InternalApi public class JaxenXPathRuleQuery extends AbstractXPathRuleQuery { private static final Logger LOG = Logger.getLogger(JaxenXPathRuleQuery.class.getName()); diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java index 3f4178a754..231bd0a917 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java @@ -16,6 +16,7 @@ import java.util.logging.Logger; import java.util.regex.Pattern; import net.sourceforge.pmd.RuleContext; +import net.sourceforge.pmd.annotation.InternalApi; import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode; import net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode; @@ -50,7 +51,11 @@ import net.sf.saxon.value.Value; /** * This is a Saxon based XPathRule query. + * + * @deprecated Internal API */ +@Deprecated +@InternalApi public class SaxonXPathRuleQuery extends AbstractXPathRuleQuery { /** * Special nodeName that references the root expression. diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java index dedd90deab..cd1d36c32f 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java @@ -8,6 +8,7 @@ import java.util.List; import java.util.Map; import net.sourceforge.pmd.RuleContext; +import net.sourceforge.pmd.annotation.InternalApi; import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.properties.PropertyDescriptor; @@ -22,24 +23,38 @@ import net.sourceforge.pmd.properties.PropertyDescriptor; * are recommended to manage internal state that is invariant over AST Nodes in * a fashion which facilities high performance (e.g. caching). *

+ * + * @deprecated This will be internalized in 7.0.0. */ +@InternalApi +@Deprecated public interface XPathRuleQuery { /** * XPath 1.0 version. + * + * @deprecated Use {@link XPathVersion} */ + @Deprecated String XPATH_1_0 = "1.0"; /** * XPath 1.0 compatibility version. + * + * @deprecated Use {@link XPathVersion} */ + @Deprecated String XPATH_1_0_COMPATIBILITY = "1.0 compatibility"; /** * XPath 2.0 version. + * + * @deprecated Use {@link XPathVersion} */ + @Deprecated String XPATH_2_0 = "2.0"; + /** * Set the XPath query string to be used. * diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java index d1871784b8..69841ec29b 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java @@ -17,19 +17,17 @@ public enum XPathVersion { * @deprecated not supported anymore */ @Deprecated - XPATH_1_0("1.0"), + XPATH_1_0(XPathRuleQuery.XPATH_1_0), /** * XPath 1.0 compatibility mode. * * @deprecated Not supported any more. */ @Deprecated - XPATH_1_0_COMPATIBILITY("1.0 compatibility"), + XPATH_1_0_COMPATIBILITY(XPathRuleQuery.XPATH_1_0_COMPATIBILITY), /** XPath 2.0. */ - XPATH_2_0("2.0"), - /** XPath 3.1. */ - XPATH_3_1("3.1"); + XPATH_2_0(XPathRuleQuery.XPATH_2_0); private static final Map BY_NAME = new HashMap<>(); private final String version; diff --git a/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/Ecmascript3Handler.java b/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/Ecmascript3Handler.java index c43f3b5255..d27138b7a3 100644 --- a/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/Ecmascript3Handler.java +++ b/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/Ecmascript3Handler.java @@ -10,9 +10,7 @@ import net.sourceforge.pmd.lang.AbstractLanguageVersionHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.ecmascript.ast.DumpFacade; import net.sourceforge.pmd.lang.ecmascript.ast.EcmascriptNode; import net.sourceforge.pmd.lang.ecmascript.rule.EcmascriptRuleViolationFactory; @@ -23,11 +21,6 @@ import net.sourceforge.pmd.lang.rule.RuleViolationFactory; */ public class Ecmascript3Handler extends AbstractLanguageVersionHandler { - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } - @Override public RuleViolationFactory getRuleViolationFactory() { return EcmascriptRuleViolationFactory.INSTANCE; diff --git a/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/JspHandler.java b/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/JspHandler.java index 8c1dd425e5..f1184c8f23 100644 --- a/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/JspHandler.java +++ b/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/JspHandler.java @@ -10,9 +10,7 @@ import net.sourceforge.pmd.lang.AbstractLanguageVersionHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.jsp.ast.DumpFacade; import net.sourceforge.pmd.lang.jsp.ast.JspNode; import net.sourceforge.pmd.lang.jsp.rule.JspRuleViolationFactory; @@ -25,11 +23,6 @@ import net.sourceforge.pmd.lang.rule.RuleViolationFactory; */ public class JspHandler extends AbstractLanguageVersionHandler { - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } - @Override public RuleViolationFactory getRuleViolationFactory() { return JspRuleViolationFactory.INSTANCE; diff --git a/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/ModelicaHandler.java b/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/ModelicaHandler.java index cfb5df5bb0..e7c8dbd823 100644 --- a/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/ModelicaHandler.java +++ b/pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/ModelicaHandler.java @@ -8,19 +8,13 @@ import net.sourceforge.pmd.lang.AbstractLanguageVersionHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.modelica.ast.ASTStoredDefinition; import net.sourceforge.pmd.lang.modelica.resolver.ModelicaSymbolFacade; import net.sourceforge.pmd.lang.modelica.rule.ModelicaRuleViolationFactory; import net.sourceforge.pmd.lang.rule.RuleViolationFactory; public class ModelicaHandler extends AbstractLanguageVersionHandler { - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } @Override public RuleViolationFactory getRuleViolationFactory() { diff --git a/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/PLSQLHandler.java b/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/PLSQLHandler.java index 4d354d1501..369561b835 100644 --- a/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/PLSQLHandler.java +++ b/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/PLSQLHandler.java @@ -11,9 +11,7 @@ import net.sourceforge.pmd.lang.DataFlowHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.dfa.DFAGraphRule; import net.sourceforge.pmd.lang.plsql.ast.ASTInput; import net.sourceforge.pmd.lang.plsql.ast.DumpFacade; @@ -83,11 +81,4 @@ public class PLSQLHandler extends AbstractLanguageVersionHandler { }; } - /** - * Return minimal XPathHandler to cope with Jaxen XPath Rules. - */ - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } } diff --git a/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/VfHandler.java b/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/VfHandler.java index afaf88eedd..e40d90f8ab 100644 --- a/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/VfHandler.java +++ b/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/VfHandler.java @@ -10,9 +10,7 @@ import net.sourceforge.pmd.lang.AbstractLanguageVersionHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.rule.RuleViolationFactory; import net.sourceforge.pmd.lang.vf.ast.DumpFacade; import net.sourceforge.pmd.lang.vf.ast.VfNode; @@ -20,11 +18,6 @@ import net.sourceforge.pmd.lang.vf.rule.VfRuleViolationFactory; public class VfHandler extends AbstractLanguageVersionHandler { - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } - @Override public RuleViolationFactory getRuleViolationFactory() { return VfRuleViolationFactory.INSTANCE; diff --git a/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/VmHandler.java b/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/VmHandler.java index c3cf2a665a..d3f5e54e7c 100644 --- a/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/VmHandler.java +++ b/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/VmHandler.java @@ -10,9 +10,7 @@ import net.sourceforge.pmd.lang.AbstractLanguageVersionHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.rule.RuleViolationFactory; import net.sourceforge.pmd.lang.vm.ast.AbstractVmNode; import net.sourceforge.pmd.lang.vm.rule.VmRuleViolationFactory; @@ -23,11 +21,6 @@ import net.sourceforge.pmd.lang.vm.rule.VmRuleViolationFactory; */ public class VmHandler extends AbstractLanguageVersionHandler { - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } - @Override public RuleViolationFactory getRuleViolationFactory() { return VmRuleViolationFactory.INSTANCE; diff --git a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/XmlHandler.java b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/XmlHandler.java index 921f73f414..0133a20cd0 100644 --- a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/XmlHandler.java +++ b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/XmlHandler.java @@ -10,9 +10,7 @@ import net.sourceforge.pmd.lang.AbstractLanguageVersionHandler; import net.sourceforge.pmd.lang.Parser; import net.sourceforge.pmd.lang.ParserOptions; import net.sourceforge.pmd.lang.VisitorStarter; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; -import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; import net.sourceforge.pmd.lang.rule.RuleViolationFactory; import net.sourceforge.pmd.lang.xml.ast.DumpFacade; import net.sourceforge.pmd.lang.xml.ast.XmlNode; @@ -23,11 +21,6 @@ import net.sourceforge.pmd.lang.xml.rule.XmlRuleViolationFactory; */ public class XmlHandler extends AbstractLanguageVersionHandler { - @Override - public XPathHandler getXPathHandler() { - return new DefaultASTXPathHandler(); - } - @Override public RuleViolationFactory getRuleViolationFactory() { return XmlRuleViolationFactory.INSTANCE; From 8284fc8e816055a9231e32b57e1786124ffcbec3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Sun, 22 Mar 2020 04:55:03 +0100 Subject: [PATCH 03/10] Deprecate two other things --- .../java/net/sourceforge/pmd/lang/rule/ImmutableLanguage.java | 4 ++++ .../src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImmutableLanguage.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImmutableLanguage.java index b71e01d24d..73aeeb4265 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImmutableLanguage.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImmutableLanguage.java @@ -8,6 +8,10 @@ package net.sourceforge.pmd.lang.rule; * This is a tag interface to indicate that a Rule implementation class does not * support changes to it's Language. The Language is integral to the proper * functioning of the Rule. + * + * @deprecated No rule supports a change to their language. This will + * be made the default behaviour with PMD 7.0.0. */ +@Deprecated public interface ImmutableLanguage { } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java index 0cfad63c71..bddcff1f8b 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java @@ -20,7 +20,11 @@ import net.sourceforge.pmd.properties.PropertyFactory; * functional Rule is not needed. For example, during unit testing, or as an * editable surrogate used by IDE plugins. The Language of this Rule defaults to * Java. + * + * @deprecated This is not a supported API. You need the pmd-test module + * on your classpath. This will be removed in 7.0.0 */ +@Deprecated public class MockRule extends AbstractRule { public MockRule() { From 961e78954aac16fc78dd9d16cd0754b0e98eff3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Sun, 22 Mar 2020 05:03:02 +0100 Subject: [PATCH 04/10] Update some tests --- .../pmd/lang/java/rule/XPathRuleTest.java | 41 ++++++++----------- 1 file changed, 18 insertions(+), 23 deletions(-) diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/XPathRuleTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/XPathRuleTest.java index 2a1ca7afa4..a82c36426b 100644 --- a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/XPathRuleTest.java +++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/XPathRuleTest.java @@ -12,7 +12,6 @@ import java.util.HashMap; import java.util.Iterator; import java.util.List; -import org.junit.Before; import org.junit.Test; import net.sourceforge.pmd.PMD; @@ -35,9 +34,9 @@ import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.xpath.JaxenXPathRuleQuery; import net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery; import net.sourceforge.pmd.lang.rule.xpath.XPathRuleQuery; +import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; import net.sourceforge.pmd.properties.PropertyDescriptor; -import net.sourceforge.pmd.properties.StringMultiProperty; -import net.sourceforge.pmd.properties.StringProperty; +import net.sourceforge.pmd.properties.PropertyFactory; import net.sourceforge.pmd.testframework.RuleTst; /** @@ -45,18 +44,16 @@ import net.sourceforge.pmd.testframework.RuleTst; */ public class XPathRuleTest extends RuleTst { - XPathRule rule; - - @Before - public void setUp() { - rule = new XPathRule(); + private XPathRule makeXPath(String expression) { + XPathRule rule = new XPathRule(XPathVersion.XPATH_2_0, expression); rule.setLanguage(LanguageRegistry.getLanguage(JavaLanguageModule.NAME)); rule.setMessage("XPath Rule Failed"); + return rule; } @Test public void testPluginname() throws Exception { - rule.setXPath("//VariableDeclaratorId[string-length(@Image) < 3]"); + XPathRule rule = makeXPath("//VariableDeclaratorId[string-length(@Image) < 3]"); rule.setMessage("{0}"); Report report = getReportForTestString(rule, TEST1); RuleViolation rv = report.iterator().next(); @@ -66,15 +63,14 @@ public class XPathRuleTest extends RuleTst { @Test public void testXPathMultiProperty() throws Exception { - rule.setXPath("//VariableDeclaratorId[@Image=$forbiddenNames]"); + XPathRule rule = makeXPath("//VariableDeclaratorId[@Image=$forbiddenNames]"); rule.setMessage("Avoid vars"); - rule.setVersion(XPathRuleQuery.XPATH_2_0); - StringMultiProperty varDescriptor - = StringMultiProperty.named("forbiddenNames") - .desc("Forbidden names") - .defaultValues("forbid1", "forbid2") - .delim('$') - .build(); + PropertyDescriptor> varDescriptor + = PropertyFactory.stringListProperty("forbiddenNames") + .desc("Forbidden names") + .defaultValues("forbid1", "forbid2") + .delim('$') + .build(); rule.definePropertyDescriptor(varDescriptor); @@ -90,9 +86,10 @@ public class XPathRuleTest extends RuleTst { @Test public void testVariables() throws Exception { - rule.setXPath("//VariableDeclaratorId[@Image=$var]"); + XPathRule rule = makeXPath("//VariableDeclaratorId[@Image=$var]"); rule.setMessage("Avoid vars"); - StringProperty varDescriptor = new StringProperty("var", "Test var", null, 1.0f); + PropertyDescriptor varDescriptor = + PropertyFactory.stringProperty("var").desc("Test var").defaultValue("").build(); rule.definePropertyDescriptor(varDescriptor); rule.setProperty(varDescriptor, "fiddle"); Report report = getReportForTestString(rule, TEST2); @@ -102,8 +99,7 @@ public class XPathRuleTest extends RuleTst { @Test public void testFnPrefixOnSaxon() throws Exception { - rule.setXPath("//VariableDeclaratorId[fn:matches(@Image, 'fiddle')]"); - rule.setVersion(XPathRuleQuery.XPATH_2_0); + XPathRule rule = makeXPath("//VariableDeclaratorId[fn:matches(@Image, 'fiddle')]"); Report report = getReportForTestString(rule, TEST2); RuleViolation rv = report.iterator().next(); assertEquals(3, rv.getBeginLine()); @@ -111,8 +107,7 @@ public class XPathRuleTest extends RuleTst { @Test public void testNoFnPrefixOnSaxon() throws Exception { - rule.setXPath("//VariableDeclaratorId[matches(@Image, 'fiddle')]"); - rule.setVersion(XPathRuleQuery.XPATH_2_0); + XPathRule rule = makeXPath("//VariableDeclaratorId[matches(@Image, 'fiddle')]"); Report report = getReportForTestString(rule, TEST2); RuleViolation rv = report.iterator().next(); assertEquals(3, rv.getBeginLine()); From 5067c79eb28c74691cacee0124468a740505919f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Sun, 22 Mar 2020 05:07:23 +0100 Subject: [PATCH 05/10] Cleanup a test --- .../sourceforge/pmd/lang/rule/MockRule.java | 3 +- .../pmd/lang/rule/xpath/XPathVersion.java | 10 ++--- .../xpath/XPathMetricFunctionTest.java | 4 +- .../pmd/lang/plsql/PLSQLXPathRuleTest.java | 37 ++++++++----------- .../pmd/lang/scala/rule/XPathRuleTest.java | 24 +++++------- 5 files changed, 32 insertions(+), 46 deletions(-) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java index bddcff1f8b..5318030a02 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java @@ -22,7 +22,8 @@ import net.sourceforge.pmd.properties.PropertyFactory; * Java. * * @deprecated This is not a supported API. You need the pmd-test module - * on your classpath. This will be removed in 7.0.0 + * on your classpath, or pmd-core's test sources. This will be removed + * in 7.0.0 */ @Deprecated public class MockRule extends AbstractRule { diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java index 69841ec29b..4ff10ee7c4 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java @@ -63,13 +63,9 @@ public enum XPathVersion { * * @return An XPath version * - * @throws IllegalArgumentException If the argument doesn't match any known version + * @return Null if the argument is not a valid version */ - public static XPathVersion fromString(String version) { - XPathVersion v = BY_NAME.get(version); - if (v == null) { - throw new IllegalArgumentException("Version '" + version + "' is not a valid XPath version"); - } - return v; + public static XPathVersion ofId(String version) { + return BY_NAME.get(version); } } diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java index 48d4c672ec..b48404ef99 100644 --- a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java +++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java @@ -26,6 +26,7 @@ import net.sourceforge.pmd.lang.LanguageRegistry; import net.sourceforge.pmd.lang.java.JavaLanguageModule; import net.sourceforge.pmd.lang.java.xpath.MetricFunction; import net.sourceforge.pmd.lang.rule.XPathRule; +import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; /** * @author Clément Fournier @@ -40,8 +41,7 @@ public class XPathMetricFunctionTest { private Rule makeXpathRuleFromXPath(String xpath) { - XPathRule rule = new XPathRule(); - rule.setXPath(xpath); + XPathRule rule = new XPathRule(XPathVersion.XPATH_2_0, xpath); rule.setMessage(VIOLATION_MESSAGE); rule.setLanguage(LanguageRegistry.getLanguage(JavaLanguageModule.NAME)); return rule; diff --git a/pmd-plsql/src/test/java/net/sourceforge/pmd/lang/plsql/PLSQLXPathRuleTest.java b/pmd-plsql/src/test/java/net/sourceforge/pmd/lang/plsql/PLSQLXPathRuleTest.java index 094edb08f4..7dd9c46395 100644 --- a/pmd-plsql/src/test/java/net/sourceforge/pmd/lang/plsql/PLSQLXPathRuleTest.java +++ b/pmd-plsql/src/test/java/net/sourceforge/pmd/lang/plsql/PLSQLXPathRuleTest.java @@ -4,7 +4,7 @@ package net.sourceforge.pmd.lang.plsql; -import java.util.Arrays; +import static java.util.Collections.singletonList; import org.junit.Assert; import org.junit.Test; @@ -13,21 +13,19 @@ import net.sourceforge.pmd.RuleContext; import net.sourceforge.pmd.lang.LanguageRegistry; import net.sourceforge.pmd.lang.plsql.ast.ASTInput; import net.sourceforge.pmd.lang.rule.XPathRule; +import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; /** * Tests to use XPath rules with PLSQL. */ public class PLSQLXPathRuleTest extends AbstractPLSQLParserTst { - private ASTInput node = plsql.parse( + private final ASTInput node = plsql.parse( "create or replace\n" + "package pkg_xpath_problem\n" + "AS\n" + " PROCEDURE pkg_minimal\n" + " IS\n" + " a_variable VARCHAR2(1);\n" + " BEGIN \n" + " --PRAGMA INLINE(output,'YES');\n" + " a_variable := 'Y' ;\n" + " END ;\n" + "end pkg_xpath_problem;\n" + "/\n" + ""); - private RuleContext ctx = new RuleContext(); - public PLSQLXPathRuleTest() { - ctx.setLanguageVersion(plsql.getDefaultVersion()); } /** @@ -35,10 +33,7 @@ public class PLSQLXPathRuleTest extends AbstractPLSQLParserTst { */ @Test public void testXPathRule1() { - XPathRule rule = createRule("1.0"); - - rule.apply(Arrays.asList(node), ctx); - Assert.assertEquals(2, ctx.getReport().treeSize()); + testOnVersion(XPathVersion.XPATH_1_0); } /** @@ -46,10 +41,7 @@ public class PLSQLXPathRuleTest extends AbstractPLSQLParserTst { */ @Test public void testXPathRule1Compatibility() { - XPathRule rule = createRule("1.0 compatibility"); - - rule.apply(Arrays.asList(node), ctx); - Assert.assertEquals(2, ctx.getReport().treeSize()); + testOnVersion(XPathVersion.XPATH_1_0_COMPATIBILITY); } /** @@ -57,18 +49,21 @@ public class PLSQLXPathRuleTest extends AbstractPLSQLParserTst { */ @Test public void testXPathRule2() { - XPathRule rule = createRule("2.0"); - - rule.apply(Arrays.asList(node), ctx); - Assert.assertEquals(2, ctx.getReport().treeSize()); + testOnVersion(XPathVersion.XPATH_2_0); } - private XPathRule createRule(String version) { - XPathRule rule = new XPathRule("//PrimaryPrefix"); + + private void testOnVersion(XPathVersion xpath10) { + XPathRule rule = new XPathRule(xpath10, "//PrimaryPrefix"); rule.setLanguage(LanguageRegistry.getLanguage(PLSQLLanguageModule.NAME)); - rule.setVersion(version); rule.setMessage("Test Violation"); - return rule; + + RuleContext ctx = new RuleContext(); + ctx.setLanguageVersion(plsql.getDefaultVersion()); + + rule.apply(singletonList(node), ctx); + Assert.assertEquals(2, ctx.getReport().size()); } + } diff --git a/pmd-scala/src/test/java/net/sourceforge/pmd/lang/scala/rule/XPathRuleTest.java b/pmd-scala/src/test/java/net/sourceforge/pmd/lang/scala/rule/XPathRuleTest.java index aefa9ee487..d8bca517d9 100644 --- a/pmd-scala/src/test/java/net/sourceforge/pmd/lang/scala/rule/XPathRuleTest.java +++ b/pmd-scala/src/test/java/net/sourceforge/pmd/lang/scala/rule/XPathRuleTest.java @@ -6,14 +6,13 @@ package net.sourceforge.pmd.lang.scala.rule; import static org.junit.Assert.assertEquals; -import org.junit.Before; import org.junit.Test; import net.sourceforge.pmd.Report; import net.sourceforge.pmd.RuleViolation; import net.sourceforge.pmd.lang.LanguageRegistry; import net.sourceforge.pmd.lang.rule.XPathRule; -import net.sourceforge.pmd.lang.rule.xpath.XPathRuleQuery; +import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; import net.sourceforge.pmd.lang.scala.ScalaLanguageModule; import net.sourceforge.pmd.lang.scala.ast.BaseScalaTest; @@ -21,22 +20,17 @@ public class XPathRuleTest extends BaseScalaTest { private static final String SCALA_TEST = "/parserFiles/helloworld.scala"; - XPathRule rule; - - @Before - public void setUp() { - rule = new XPathRule(); - rule.setLanguage(LanguageRegistry.getLanguage(ScalaLanguageModule.NAME)); - rule.setMessage("XPath Rule Failed"); - } - @Test public void testPrintHelloWorld() { - String xpath = "//TermApply/TermName[@Image=\"println\"]"; - rule.setXPath(xpath); - rule.setVersion(XPathRuleQuery.XPATH_2_0); - Report report = scala.getReportForResource(rule, SCALA_TEST); + Report report = evaluate(SCALA_TEST, "//TermApply/TermName[@Image=\"println\"]"); RuleViolation rv = report.iterator().next(); assertEquals(2, rv.getBeginLine()); } + + private Report evaluate(String testSource, String xpath) { + XPathRule rule = new XPathRule(XPathVersion.XPATH_2_0, xpath); + rule.setLanguage(LanguageRegistry.getLanguage(ScalaLanguageModule.NAME)); + rule.setMessage("XPath Rule Failed"); + return scala.getReportForResource(rule, testSource); + } } From 1de1d1c66daf9e34947ad7f494a0f50c800d03c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Wed, 8 Apr 2020 21:59:41 +0200 Subject: [PATCH 06/10] Update some usages early --- .../net/sourceforge/pmd/RuleSetFactory.java | 2 +- .../sourceforge/pmd/lang/rule/XPathRule.java | 46 +++++++++++++------ .../pmd/lang/rule/xpath/XPathVersion.java | 9 ++-- .../pmd/docs/RuleDocGenerator.java | 14 +++++- 4 files changed, 50 insertions(+), 21 deletions(-) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java index a9229d480f..4603f6f727 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java @@ -305,7 +305,7 @@ public class RuleSetFactory { public RuleSet createSingleRuleRuleSet(final Rule rule) { // TODO make static? final long checksum; if (rule instanceof XPathRule) { - checksum = rule.getProperty(XPathRule.XPATH_DESCRIPTOR).hashCode(); + checksum = ((XPathRule) rule).getXPathExpression().hashCode(); } else { // TODO : Is this good enough? all properties' values + rule name checksum = rule.getPropertiesByPropertyDescriptor().values().hashCode() * 31 + rule.getName().hashCode(); diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java index f616d9ab66..f6a36b903f 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java @@ -106,6 +106,21 @@ public class XPathRule extends AbstractRule { setVersion(version.getXmlName()); } + /** + * Returns the version for this rule. Returns null if this is not + * set or invalid. + */ + public XPathVersion getVersion() { + return XPathVersion.ofId(getProperty(VERSION_DESCRIPTOR)); + } + + /** + * Returns the XPath expression that implements this rule. + */ + public String getXPathExpression() { + return getProperty(XPATH_DESCRIPTOR); + } + /** * @deprecated Use the constructor {@link #XPathRule(XPathVersion, String)}, * don't set the expression after the fact. @@ -156,13 +171,21 @@ public class XPathRule extends AbstractRule { * engine in which the query will be run it looks at the XPath version. */ private void initXPathRuleQuery() { - String xpath = getProperty(XPATH_DESCRIPTOR); - String version = getProperty(VERSION_DESCRIPTOR); + String xpath = getXPathExpression(); + XPathVersion version = getVersion(); - initRuleQueryBasedOnVersion(version); + if (version == null) { + throw new IllegalStateException("Invalid XPath version, should have been caught by Rule::dysfunctionReason"); + } + + if (version.equals(XPathVersion.XPATH_1_0)) { + xpathRuleQuery = new JaxenXPathRuleQuery(); + } else { + xpathRuleQuery = new SaxonXPathRuleQuery(); + } xpathRuleQuery.setXPath(xpath); - xpathRuleQuery.setVersion(version); + xpathRuleQuery.setVersion(version.getXmlName()); xpathRuleQuery.setProperties(getPropertiesByPropertyDescriptor()); } @@ -175,10 +198,6 @@ public class XPathRule extends AbstractRule { return xpathRuleQuery == null; } - private void initRuleQueryBasedOnVersion(final String version) { - xpathRuleQuery = XPATH_1_0.equals(version) ? new JaxenXPathRuleQuery() : new SaxonXPathRuleQuery(); - } - @Override public List getRuleChainVisits() { if (xPathRuleQueryNeedsInitialization()) { @@ -193,10 +212,11 @@ public class XPathRule extends AbstractRule { @Override public String dysfunctionReason() { - return hasXPathExpression() ? null : "Missing xPath expression"; - } - - private boolean hasXPathExpression() { - return StringUtils.isNotBlank(getProperty(XPATH_DESCRIPTOR)); + if (getVersion() == null) { + return "Invalid XPath version '" + getProperty(VERSION_DESCRIPTOR) + "'"; + } else if (StringUtils.isBlank(getXPathExpression())) { + return "Missing XPath expression"; + } + return null; } } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java index 4ff10ee7c4..7177afa443 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathVersion.java @@ -14,14 +14,15 @@ public enum XPathVersion { /** * XPath 1.0. * - * @deprecated not supported anymore + * @deprecated Will become unsupported in 7.0.0 */ @Deprecated XPATH_1_0(XPathRuleQuery.XPATH_1_0), + /** * XPath 1.0 compatibility mode. * - * @deprecated Not supported any more. + * @deprecated Will become unsupported in 7.0.0 */ @Deprecated XPATH_1_0_COMPATIBILITY(XPathRuleQuery.XPATH_1_0_COMPATIBILITY), @@ -61,9 +62,7 @@ public enum XPathVersion { * * @param version A version string * - * @return An XPath version - * - * @return Null if the argument is not a valid version + * @return An XPath version, or null if the argument is not a valid version */ public static XPathVersion ofId(String version) { return BY_NAME.get(version); diff --git a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java index 4d1ffa2dee..e0e6c2511f 100644 --- a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java +++ b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/RuleDocGenerator.java @@ -405,10 +405,11 @@ public class RuleDocGenerator { lines.addAll(EscapeUtils.escapeLines(toLines(stripIndentation(rule.getDescription())))); lines.add(""); - if (rule instanceof XPathRule || rule instanceof RuleReference && ((RuleReference) rule).getRule() instanceof XPathRule) { + XPathRule xpathRule = asXPathRule(rule); + if (xpathRule != null) { lines.add("**This rule is defined by the following XPath expression:**"); lines.add("``` xpath"); - lines.addAll(toLines(StringUtils.stripToEmpty(rule.getProperty(XPathRule.XPATH_DESCRIPTOR)))); + lines.addAll(toLines(StringUtils.stripToEmpty(xpathRule.getXPathExpression()))); lines.add("```"); } else { lines.add("**This rule is defined by the following Java class:** " @@ -502,6 +503,15 @@ public class RuleDocGenerator { } } + private XPathRule asXPathRule(Rule rule) { + if (rule instanceof XPathRule) { + return (XPathRule) rule; + } else if (rule instanceof RuleReference && ((RuleReference) rule).getRule() instanceof XPathRule) { + return (XPathRule) ((RuleReference) rule).getRule(); + } + return null; + } + private static boolean isDeprecated(PropertyDescriptor propertyDescriptor) { return propertyDescriptor.description() != null && propertyDescriptor.description().toLowerCase(Locale.ROOT).startsWith(DEPRECATED_RULE_PROPERTY_MARKER); From 60087590e65d4ec1859a7ea7f940f7d4fb94b29c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Wed, 8 Apr 2020 22:05:42 +0200 Subject: [PATCH 07/10] Remove changes to XPathHandler --- .../lang/AbstractLanguageVersionHandler.java | 2 +- .../sourceforge/pmd/lang/XPathHandler.java | 43 +++---------------- .../ast/xpath/AbstractASTXPathHandler.java | 10 +++++ .../ast/xpath/DefaultASTXPathHandler.java | 8 ---- .../sourceforge/pmd/lang/rule/XPathRule.java | 5 +-- 5 files changed, 18 insertions(+), 50 deletions(-) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java index f28567827b..634e00fe24 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java @@ -26,7 +26,7 @@ public abstract class AbstractLanguageVersionHandler implements LanguageVersionH @Override public XPathHandler getXPathHandler() { - return XPathHandler.DEFAULT; + return XPathHandler.DUMMY; } @Override diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java index 108a473eb5..2895550346 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java @@ -6,65 +6,32 @@ package net.sourceforge.pmd.lang; import org.jaxen.Navigator; -import net.sourceforge.pmd.Rule; +import net.sourceforge.pmd.annotation.InternalApi; import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler; -import net.sourceforge.pmd.lang.rule.XPathRule; -import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; import net.sourceforge.pmd.lang.xpath.Initializer; import net.sf.saxon.sxpath.IndependentContext; /** - * Handles the XPath-specific behaviour of a language. + * Interface for performing Language specific XPath handling, such as + * initialization and navigation. */ -// TODO move to rule.xpath package +@InternalApi +@Deprecated public interface XPathHandler { - /** - * @deprecated Use {@link #DEFAULT}. - */ - @Deprecated XPathHandler DUMMY = new DefaultASTXPathHandler(); - /** - * Default instance. Declares no additional XPath functions. - */ - XPathHandler DEFAULT = new DefaultASTXPathHandler(); - - - /** - * Creates a new XPath rule for the given version and expression. - * Note: this isn't used by the ruleset factory for the moment, - * XPath rules are created like normal rules. Programmatic usages - * of {@link XPathRule} should be replaced with calls to this method. - * The ruleset schema will get a new syntax for XPath rules in 7.0.0. - * - * @param version Version of the XPath language - * @param xpathExpression XPath expression - * - * @return A new rule - * - * @throws NullPointerException If any of the arguments is null - */ - Rule newXPathRule(XPathVersion version, String xpathExpression); - - /** * Initialize. This is intended to be called by {@link Initializer} to * perform Language specific initialization. - * - * @deprecated Support for Jaxen will be removed come 7.0.0 */ - @Deprecated void initialize(); /** * Initialize. This is intended to be called by {@link Initializer} to * perform Language specific initialization for Saxon. - * - * @deprecated Internal API */ - @Deprecated void initialize(IndependentContext context); /** diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java index f4c1e8ddbe..eb470c94bd 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java @@ -25,4 +25,14 @@ public abstract class AbstractASTXPathHandler implements XPathHandler { public void initialize(IndependentContext context, Language language, Class functionsClass) { context.declareNamespace("pmd-" + language.getTerseName(), "java:" + functionsClass.getName()); } + + @Override + public void initialize() { + // override if needed + } + + @Override + public void initialize(IndependentContext context) { + // override if needed + } } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java index 9510e04f84..3fa844f28a 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java @@ -4,10 +4,7 @@ package net.sourceforge.pmd.lang.ast.xpath; -import net.sourceforge.pmd.Rule; import net.sourceforge.pmd.annotation.InternalApi; -import net.sourceforge.pmd.lang.rule.XPathRule; -import net.sourceforge.pmd.lang.rule.xpath.XPathVersion; import net.sf.saxon.sxpath.IndependentContext; @@ -16,11 +13,6 @@ import net.sf.saxon.sxpath.IndependentContext; @InternalApi public class DefaultASTXPathHandler extends AbstractASTXPathHandler { - @Override - public Rule newXPathRule(XPathVersion version, String xpathExpression) { - return new XPathRule(version, xpathExpression); - } - @Override public void initialize() { // override if needed diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java index f6a36b903f..25451cd860 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java @@ -17,7 +17,6 @@ import java.util.Objects; import org.apache.commons.lang3.StringUtils; import net.sourceforge.pmd.RuleContext; -import net.sourceforge.pmd.lang.XPathHandler; import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.lang.rule.xpath.JaxenXPathRuleQuery; import net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery; @@ -32,7 +31,7 @@ import net.sourceforge.pmd.properties.StringProperty; public class XPathRule extends AbstractRule { /** - * @deprecated Use {@link XPathHandler#newXPathRule(XPathVersion, String)} + * @deprecated Use {@link #XPathRule(XPathVersion, String)} */ @Deprecated public static final StringProperty XPATH_DESCRIPTOR = StringProperty.named("xpath") @@ -53,7 +52,7 @@ public class XPathRule extends AbstractRule { /** - * @deprecated Use {@link XPathHandler#newXPathRule(XPathVersion, String)} + * @deprecated Use {@link #XPathRule(XPathVersion, String)} */ @Deprecated public static final EnumeratedProperty VERSION_DESCRIPTOR = EnumeratedProperty.named("version") From 60d443963c82d360d5a6169bba02bc0938ee1d7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Thu, 9 Apr 2020 15:28:20 +0200 Subject: [PATCH 08/10] Call default ctor Defines properties --- .../src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java | 1 + .../pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java index 25451cd860..18dff8fab3 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java @@ -99,6 +99,7 @@ public class XPathRule extends AbstractRule { * @throws NullPointerException If any of the arguments is null */ public XPathRule(XPathVersion version, String expression) { + this(); Objects.requireNonNull(version, "XPath version is null"); Objects.requireNonNull(expression, "XPath expression is null"); setXPath(expression); diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java index b48404ef99..10f37ebcb9 100644 --- a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java +++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/xpath/XPathMetricFunctionTest.java @@ -41,7 +41,7 @@ public class XPathMetricFunctionTest { private Rule makeXpathRuleFromXPath(String xpath) { - XPathRule rule = new XPathRule(XPathVersion.XPATH_2_0, xpath); + XPathRule rule = new XPathRule(XPathVersion.XPATH_1_0, xpath); rule.setMessage(VIOLATION_MESSAGE); rule.setLanguage(LanguageRegistry.getLanguage(JavaLanguageModule.NAME)); return rule; From 5c31d40ec274ed7b1b19f02960bcd621b2849c69 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Mon, 13 Apr 2020 12:16:55 +0200 Subject: [PATCH 09/10] [core] XPathRule: use == for enum comparison --- .../src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java index 18dff8fab3..d2c438a6df 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java @@ -178,7 +178,7 @@ public class XPathRule extends AbstractRule { throw new IllegalStateException("Invalid XPath version, should have been caught by Rule::dysfunctionReason"); } - if (version.equals(XPathVersion.XPATH_1_0)) { + if (version == XPathVersion.XPATH_1_0) { xpathRuleQuery = new JaxenXPathRuleQuery(); } else { xpathRuleQuery = new SaxonXPathRuleQuery(); From 161af4dfd32a53f0f090c5dc6a25c7819f97ebb1 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Mon, 13 Apr 2020 12:17:13 +0200 Subject: [PATCH 10/10] [doc] Update release notes with deprecations, see #2407 --- docs/pages/release_notes.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index 12d545d173..bd68d803c1 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -64,6 +64,11 @@ Note that XPath 1.0 support, the default XPath version, is deprecated since PMD Those APIs are not intended to be used by clients, and will be hidden or removed with PMD 7.0.0. You can identify them with the `@InternalApi` annotation. You'll also get a deprecation warning. +* {% jdoc core::lang.rule.xpath.AbstractXPathRuleQuery %} +* {% jdoc core::lang.rule.xpath.JaxenXPathRuleQuery %} +* {% jdoc core::lang.rule.xpath.SaxonXPathRuleQuery %} +* {% jdoc core::lang.rule.xpath.XPathRuleQuery %} + ##### In ASTs As part of the changes we'd like to do to AST classes for 7.0.0, we would like to @@ -119,6 +124,9 @@ implementations, and their corresponding Parser if it exists (in the same packag * {% jdoc !!core::lang.TokenManager#setFileName(java.lang.String) %} * {% jdoc !!core::lang.ast.AbstractTokenManager#setFileName(java.lang.String) %} * {% jdoc !!core::lang.ast.AbstractTokenManager#getFileName(java.lang.String) %} +* {% jdoc core::lang.rule.ImmutableLanguage %} +* {% jdoc core::lang.rule.MockRule %} +* Multiple fields, constructors and methods in {% jdoc core::lang.rule.XPathRule %}. See javadoc for details. ### External Contributions