v1.7.4: stability fixes and improvements

cordisvictor · cordisvictor · commit 4a4bba557572 · 2024-05-14T20:34:04.000+03:00
diff --git a/README.md b/README.md
@@ -60,6 +60,13 @@ for a higher control compared to the EasyML Facade.
 
 ### Release Notes
 
+Release 1.7.4
+- bugfix: XMLReader text driver comsume with pretty print
+- bugfix: XMLWriter text driver attribute validation
+- bugfix: XMLWriter and XMLReader allow field names containing "$" 
+- bugfix: only register AWT strategies if AWT available 
+
+
 Release 1.7.3
 - feature: XMLReader exclude fields (similar to XMLWriter exclude fields)
 - feature: added OptionalDouble, OptionalInt, OptionalLong strategies.
@@ -84,9 +91,6 @@ Release 1.6.0 (requires Java 9, recommended up to Java 17)
 - XMLWriter and XMLReader use getters and setters.
 - feature: support for Java 9 modules.
 - NON-BACKWARD COMPATIBLE refactor of ReflectionUtil.
-
-
-Release 1.5.3
 - refactor: remove deprecated Class.newInstance() usages.
 - refactor: limited reflection usage from Properties, EnumSet, EnumMap,
 SingletonList, SingletonSet, SingletonMap strategies.
diff --git a/easyml/src/net/sourceforge/easyml/EasyML.java b/easyml/src/net/sourceforge/easyml/EasyML.java
@@ -85,7 +85,7 @@
  * objects.<br/>
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.7.3
+ * @version 1.7.4
  * @see XMLReader
  * @see XMLWriter
  * @since 1.0
@@ -207,7 +207,9 @@ public static void defaultConfiguration(XMLWriter writer) {
 //        simple.add(IntStrategy.INSTANCE);
 //        simple.add(StringStrategy.INSTANCE);
         // awt:
-        composite.add(ColorStrategy.INSTANCE);
+        if (ColorStrategy.isAvailable()) {
+            composite.add(ColorStrategy.INSTANCE);
+        }
         // io:
         composite.add(ExternalizableStrategy.INSTANCE);
         simple.add(FileStrategy.INSTANCE);
@@ -309,7 +311,9 @@ public static void defaultConfiguration(XMLReader reader) {
 //        simple.put(IntStrategy.NAME, IntStrategy.INSTANCE);
 //        simple.put(StringStrategy.NAME, StringStrategy.INSTANCE);
         // awt:
-        composite.put(ColorStrategy.NAME, ColorStrategy.INSTANCE);
+        if (ColorStrategy.isAvailable()) {
+            composite.put(ColorStrategy.NAME, ColorStrategy.INSTANCE);
+        }
         // io:
         composite.put(ExternalizableStrategy.NAME, ExternalizableStrategy.INSTANCE);
         simple.put(FileStrategy.NAME, FileStrategy.INSTANCE);
diff --git a/easyml/src/net/sourceforge/easyml/XMLReaderDOMDriver.java b/easyml/src/net/sourceforge/easyml/XMLReaderDOMDriver.java
@@ -18,6 +18,7 @@
  */
 package net.sourceforge.easyml;
 
+import net.sourceforge.easyml.util.XMLUtil;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
@@ -31,7 +32,7 @@
  * transforming the DOM to text so that it can be inputed as text to EasyML.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.7.3
+ * @version 1.7.4
  * @since 1.1.0
  */
 final class XMLReaderDOMDriver extends XMLReader.Driver {
@@ -155,7 +156,7 @@ public String elementName() {
         if (this.crt == null) {
             throw new IllegalStateException("not at element start or end: " + this.positionDescriptor());
         }
-        return this.crt.getNodeName();
+        return XMLUtil.unescapeXMLTag(this.crt.getNodeName());
     }
 
     /**
diff --git a/easyml/src/net/sourceforge/easyml/XMLReaderTextDriver.java b/easyml/src/net/sourceforge/easyml/XMLReaderTextDriver.java
@@ -18,6 +18,7 @@
  */
 package net.sourceforge.easyml;
 
+import net.sourceforge.easyml.util.XMLUtil;
 import org.kxml2.io.KXmlParser;
 import org.xmlpull.v1.XmlPullParser;
 import org.xmlpull.v1.XmlPullParserException;
@@ -33,7 +34,7 @@
  * parameters.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.7.3
+ * @version 1.7.4
  * @since 1.1.0
  */
 final class XMLReaderTextDriver extends XMLReader.Driver {
@@ -131,7 +132,7 @@ public String elementName() {
         try {
             final int eventType = this.parser.getEventType();
             if (eventType == XmlPullParser.START_TAG || eventType == XmlPullParser.END_TAG) {
-                return this.parser.getName();
+                return XMLUtil.unescapeXMLTag(this.parser.getName());
             }
             throw new IllegalStateException("expected element start or end: " + this.parser.getLineNumber() + "," + this.parser.getColumnNumber());
         } catch (XmlPullParserException xppX) {
@@ -175,12 +176,12 @@ public void consume() {
             throw new IllegalStateException("not at element start: " + this.positionDescriptor());
         }
         try {
-            int depth = 0;
+            int depth = 1;
             do {
-                final int next = parser.next();
-                if (next == XmlPullParser.START_TAG) {
+                final int eventType = parser.next();
+                if (eventType == XmlPullParser.START_TAG) {
                     depth++;
-                } else if (next == XmlPullParser.END_TAG) {
+                } else if (eventType == XmlPullParser.END_TAG) {
                     depth--;
                 }
             } while (depth != 0);
diff --git a/easyml/src/net/sourceforge/easyml/XMLWriterDOMDriver.java b/easyml/src/net/sourceforge/easyml/XMLWriterDOMDriver.java
@@ -18,6 +18,7 @@
  */
 package net.sourceforge.easyml;
 
+import net.sourceforge.easyml.util.XMLUtil;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
@@ -27,7 +28,7 @@
  * XML to DOM documents.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.3.9
+ * @version 1.4.1
  * @since 1.1.0
  */
 final class XMLWriterDOMDriver extends XMLWriter.Driver {
@@ -61,7 +62,8 @@ public void startElement(String name) {
             throw new IllegalStateException("cannot write element start");
         }
         // update state:
-        final Element started = this.root.createElement(name);
+        final String escapedName = XMLUtil.escapeXMLTag(name);
+        final Element started = this.root.createElement(escapedName);
         if (this.crt == null) {
             this.root.appendChild(started);
         } else {
diff --git a/easyml/src/net/sourceforge/easyml/XMLWriterTextDriver.java b/easyml/src/net/sourceforge/easyml/XMLWriterTextDriver.java
@@ -30,7 +30,7 @@
  * XML to output streams.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.4.1
+ * @version 1.7.4
  * @since 1.1.0
  */
 final class XMLWriterTextDriver extends XMLWriter.Driver {
@@ -73,10 +73,11 @@ public void startElement(String name) {
             } else {
                 writeIndentedLt();
             }
-            this.writer.write(name);
+            final String escapedName = XMLUtil.escapeXMLTag(name);
+            this.writer.write(escapedName);
             this.writeOneTimeUniqueId(id -> tryWriteAttrEqValue(DTD.ATTRIBUTE_ID, id));
             // update state:
-            this.elementStack.add(name);
+            this.elementStack.add(escapedName);
             this.state = XMLWriter.Driver.STATE_START;
         } catch (IOException ioX) {
             throw new RuntimeException(ioX);
@@ -123,11 +124,14 @@ private void writeAttrEqValue(String attr, String value) throws IOException {
      */
     @Override
     public void setAttribute(String attribute, String value) {
+        if (!XMLUtil.isLegalXMLTag(attribute)) {
+            throw new IllegalArgumentException("attribute: " + attribute);
+        }
         if (this.state != XMLWriter.Driver.STATE_START) {
             throw new IllegalStateException("cannot write element attributes");
         }
         try {
-            writeAttrEqValue(XMLUtil.escapeXML(attribute), XMLUtil.escapeXML(value));
+            writeAttrEqValue(attribute, XMLUtil.escapeXML(value));
         } catch (IOException ioX) {
             throw new RuntimeException(ioX);
         }
diff --git a/easyml/src/net/sourceforge/easyml/marshalling/java/awt/ColorStrategy.java b/easyml/src/net/sourceforge/easyml/marshalling/java/awt/ColorStrategy.java
@@ -29,7 +29,7 @@
  * thread-safe.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.7.1
+ * @version 1.7.4
  * @since 1.0
  */
 public final class ColorStrategy extends AbstractStrategy implements CompositeStrategy<Color> {
@@ -52,12 +52,21 @@ private static Class targetClass() {
         try {
             // init Color.class by using Class.forName with initialize=false:
             return Class.forName("java.awt.Color", false, ColorStrategy.class.getClassLoader());
-        } catch (ClassNotFoundException neverThrown) {
+        } catch (ClassNotFoundException unavailableAWT) {
             // java.awt.Color should be a part of the JDK.
             return null;
         }
     }
 
+    /**
+     * Returns true if this strategy is available for usage, false if AWT not present.
+     *
+     * @return true if AWT present, false otherwise
+     */
+    public static boolean isAvailable() {
+        return TARGET != null;
+    }
+
     private ColorStrategy() {
     }
 
diff --git a/easyml/src/net/sourceforge/easyml/util/XMLUtil.java b/easyml/src/net/sourceforge/easyml/util/XMLUtil.java
@@ -18,28 +18,41 @@
  */
 package net.sourceforge.easyml.util;
 
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
 /**
  * XMLUtil utility class used to format the XML element and element attribute
  * values by escaping and un-escaping illegal XML characters.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.5.0
+ * @version 1.7.4
  * @since 1.0
  */
 public final class XMLUtil {
 
-    static final char XML_ILLEGAL_LT = '<';
-    static final char XML_ILLEGAL_GT = '>';
-    static final char XML_ILLEGAL_AMP = '&';
-    static final char XML_ILLEGAL_QUOT = '"';
-    static final char XML_ILLEGAL_APOS = '\'';
-    static final char XML_ILLEGAL_CR = '\r';
-    static final String XML_LEGAL_LT = "&lt;";
-    static final String XML_LEGAL_GT = "&gt;";
-    static final String XML_LEGAL_AMP = "&amp;";
-    static final String XML_LEGAL_QUOT = "&quot;";
-    static final String XML_LEGAL_APOS = "&apos;";
-    static final String XML_LEGAL_CR = "&#13;";
+    /**
+     * Constant holding the illegal <code>$</code>.
+     */
+    public static final char XML_TAG_ILLEGAL_$ = '$';
+    /**
+     * Constant holding the escaped form of <code>$</code>.
+     */
+    public static final String XML_TAG_LEGAL_$ = "_-_";
+    private static final String XML_TAG_ILLEGAL_$_QUOTED = Matcher.quoteReplacement(Character.toString(XML_TAG_ILLEGAL_$));
+    private static final Pattern XML_TAG_LEGAL_$_PATTERN = Pattern.compile(Pattern.quote(XML_TAG_LEGAL_$));
+    private static final char XML_ILLEGAL_LT = '<';
+    private static final char XML_ILLEGAL_GT = '>';
+    private static final char XML_ILLEGAL_AMP = '&';
+    private static final char XML_ILLEGAL_QUOT = '"';
+    private static final char XML_ILLEGAL_APOS = '\'';
+    private static final char XML_ILLEGAL_CR = '\r';
+    private static final String XML_LEGAL_LT = "&lt;";
+    private static final String XML_LEGAL_GT = "&gt;";
+    private static final String XML_LEGAL_AMP = "&amp;";
+    private static final String XML_LEGAL_QUOT = "&quot;";
+    private static final String XML_LEGAL_APOS = "&apos;";
+    private static final String XML_LEGAL_CR = "&#13;";
 
     /**
      * Returns true if the input text is free from illegal XML characters, false otherwise.
@@ -130,6 +143,49 @@ private static void appendEscaped(StringBuilder destination, char c) {
         }
     }
 
+    /**
+     * Escapes <code>$</code> in the given tag.
+     *
+     * @param tag to escape
+     * @return the escaped tag
+     */
+    public static String escapeXMLTag(String tag) {
+        final int symbolIdx = tag.indexOf(XML_TAG_ILLEGAL_$);
+        if (symbolIdx == -1) {
+            return tag; // all legal.
+        }
+        final int len = tag.length();
+        final StringBuilder sb = new StringBuilder(len + 10);
+        // copy initial legal part:
+        for (int i = 0; i < symbolIdx; i++) {
+            sb.append(tag.charAt(i));
+        }
+        // escape the remaining part:
+        for (int i = symbolIdx; i < len; i++) {
+            final char c = tag.charAt(i);
+            if (c == XML_TAG_ILLEGAL_$) {
+                sb.append(XML_TAG_LEGAL_$);
+            } else {
+                sb.append(c);
+            }
+        }
+        return sb.toString();
+    }
+
+    /**
+     * Unescapes <code>$</code> in the given tag.
+     *
+     * @param tag to unescape
+     * @return the unescaped tag
+     */
+    public static String unescapeXMLTag(String tag) {
+        final int escapedIdx = tag.indexOf(XML_TAG_LEGAL_$);
+        if (escapedIdx == -1) {
+            return tag; // all legal.
+        }
+        return XML_TAG_LEGAL_$_PATTERN.matcher(tag).replaceAll(XML_TAG_ILLEGAL_$_QUOTED);
+    }
+
     private XMLUtil() {
     }
 }
diff --git a/easyml/test/net/sourceforge/easyml/BugsTest.java b/easyml/test/net/sourceforge/easyml/BugsTest.java
@@ -77,7 +77,6 @@ public void testBugObjectX_defValFieldHidesSuperDefValField() throws Exception {
     public void testBugSerial_PutGetFieldsCustomKeys() throws Exception {
         easyml = new EasyMLBuilder()
                 //.withStyle(EasyML.Style.PRETTY)
-                //.withProfile(EasyML.Profile.GENERIC)
                 .withStrategy(new SerializableStrategy())
                 .build();
 
@@ -89,6 +88,20 @@ public void testBugSerial_PutGetFieldsCustomKeys() throws Exception {
         assertEquals(expected, easyml.deserialize(xml));
     }
 
+    @Test
+    public void testBugSpecialCharField() throws Exception {
+        easyml = new EasyMLBuilder()
+                //.withStyle(EasyML.Style.PRETTY)
+                .build();
+
+        final SpecialSymbolField expected = new SpecialSymbolField("specialValue");
+
+        String xml = easyml.serialize(expected);
+        System.out.println(xml);
+
+        assertEquals(expected, easyml.deserialize(xml));
+    }
+
     private static class Person {
 
         private final String name;
@@ -237,4 +250,41 @@ public String toString() {
                     '}';
         }
     }
+
+    private static class SpecialSymbolField {
+
+        private final String special$field;
+
+        public SpecialSymbolField() {
+            special$field = null;
+        }
+
+        public SpecialSymbolField(String special$field) {
+            this.special$field = special$field;
+        }
+
+        public String getSpecial$field() {
+            return special$field;
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+            SpecialSymbolField that = (SpecialSymbolField) o;
+            return Objects.equals(special$field, that.special$field);
+        }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(special$field);
+        }
+
+        @Override
+        public String toString() {
+            return "SpecialSymbolField{" +
+                    "special$field='" + special$field + '\'' +
+                    '}';
+        }
+    }
 }
diff --git a/easyml/test/net/sourceforge/easyml/ExcludeDeserializeTest.java b/easyml/test/net/sourceforge/easyml/ExcludeDeserializeTest.java
