[bugfix] Change fn:collation-key function signatures, and correct comparisons in fn:collation-key tests.

Author: chris-evolvedbinary

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

@@ -32,43 +32,43 @@
 
 import java.nio.charset.StandardCharsets;
 
+import static org.exist.xquery.FunctionDSL.*;
+
 public class FunCollationKey extends BasicFunction {
 
-    private static final QName FN_NAME = new QName("collation-key", Function.BUILTIN_FUNCTION_NS, FnModule.PREFIX);
+    private static final String FN_NAME = "collation-key"; // , Function.BUILTIN_FUNCTION_NS, FnModule.PREFIX);
     private static final String FN_DESCRIPTION =
-            "Given a $value-string value and a $collection-string " +
+            "Given a $value-string value and a $collation-string " +
                     "collation, generates an internal value called a collation key, with the " +
                     "property that the matching and ordering of collation " +
                     "keys reflects the matching and ordering of strings " +
                     "under the specified collation.";
-    private static final FunctionReturnSequenceType FN_RETURN = new FunctionReturnSequenceType(
-            Type.BASE64_BINARY, Cardinality.ZERO_OR_ONE, "the collation key"
-    );
-
-    public static final FunctionSignature[] FS_COLLATION_KEY_SIGNATURES = {
-            new FunctionSignature(FunCollationKey.FN_NAME, FunCollationKey.FN_DESCRIPTION,
-                    new SequenceType[] {
-                            new FunctionParameterSequenceType("value-string", Type.STRING,
-                                    Cardinality.ZERO_OR_ONE, "The value string")
-                    }, FN_RETURN),
-            new FunctionSignature(FunCollationKey.FN_NAME, FunCollationKey.FN_DESCRIPTION,
-                    new SequenceType[] {
-                            new FunctionParameterSequenceType("value-string", Type.STRING,
-                                    Cardinality.ZERO_OR_ONE, "The value string"),
-                            new FunctionParameterSequenceType("collection-string", Type.STRING,
-                                    Cardinality.ZERO_OR_ONE, "The collation string")
-                    }, FN_RETURN)
-    };
+    private static final FunctionReturnSequenceType FN_RETURN = returnsOpt(Type.BASE64_BINARY, "the collation key");
+    private static final FunctionParameterSequenceType PARAM_VALUE_STRING = param("value-string", Type.STRING, "The value string");
+    private static final FunctionParameterSequenceType PARAM_COLLATION_STRING = param("collation-string", Type.STRING, "The collation string");
+    public static final FunctionSignature[] FS_COLLATION_KEY_SIGNATURES = functionSignatures(
+            FN_NAME,
+            FN_DESCRIPTION,
+            FN_RETURN,
+            arities(
+                    arity(PARAM_VALUE_STRING),
+                    arity(PARAM_VALUE_STRING, PARAM_COLLATION_STRING)
+            )
+        );
 
     public FunCollationKey(final XQueryContext context, final FunctionSignature signature) {
         super(context, signature);
     }
 
-    public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
+    public Sequence eval(final Sequence[] args, final Sequence contextSequence) throws XPathException {
         final String source = (args.length >= 1) ? args[0].toString() : "";
         final Collator collator = (args.length >= 2) ? Collations.getCollationFromURI(args[1].toString()) : null;
 
         return new BinaryValueFromBinaryString(new Base64BinaryValueType(), Base64.encodeBase64String(
                 (collator == null) ? source.getBytes(StandardCharsets.UTF_8) : new String(collator.getCollationKey(source).toByteArray()).getBytes(StandardCharsets.UTF_8)));
     }
+
+    private static FunctionSignature[] functionSignatures(final String name, final String description, final FunctionReturnSequenceType returnType, final FunctionParameterSequenceType[][] variableParamTypes) {
+        return FunctionDSL.functionSignatures(new QName(name, Function.BUILTIN_FUNCTION_NS, FnModule.PREFIX), description, returnType, variableParamTypes);
+    }
 }

exist-core/src/test/xquery/xquery3/fnCollationKey.xqm

@@ -30,55 +30,55 @@ declare
 function fnck:default-equal-case() {
     let $first := fn:collation-key("a")
     let $second := fn:collation-key("a")
-    return $first = $second
+    return $first eq $second
 };
 
 declare
     %test:assertTrue
 function fnck:default-equal() {
     let $first := fn:collation-key("a")
     let $second := fn:collation-key("a")
-    return $first = $second
+    return $first eq $second
 };
 
 declare
     %test:assertTrue
 function fnck:default-not-equal() {
     let $first := fn:collation-key("a")
     let $second := fn:collation-key("b")
-    return $first != $second
+    return $first ne $second
 };
 
 declare
     %test:assertTrue
 function fnck:default-not-equal-ignore-case() {
     let $first := fn:collation-key("a")
     let $second := fn:collation-key("A")
-    return $first != $second
+    return $first ne $second
 };
 
 declare
     %test:assertTrue
 function fnck:exist-equal() {
     let $first := fn:collation-key("a", "http://exist-db.org/collation")
     let $second := fn:collation-key("a", "http://exist-db.org/collation")
-    return $first = $second
+    return $first eq $second
 };
 
 declare
     %test:assertTrue
 function fnck:exist-equal-ignore-case() {
     let $first := fn:collation-key("a", "http://exist-db.org/collation")
     let $second := fn:collation-key("A", "http://exist-db.org/collation")
-    return $first = $second
+    return $first eq $second
 };
 
 declare
     %test:assertTrue
 function fnck:exist-not-equal() {
     let $first := fn:collation-key("a", "http://exist-db.org/collation")
     let $second := fn:collation-key("b", "http://exist-db.org/collation")
-    return $first != $second
+    return $first ne $second
 };
 
 declare
@@ -92,21 +92,21 @@ declare
 function fnck:uca-equal() {
     let $first := fn:collation-key("a", "http://www.w3.org/2013/collation/UCA")
     let $second := fn:collation-key("a", "http://www.w3.org/2013/collation/UCA")
-    return $first = $second
+    return $first eq $second
 };
 
 declare
     %test:assertTrue
 function fnck:uca-equal-ignore-case() {
     let $first := fn:collation-key("a", "http://www.w3.org/2013/collation/UCA")
     let $second := fn:collation-key("A", "http://www.w3.org/2013/collation/UCA")
-    return $first = $second
+    return $first eq $second
 };
 
 declare
     %test:assertTrue
 function fnck:uca-not-equal() {
-    let $first := fn:collation-key("a", "http://www.w3.org/2013/collation/UCA")
-    let $second := fn:collation-key("b", "http://www.w3.org/2013/collation/UCA")
-    return $first != $second
+    let $first := fn:collation-key(fn:codepoints-to-string((37, 65500, 37)))
+    let $second := fn:collation-key(fn:codepoints-to-string((37, 100000, 37)))
+    return $first eq $second
 };