[bugfix] Fix serialization item separators

Author: chris-evolvedbinary

exist-core/src/main/java/org/exist/xquery/functions/fn/FunSerialize.java

@@ -25,6 +25,7 @@
 import org.exist.dom.memtree.DocumentBuilderReceiver;
 import org.exist.dom.memtree.DocumentImpl;
 import org.exist.dom.memtree.MemTreeBuilder;
+import org.exist.storage.serializers.EXistOutputKeys;
 import org.exist.util.serializer.XQuerySerializer;
 import org.exist.xquery.*;
 import org.exist.xquery.functions.map.AbstractMapType;
@@ -41,6 +42,8 @@
 
 public class FunSerialize extends BasicFunction {
 
+    private final static String DEFAULT_ITEM_SEPARATOR = "\n";
+
     public final static FunctionSignature[] signatures = {
         new FunctionSignature(
                 new QName("serialize", Function.BUILTIN_FUNCTION_NS, FnModule.PREFIX),
@@ -81,7 +84,8 @@ public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathExce
 
             Sequence seq = args[0];
             if (xqSerializer.normalize()) {
-                seq = normalize(this, context, seq);
+                final String itemSeparator = outputProperties.getProperty(EXistOutputKeys.ITEM_SEPARATOR, DEFAULT_ITEM_SEPARATOR);
+                seq = normalize(this, context, seq, itemSeparator);
             }
 
             xqSerializer.serialize(seq);
@@ -133,7 +137,7 @@ private static boolean isSerializationParametersElement(final Item item) {
      * @return normalized sequence
      * @throws XPathException in case of dynamic error
      */
-    public static Sequence normalize(final Expression callingExpr, final XQueryContext context, final Sequence input) throws XPathException {
+    public static Sequence normalize(final Expression callingExpr, final XQueryContext context, final Sequence input, final String itemSeparator) throws XPathException {
         if (input.isEmpty())
             // "If the sequence that is input to serialization is empty, create a sequence S1 that consists of a zero-length string."
             {return StringValue.EMPTY_STRING;}
@@ -154,7 +158,7 @@ public static Sequence normalize(final Expression callingExpr, final XQueryConte
                     // "For each subsequence of adjacent strings in S2, copy a single string to the new sequence
                     // equal to the values of the strings in the subsequence concatenated in order, each separated
                     // by a single space."
-                    {((StringValue)last).append(" " + next.getStringValue());}
+                    {((StringValue)last).append((itemSeparator == null ? " " : itemSeparator) + next.getStringValue());}
                 else
                     // "For each item in S1, if the item is atomic, obtain the lexical representation of the item by
                     // casting it to an xs:string and copy the string representation to the new sequence;"

exist-core/src/main/java/org/exist/xquery/functions/util/Eval.java

@@ -404,7 +404,7 @@ private Sequence doEval(final XQueryContext evalContext, final Sequence contextS
 
                         final Sequence seq;
                         if (xqSerializer.normalize()) {
-                            seq = FunSerialize.normalize(this, context, result);
+                            seq = FunSerialize.normalize(this, context, result, null);
                         } else {
                             seq = result;
                         }

exist-core/src/test/xquery/xquery3/serialize.xql

@@ -61,6 +61,18 @@ declare %private function ser:adaptive-map-params($data) {
     ser:adaptive-map-params($data, ())
 };
 
+declare %private function ser:serialize-with-item-separator($data as item()*, $method as xs:string) {
+    let $options :=
+        <output:serialization-parameters
+            xmlns:output="http://www.w3.org/2010/xslt-xquery-serialization">
+            <output:method value="{$method}"/>
+            <output:indent>no</output:indent>
+            <output:item-separator>--</output:item-separator>
+        </output:serialization-parameters>
+    return
+        fn:serialize($data, $options)
+};
+
 declare variable $ser:atomic :=
     <atomic:root xmlns:atomic="http://www.w3.org/XQueryTest" xmlns:foo="http://www.example.com/foo"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
@@ -202,7 +214,8 @@ function ser:serialize-empty-params() {
 };
 
 declare
-    %test:assertEquals("aaa bbb")
+    %test:assertEquals("aaa
+bbb")
 function ser:serialize-atomic() {
     let $nodes := ("aaa", "bbb")
     return
@@ -754,4 +767,46 @@ declare
 function ser:exist-process-xsl-pi-false() {
     let $doc := doc($ser:collection || "/test-xsl.xml")
     return fn:serialize($doc, map {xs:QName("exist:process-xsl-pi"): false()})
-};
+};
+
+declare
+    %test:assertEquals("1--2")
+function ser:item-separator-text-method() {
+    let $data := (1, 2)
+    return ser:serialize-with-item-separator($data, "text")
+};
+
+declare
+    %test:assertEquals("1--2")
+function ser:item-separator-html-method() {
+    let $data := (1, 2)
+    return ser:serialize-with-item-separator($data, "html")
+};
+
+declare
+    %test:assertEquals("1--2")
+function ser:item-separator-xhtml-method() {
+    let $data := (1, 2)
+    return ser:serialize-with-item-separator($data, "xhtml")
+};
+
+declare
+    %test:assertEquals("1--2")
+function ser:item-separator-xml-method() {
+    let $data := (1, 2)
+    return ser:serialize-with-item-separator($data, "xml")
+};
+
+declare
+    %test:assertEquals("1--2")
+function ser:item-separator-adaptive-method() {
+    let $data := (1, 2)
+    return ser:serialize-with-item-separator($data, "adaptive")
+};
+
+declare
+    %test:assertEquals("1--2")
+function ser:test() {
+    let $data := (1, 2)
+    return ser:serialize-with-item-separator($data, "xml")
+};