Fix #290 by reverting #95 (and PR #270) (#296)

Author: cowtowncoder

release-notes/CREDITS

@@ -47,6 +47,10 @@ Konrad Windszus (kwin@github)
  (6.1.0)
 * Reported #95: `BaseStreamWriter.writeRaw()` should not close open element
  (7.2.0)
+* Reported #290: Regression in 7.2.0: `writeRaw()` no longer closing an open start
+  element (from #95) breaks emitting whitespace after start/end tags;
+  reverted #95 so `writeRaw()` again closes an open start element
+ (7.2.1)
 
 Daniel Kulp (dkulp@github)
 

release-notes/VERSION

@@ -14,6 +14,10 @@ Project: woodstox
  (reported by @Skrethel)
 #293: Reject out-of-range code points in `UTF32Reader`
  (contributed by @aizu-m)
+#290: Regression in 7.2.0: `writeRaw()` no longer closing an open start
+  element (from #95) breaks emitting whitespace after start/end tags;
+  reverted #95 so `writeRaw()` again closes an open start element
+ (reported by Konrad W)
 
 7.2.0 (19-May-2026)
 

src/main/java/com/ctc/wstx/sw/BaseStreamWriter.java

@@ -1161,14 +1161,14 @@ public void writeStartDocument(String version, String encoding,
         doWriteStartDocument(version, encoding, standAlone ? "yes" : "no");
     }
 
-    // 13-May-2026, tatu: [woodstox-core#95] writeRaw() must NOT close an
-    //   open start element, so that callers can use it to emit content
-    //   (typically whitespace) between attributes within a start tag.
     @Override
     public void writeRaw(String text)
         throws XMLStreamException
     {
         mAnyOutput = true;
+        if (mStartElementOpen) {
+            closeStartElement(mEmptyElement);
+        }
         try {
             mWriter.writeRaw(text, 0, text.length());
         } catch (IOException ioe) {
@@ -1181,6 +1181,9 @@ public void writeRaw(String text, int start, int offset)
         throws XMLStreamException
     {
         mAnyOutput = true;
+        if (mStartElementOpen) {
+            closeStartElement(mEmptyElement);
+        }
         try {
             mWriter.writeRaw(text, start, offset);
         } catch (IOException ioe) {
@@ -1193,6 +1196,9 @@ public void writeRaw(char[] text, int start, int offset)
         throws XMLStreamException
     {
         mAnyOutput = true;
+        if (mStartElementOpen) {
+            closeStartElement(mEmptyElement);
+        }
         try {
             mWriter.writeRaw(text, start, offset);
         } catch (IOException ioe) {

src/test/java/stax2/wstream/TestStreamWriter.java

@@ -258,10 +258,6 @@ public void testRaw()
             w.writeStartDocument();
             w.writeStartElement("test");
             w.writeAttribute("attr", "value");
-            // 13-May-2026, tatu: As of [woodstox-core#95], writeRaw() no longer
-            //   closes an open start element; an empty writeCharacters() is the
-            //   idiomatic way to commit the start tag before raw content.
-            w.writeCharacters("");
             w.writeRaw("this or 'that'");
             char[] cbuf = new char[RAW2.length() + 10];
             RAW2.getChars(0, RAW2.length(), cbuf, 3);
@@ -293,55 +289,29 @@ public void testRaw()
     }
 
     /**
-     * Unit test for [woodstox-core#95]: writeRaw() must not close an open
-     * start element, so it can be used to emit content (typically whitespace)
-     * between attributes within the start tag, e.g. for indenting attributes.
+     * Unit test for [woodstox-core#290]: emitting whitespace (via
+     * {@code writeSpace()}, which delegates to {@code writeRaw()}) right
+     * after a start element must close the open start tag first, so that the
+     * whitespace ends up as element content rather than inside the start tag.
      */
     @Test
-    public void testRawBetweenAttributes()
+    public void testSpaceAfterStartElement()
         throws XMLStreamException
     {
         for (int i = 0; i < 3; ++i) {
             boolean ns = (i > 0);
             StringWriter strw = new StringWriter();
             XMLStreamWriter2 w = (i == 2) ? getRepairingWriter(strw)
                 : getNonRepairingWriter(strw, ns);
-            w.writeStartDocument();
             w.writeStartElement("test");
-            w.writeAttribute("a", "1");
-            // Raw whitespace between attributes must be allowed and must
-            // not close the start tag.
-            w.writeRaw("\n      ");
-            w.writeAttribute("b", "2");
-            w.writeRaw("\n      ");
-            w.writeAttribute("c", "3");
+            w.writeSpace("\n   ");
+            w.writeComment("comment");
             w.writeEndElement();
             w.writeEndDocument();
             w.close();
 
             String xml = strw.toString();
-            // Verify the literal raw whitespace made it into the start tag,
-            // between the attributes. (The writer also prepends its own ' '
-            // before each attribute name, so the exact number of spaces after
-            // the newline is implementation detail; we just check the newline
-            // and indentation we asked for is present.)
-            assertTrue("Expected raw newline+indent between attributes, got: " + xml,
-                    xml.contains("a=\"1\"\n      ")
-                    && xml.contains("b=\"2\"\n      "));
-
-            // And the result must still parse as well-formed XML with all
-            // three attributes present.
-            XMLStreamReader sr = constructNsStreamReader(xml, true);
-            assertTokenType(START_DOCUMENT, sr.getEventType());
-            assertTokenType(START_ELEMENT, sr.next());
-            assertEquals("test", sr.getLocalName());
-            assertEquals(3, sr.getAttributeCount());
-            assertEquals("1", sr.getAttributeValue(null, "a"));
-            assertEquals("2", sr.getAttributeValue(null, "b"));
-            assertEquals("3", sr.getAttributeValue(null, "c"));
-            assertTokenType(END_ELEMENT, sr.next());
-            assertTokenType(END_DOCUMENT, sr.next());
-            sr.close();
+            assertEquals("<test>\n   <!--comment--></test>", xml);
         }
     }