From adfd3963a09c899ef08788cfb774d5bf32a9f1e8 Mon Sep 17 00:00:00 2001
From: Andreas Dangel <andreas.dangel@pmd-code.org>
Date: Fri, 5 Jan 2024 16:48:29 +0100
Subject: [PATCH] [xml] Avoid using @Image - added new attribute @Text

---
 .../lang/xml/ast/internal/XmlNodeWrapper.java | 12 ++--
 .../lang/xml/ast/internal/XmlParserImpl.java  |  8 ---
 .../pmd/lang/xml/rule/DomXPathRule.java       |  4 +-
 .../resources/category/pom/errorprone.xml     |  8 +--
 .../resources/category/xml/errorprone.xml     |  2 +-
 .../pmd/lang/xml/ast/testdata/bug1518.txt     | 62 +++++++++----------
 .../pmd/lang/xml/ast/testdata/sampleXml.txt   | 16 ++---
 7 files changed, 50 insertions(+), 62 deletions(-)

diff --git a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlNodeWrapper.java b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlNodeWrapper.java
index 93817548fa..7b471fc70a 100644
--- a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlNodeWrapper.java
+++ b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlNodeWrapper.java
@@ -11,7 +11,6 @@ import java.util.AbstractList;
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
-import java.util.Objects;
 
 import org.w3c.dom.NamedNodeMap;
 import org.w3c.dom.Node;
@@ -96,16 +95,13 @@ class XmlNodeWrapper implements XmlNode {
         return node.hasChildNodes() ? node.getChildNodes().getLength() : 0;
     }
 
-    @Override
-    public String getImage() {
+    /**
+     * Returns the text, if the underlying node is a text node.
+     */
+    public String getText() {
         return node instanceof Text ? ((Text) node).getData() : null;
     }
 
-    @Override
-    public boolean hasImageEqualTo(String image) {
-        return Objects.equals(image, getImage());
-    }
-
     @Override
     public boolean isFindBoundary() {
         return false;
diff --git a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlParserImpl.java b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlParserImpl.java
index f307ed97af..14c8886bba 100644
--- a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlParserImpl.java
+++ b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/internal/XmlParserImpl.java
@@ -25,7 +25,6 @@ import net.sourceforge.pmd.lang.ast.ParseException;
 import net.sourceforge.pmd.lang.ast.Parser.ParserTask;
 import net.sourceforge.pmd.lang.ast.RootNode;
 import net.sourceforge.pmd.lang.rule.xpath.Attribute;
-import net.sourceforge.pmd.lang.rule.xpath.NoAttribute;
 import net.sourceforge.pmd.lang.rule.xpath.impl.AttributeAxisIterator;
 import net.sourceforge.pmd.lang.xml.ast.XmlNode;
 
@@ -125,13 +124,6 @@ public final class XmlParserImpl {
             return getNode().getXmlVersion();
         }
 
-        // Hide the image attribute
-        @NoAttribute
-        @Override
-        public String getImage() {
-            return super.getImage();
-        }
-        
         @Override
         public Iterator<Attribute> getXPathAttributesIterator() {
             // Expose this node's attributes through reflection
diff --git a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/DomXPathRule.java b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/DomXPathRule.java
index ce2df9d9de..31754643d9 100644
--- a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/DomXPathRule.java
+++ b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/DomXPathRule.java
@@ -31,10 +31,10 @@ import net.sourceforge.pmd.properties.PropertyFactory;
  * <ul>
  * <li>{@link XPathRule} uses <i>elements</i> to represent text nodes.
  * This is contrary to the XPath spec, in which element and text nodes
- * are different kinds of nodes. To replace the query {@code //elt/text[@Image="abc"]},
+ * are different kinds of nodes. To replace the query {@code //elt/text[@Text="abc"]},
  * use the XPath function {@code text()}, eg {@code //elt[text()="abc"]}.
  * <li>{@link XPathRule} adds additional attributes to each element
- * (eg {@code @BeginLine} and {@code @Image}). These attributes are not
+ * (eg {@code @BeginLine} and {@code @Text}). These attributes are not
  * XML attributes, so they are not accessible using DomXPathRule rule.
  * Instead, use the XPath functions {@code pmd:startLine(node)}, {@code pmd:endLine(node)} and related.
  * For instance, replace {@code //elt[@EndLine - @BeginLine > 10]} with
diff --git a/pmd-xml/src/main/resources/category/pom/errorprone.xml b/pmd-xml/src/main/resources/category/pom/errorprone.xml
index f4f3993cde..6e09df3d62 100644
--- a/pmd-xml/src/main/resources/category/pom/errorprone.xml
+++ b/pmd-xml/src/main/resources/category/pom/errorprone.xml
@@ -26,7 +26,7 @@ The following types are considered valid: pom, jar, maven-plugin, ejb, war, ear,
             <property name="xpath">
                 <value>
 <![CDATA[
-//dependencyManagement/dependency/type/text[not(@Image = $validTypes)]
+//dependencyManagement/dependency/type/text[not(@Text = $validTypes)]
 ]]>
                 </value>
             </property>
@@ -71,11 +71,11 @@ By far the most common problem is the use of \${project.version} in a BOM or par
                 <value>
 <![CDATA[
 //dependencies/dependency
-    [contains(version/text/@Image,'{project.version}')]
+    [contains(version/text/@Text,'{project.version}')]
     [
-        (/document/project/parent/groupId and groupId/text/@Image != /document/project/parent/groupId/text/@Image)
+        (/document/project/parent/groupId and groupId/text/@Text != /document/project/parent/groupId/text/@Text)
         or
-        (/document/project/groupId and groupId/text/@Image != /document/project/groupId/text/@Image)
+        (/document/project/groupId and groupId/text/@Text != /document/project/groupId/text/@Text)
     ]/version
 ]]>
                 </value>
diff --git a/pmd-xml/src/main/resources/category/xml/errorprone.xml b/pmd-xml/src/main/resources/category/xml/errorprone.xml
index c07912ff5b..b0bd2e0074 100644
--- a/pmd-xml/src/main/resources/category/xml/errorprone.xml
+++ b/pmd-xml/src/main/resources/category/xml/errorprone.xml
@@ -23,7 +23,7 @@ An XML CDATA section begins with a &lt;![CDATA[ marker, which has only one [, an
             <property name="xpath">
                 <value>
 <![CDATA[
-//cdata-section[starts-with(@Image,'[') or ends-with(@Image,']')]
+//cdata-section[starts-with(@Text,'[') or ends-with(@Text,']')]
 ]]>
                 </value>
             </property>
diff --git a/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/bug1518.txt b/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/bug1518.txt
index 21f24c5545..2d74e25d2c 100644
--- a/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/bug1518.txt
+++ b/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/bug1518.txt
@@ -1,48 +1,48 @@
 +- document[@XmlEncoding = "UTF-8", @XmlStandalone = false, @XmlVersion = "1.0"]
    +- deployment-plan[@global-variables = "false", @xmlns = "http://xmlns.oracle.com/weblogic/deployment-plan", @xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance", @xsi:schemaLocation = "http://xmlns.oracle.com/weblogic/deployment-plan http://xmlns.oracle.com/weblogic/deployment-plan/1.0/deployment-plan.xsd"]
-      +- text[@Image = "\n    "]
+      +- text[@Text = "\n    "]
       +- application-name[]
-      |  +- text[@Image = "app"]
-      +- text[@Image = "\n    "]
+      |  +- text[@Text = "app"]
+      +- text[@Text = "\n    "]
       +- variable-definition[]
-      |  +- text[@Image = "\n        "]
+      |  +- text[@Text = "\n        "]
       |  +- variable[]
-      |  |  +- text[@Image = "\n            "]
+      |  |  +- text[@Text = "\n            "]
       |  |  +- name[]
-      |  |  |  +- text[@Image = "Application_Module_Web_ContextRoot"]
-      |  |  +- text[@Image = "\n            "]
+      |  |  |  +- text[@Text = "Application_Module_Web_ContextRoot"]
+      |  |  +- text[@Text = "\n            "]
       |  |  +- value[@xsi:nil = "false"]
-      |  |  |  +- text[@Image = "ikb.adf.kreda.abw.webapp-Abnahmetest-ohne-SSO"]
-      |  |  +- text[@Image = "\n        "]
-      |  +- text[@Image = "\n    "]
-      +- text[@Image = "\n    "]
+      |  |  |  +- text[@Text = "ikb.adf.kreda.abw.webapp-Abnahmetest-ohne-SSO"]
+      |  |  +- text[@Text = "\n        "]
+      |  +- text[@Text = "\n    "]
+      +- text[@Text = "\n    "]
       +- module-override[]
-      |  +- text[@Image = "\n        "]
+      |  +- text[@Text = "\n        "]
       |  +- module-name[]
-      |  |  +- text[@Image = "ikb.adf.kreda.abw.ear"]
-      |  +- text[@Image = "\n        "]
+      |  |  +- text[@Text = "ikb.adf.kreda.abw.ear"]
+      |  +- text[@Text = "\n        "]
       |  +- module-type[]
-      |  |  +- text[@Image = "ear"]
-      |  +- text[@Image = "\n        "]
+      |  |  +- text[@Text = "ear"]
+      |  +- text[@Text = "\n        "]
       |  +- module-descriptor[@external = "false"]
-      |  |  +- text[@Image = "\n            "]
+      |  |  +- text[@Text = "\n            "]
       |  |  +- root-element[]
-      |  |  |  +- text[@Image = "application"]
-      |  |  +- text[@Image = "\n            "]
+      |  |  |  +- text[@Text = "application"]
+      |  |  +- text[@Text = "\n            "]
       |  |  +- uri[]
-      |  |  |  +- text[@Image = "META-INF/application.xml"]
-      |  |  +- text[@Image = "\n            "]
+      |  |  |  +- text[@Text = "META-INF/application.xml"]
+      |  |  +- text[@Text = "\n            "]
       |  |  +- variable-assignment[]
-      |  |  |  +- text[@Image = "\n                "]
+      |  |  |  +- text[@Text = "\n                "]
       |  |  |  +- name[]
-      |  |  |  |  +- text[@Image = "Application_Module_Web_ContextRoot"]
-      |  |  |  +- text[@Image = "\n                "]
+      |  |  |  |  +- text[@Text = "Application_Module_Web_ContextRoot"]
+      |  |  |  +- text[@Text = "\n                "]
       |  |  |  +- xpath[]
-      |  |  |  |  +- text[@Image = "/application/module/web/[context-root=\"ikb.adf.kreda.abw.webapp-Local-ohne-SSO\"]"]
-      |  |  |  +- text[@Image = "\n                "]
+      |  |  |  |  +- text[@Text = "/application/module/web/[context-root=\"ikb.adf.kreda.abw.webapp-Local-ohne-SSO\"]"]
+      |  |  |  +- text[@Text = "\n                "]
       |  |  |  +- operation[]
-      |  |  |  |  +- text[@Image = "replace"]
-      |  |  |  +- text[@Image = "\n            "]
-      |  |  +- text[@Image = "\n        "]
-      |  +- text[@Image = "\n    "]
-      +- text[@Image = "\n"]
+      |  |  |  |  +- text[@Text = "replace"]
+      |  |  |  +- text[@Text = "\n            "]
+      |  |  +- text[@Text = "\n        "]
+      |  +- text[@Text = "\n    "]
+      +- text[@Text = "\n"]
diff --git a/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/sampleXml.txt b/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/sampleXml.txt
index df7007759b..f1836fb1b8 100644
--- a/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/sampleXml.txt
+++ b/pmd-xml/src/test/resources/net/sourceforge/pmd/lang/xml/ast/testdata/sampleXml.txt
@@ -1,13 +1,13 @@
 +- document[@XmlEncoding = null, @XmlStandalone = false, @XmlVersion = "1.0"]
    +- pmd:rootElement[@xmlns:pmd = "http://pmd.sf.net"]
-      +- text[@Image = "\n    "]
+      +- text[@Text = "\n    "]
       +- comment[]
-      +- text[@Image = "\n    "]
+      +- text[@Text = "\n    "]
       +- pmd:child1[@test = "1"]
-      |  +- text[@Image = "entity: &\n    "]
-      +- text[@Image = "\n    "]
+      |  +- text[@Text = "entity: &\n    "]
+      +- text[@Text = "\n    "]
       +- pmd:child2[]
-      |  +- text[@Image = "\n        "]
-      |  +- cdata-section[@Image = " cdata section "]
-      |  +- text[@Image = "\n    "]
-      +- text[@Image = "\n"]
+      |  +- text[@Text = "\n        "]
+      |  +- cdata-section[@Text = " cdata section "]
+      |  +- text[@Text = "\n    "]
+      +- text[@Text = "\n"]