foray-commit Mailing List for FOray

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 13878
          http://sourceforge.net/p/foray/code/13878
Author:   victormote
Date:     2025-08-05 14:37:28 +0000 (Tue, 05 Aug 2025)
Log Message:
-----------
Normalize whitespace in attribute values before comparing them.

Modified Paths:
--------------
    trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayXdiff.java

Modified: trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayXdiff.java
===================================================================

--- trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayXdiff.java	2025-06-26 16:03:23 UTC (rev 13877)
+++ trunk/foray/foray-xml/src/main/java/org/foray/xml/ForayXdiff.java	2025-08-05 14:37:28 UTC (rev 13878)
@@ -54,12 +54,10 @@
 import javax.xml.stream.XMLStreamReader;
 
 /**
- * This class reads two or more XML streams and finds the first difference (if
- * any) between them.
+ * This class reads two or more XML streams and finds the first difference (if any) between them.
  * This is not intended to be a general-purpose XML diff and compare tool.
- * It is suitable in situations where some tranformation (like a pretty-print)
- * has taken place and we wish to make sure that no significant changes were
- * made to the document.
+ * It is suitable in situations where some tranformation (like a pretty-print) has taken place and we wish to make sure
+ * that no significant changes were made to the document.
  */
 public class ForayXdiff {
 
@@ -82,10 +80,8 @@
     /** The pull parsers for the input documents. */
     private XMLStreamReader[] readers;
 
-    /** Caches the best description that we can find of the input source for
-     * each of the items in {@link #readers}. The Location instances provided
-     * don't provide this information, so we work around that limitation here.
-     */
+    /** Caches the best description that we can find of the input source for each of the items in {@link #readers}.
+     * The Location instances provided don't provide this information, so we work around that limitation here. */
     private String[] readerIDs;
 
     /** The logger (lazily created). Use {#getLogger()} to get the instance. */
@@ -92,6 +88,7 @@
     private Logger logger;
 
     /* Begin configurable parameters. */
+
     /** Ignores character items that are all whitespace. */
     private boolean ignoreCharacterWhitespace = true;
 
@@ -176,11 +173,9 @@
     }
 
     /**
-     * Compares the XML streams passed or implicitly passed in the constructor,
-     * and returns true if the streams are equivalent, false if there is one or
-     * more differences.
-     * @return True if the streams are equivalent, false if there is one or
-     * more differences.
+     * Compares the XML streams passed or implicitly passed in the constructor, and returns true if the streams are
+     * equivalent, false if there is one or more differences.
+     * @return True if the streams are equivalent, false if there is one or more differences.
      * @throws IOException For errors reading the documents.
      * @throws XMLStreamException For errors pulling events from the documents.
      */
@@ -279,10 +274,8 @@
     }
 
     /**
-     * Checks the event type for all XMLStreamReaders for equality, returning
-     * the value if all are equal.
-     * @return If the events are equal, returns that value. Otherwise, returns
-     * {@link Integer#MIN_VALUE}.
+     * Checks the event type for all XMLStreamReaders for equality, returning the value if all are equal.
+     * @return If the events are equal, returns that value. Otherwise, returns {@link Integer#MIN_VALUE}.
      * @throws XMLStreamException For errors pulling the events.
      */
     private int readEvents() throws XMLStreamException {
@@ -366,8 +359,7 @@
 
     /**
      * Pull an event from a specific document.
-     * @param i The index to the input documents indicating which document
-     * should pull an event.
+     * @param i The index to the input documents indicating which document should pull an event.
      * @return The pulled event.
      * @throws XMLStreamException For errors pulling the event.
      */
@@ -398,8 +390,7 @@
     }
 
     /**
-     * Send a message to the user indicating a problem, and providing as much
-     * location information as possible.
+     * Send a message to the user indicating a problem, and providing as much location information as possible.
      * @param message The raw message to send to the user.
      */
     private void message(final String message) {
@@ -555,10 +546,9 @@
 
     /**
      * Indicates whether all of the elements are equivalent.
-     * @return True if all of the Elements are equivalent. To be equivalent,
-     * they must have the same names, and must have exactly the same attributes
-     * and attribute values, although the attributes do not have to be in the
-     * same order.
+     * @return True if all of the Elements are equivalent.
+     * To be equivalent, they must have the same names, and must have exactly the same attributes and attribute values,
+     * although the attributes do not have to be in the same order.
      */
     private boolean compareElements() {
         /* 1. Make sure the names are the same. */
@@ -581,19 +571,17 @@
                 return false;
             }
         }
-        /* 3. Make sure that each attribute in first document exists in the
-         * others, and that their values are equal. */
+        /* 3. Make sure that each attribute in first document exists in the others, and that their values are equal.
+         * We already checked that the count is equal above, so we only need to test from the base to the comparatives.
+         * There is no need to check from the comparatives back to the base. */
         /* Iterate through each attribute of the base element. */
         for (int i = 0; i < baseAttributeCount; i++) {
-            final QName baseAttributeName =
-                    this.readers[0].getAttributeName(i);
-            final String baseAttributeValue =
-                    this.readers[0].getAttributeValue(i);
+            final QName baseAttributeName = this.readers[0].getAttributeName(i);
+            final String baseAttributeValue = XmlUtils.normalizeWhitespace(this.readers[0].getAttributeValue(i));
             String baseNamespaceURI = baseAttributeName.getNamespaceURI();
-            /* QName maps null attribute names to "", but the reader doesn't
-             * seem to know about that and treates "" as different from null.
-             * Therefore we must change it back to null for them to be seen
-             * as equivalent. */
+            /* QName maps null attribute names to "", but the reader doesn't seem to know about that and treates "" as
+             * different from null.
+             * Therefore we must change it back to null for them to be seen as equivalent. */
             if ("".equals(baseNamespaceURI)) {
                 baseNamespaceURI = null;
             }
@@ -600,17 +588,15 @@
             /* Iterate through each of the other documents. */
             for (int j = 1; j < this.readers.length; j++) {
                 final XMLStreamReader reader = this.readers[j];
-                final String compareAttributeValue = reader.getAttributeValue(
-                        baseNamespaceURI,
+                final String rawAttributeValue = reader.getAttributeValue(baseNamespaceURI,
                         baseAttributeName.getLocalPart());
+                final String compareAttributeValue = XmlUtils.normalizeWhitespace(rawAttributeValue);
                 if (compareAttributeValue == null) {
-                    message("Attribute not found: "
-                            + baseAttributeName.toString());
+                    message("Attribute not found: " + baseAttributeName.toString());
                     return false;
                 }
                 if (! compareAttributeValue.equals(baseAttributeValue)) {
-                    message("Attribute values differ: "
-                            + baseAttributeName.toString());
+                    message("Attribute values differ: " + baseAttributeName.toString());
                     return false;
                 }
             }

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.





2006	Jan	Feb	Mar (139)	Apr (98)	May (250)	Jun (394)	Jul (84)	Aug (13)	Sep (420)	Oct (186)	Nov (1)	Dec (3)
2007	Jan (108)	Feb (202)	Mar (291)	Apr (247)	May (374)	Jun (227)	Jul (231)	Aug (60)	Sep (31)	Oct (45)	Nov (18)	Dec
2008	Jan (38)	Feb (71)	Mar (142)	Apr	May (59)	Jun (6)	Jul (10)	Aug	Sep	Oct	Nov	Dec
2009	Jan (12)	Feb (4)	Mar (88)	Apr (121)	May (17)	Jun (30)	Jul	Aug (5)	Sep	Oct (1)	Nov	Dec
2010	Jan (11)	Feb (76)	Mar (11)	Apr	May (11)	Jun	Jul	Aug (44)	Sep (14)	Oct (7)	Nov	Dec
2011	Jan	Feb	Mar	Apr	May (9)	Jun	Jul	Aug	Sep	Oct (10)	Nov	Dec
2012	Jan	Feb	Mar	Apr	May	Jun (3)	Jul (4)	Aug	Sep	Oct	Nov	Dec
2016	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec (168)
2017	Jan (77)	Feb (11)	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2018	Jan	Feb	Mar (1)	Apr (6)	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2019	Jan	Feb (88)	Mar (118)	Apr (1)	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2020	Jan	Feb	Mar	Apr	May (6)	Jun	Jul	Aug	Sep	Oct	Nov	Dec (141)
2021	Jan (170)	Feb (20)	Mar	Apr	May	Jun	Jul (1)	Aug	Sep	Oct (62)	Nov (189)	Dec (162)
2022	Jan (201)	Feb (118)	Mar (8)	Apr	May (2)	Jun (47)	Jul (19)	Aug (14)	Sep (3)	Oct	Nov (28)	Dec (235)
2023	Jan (112)	Feb (23)	Mar (2)	Apr (2)	May	Jun (1)	Jul	Aug (70)	Sep (92)	Oct (20)	Nov (1)	Dec (1)
2024	Jan	Feb	Mar (1)	Apr (1)	May (14)	Jun (11)	Jul (1)	Aug	Sep	Oct	Nov	Dec
2025	Jan (10)	Feb (29)	Mar	Apr (162)	May (245)	Jun (83)	Jul	Aug (1)	Sep	Oct	Nov	Dec

foray-commit Mailing List for FOray

Modular XSL-FO Implementation for Java.

foray-commit — FOray repository commit log messages