Merge pull request #4366 from evolvedbinary/feature/fn-format-integer#2,#3

Implement fn:format-integer#2,#3

Author: dizzzz

exist-core/src/main/java/org/exist/test/runner/XMLTestRunner.java

@@ -79,10 +79,10 @@ public class XMLTestRunner extends AbstractTestRunner {
     /**
      * @param path The path to the XML file containing the tests.
      * @param parallel whether the tests should be run in parallel.
-     *
      * @throws InitializationError if the test runner could not be constructed.
      */
-    public XMLTestRunner(final Path path, final boolean parallel) throws InitializationError {
+
+    XMLTestRunner(final Path path, final boolean parallel) throws InitializationError {
         super(path, parallel);
         try {
             this.doc = parse(path);
@@ -120,7 +120,7 @@ private static XMLTestInfo extractTestInfo(final Path path, final Document doc)
                             testName = getTaskText(child);
                         }
                         if (testName == null) {
-                            throw new InitializationError("Could not find @id or <task> within <test> of XML <TestSet> document:" + path.toAbsolutePath().toString());
+                            throw new InitializationError("Could not find @id or <task> within <test> of XML <TestSet> document:" + path.toAbsolutePath());
                         }
                         testNames.add(testName);
                         break;
@@ -133,7 +133,7 @@ private static XMLTestInfo extractTestInfo(final Path path, final Document doc)
         }
 
         if (testSetName == null) {
-            throw new InitializationError("Could not find <testName> in XML <TestSet> document: " + path.toAbsolutePath().toString());
+            throw new InitializationError("Could not find <testName> in XML <TestSet> document: " + path.toAbsolutePath());
         }
 
         return new XMLTestInfo(testSetName, description, testNames);
@@ -169,8 +169,7 @@ private static XMLTestInfo extractTestInfo(final Path path, final Document doc)
     }
 
     private String getSuiteName() {
-        final String suiteName = "xmlts." + info.getName();  // add "xmlts." prefix
-        return suiteName;
+        return "xmlts." + info.getName();
     }
 
     @Override
@@ -213,7 +212,7 @@ public void run(final RunNotifier notifier) {
         }
     }
 
-    private Document parse(final Path path) throws ParserConfigurationException, IOException, SAXException {
+    private static Document parse(final Path path) throws ParserConfigurationException, IOException, SAXException {
         final InputSource src = new InputSource(path.toUri().toASCIIString());
         final SAXParser parser = SAX_PARSER_FACTORY.newSAXParser();
         final XMLReader xr = parser.getXMLReader();

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

@@ -0,0 +1,100 @@
+/*
+ * eXist-db Open Source Native XML Database
+ * Copyright (C) 2001 The eXist-db Authors
+ *
+ * [email protected]
+ * http://www.exist-db.org
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package org.exist.xquery.functions.fn;
+
+import org.exist.xquery.BasicFunction;
+import org.exist.xquery.FunctionSignature;
+import org.exist.xquery.XPathException;
+import org.exist.xquery.XQueryContext;
+import org.exist.xquery.functions.integer.IntegerPicture;
+import org.exist.xquery.value.*;
+
+import java.math.BigInteger;
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.exist.xquery.FunctionDSL.*;
+import static org.exist.xquery.functions.fn.FnModule.functionSignatures;
+
+/**
+ * Implements fn:format-integer as per W3C XPath and XQuery Functions and Operators 3.1
+ * <p>
+ * fn:format-number($value as integer?, $picture as xs:string) as xs:string
+ * fn:format-number($value as integer?, $picture as xs:string, $lang as xs:string) as xs:string
+ *
+ * @author <a href="mailto:[email protected]">Alan Paxton</a>
+ */
+public class FnFormatIntegers extends BasicFunction {
+
+    private static final FunctionParameterSequenceType FS_PARAM_VALUE = optParam("value", Type.NUMBER, "The number to format");
+    private static final FunctionParameterSequenceType FS_PARAM_PICTURE = param("picture", Type.STRING, "The picture string to use for formatting. To understand the picture string syntax, see: https://www.w3.org/TR/xpath-functions-31/#func-format-number");
+
+    private static final String FS_FORMAT_INTEGER_NAME = "format-integer";
+    static final FunctionSignature[] FS_FORMAT_INTEGER = functionSignatures(
+            FS_FORMAT_INTEGER_NAME,
+            "Returns a string containing an integer formatted according to a given picture string.",
+            returns(Type.STRING, "The formatted string representation of the supplied integer"),
+            arities(
+                    arity(
+                            FS_PARAM_VALUE,
+                            FS_PARAM_PICTURE
+                    ),
+                    arity(
+                            FS_PARAM_VALUE,
+                            FS_PARAM_PICTURE,
+                            optParam("lang", Type.STRING, "The language in which to format the integers.")
+                    )
+            )
+    );
+
+    public FnFormatIntegers(final XQueryContext context, final FunctionSignature signature) {
+        super(context, signature);
+    }
+
+    @Override
+    public Sequence eval(final Sequence[] args, final Sequence contextSequence)
+            throws XPathException {
+        // If $value is an empty sequence, the function returns a zero-length string
+        // https://www.w3.org/TR/xpath-functions-31/#func-format-integer
+        if (args[0].isEmpty()) {
+            return Sequence.EMPTY_SEQUENCE;
+        }
+
+        // If the value of $value is negative, the rules below are applied to the absolute value of $value,
+        // and a minus sign is prepended to the result.
+        final IntegerValue integerValue = (IntegerValue) args[0].itemAt(0);
+        final BigInteger bigInteger = integerValue.toJavaObject(BigInteger.class);
+
+        final IntegerPicture picture = IntegerPicture.fromString(args[1].getStringValue());
+
+        // Build a list of languages to try
+        // the called picture will use the first one with a valid locale
+        final List<String> languages = new ArrayList<>(2);
+        if (args.length == 3 && !args[2].isEmpty()) {
+            languages.add(args[2].getStringValue());
+        }
+        languages.add(context.getDefaultLanguage());
+
+        return new StringValue(picture.formatInteger(bigInteger, languages));
+    }
+}

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

@@ -93,6 +93,8 @@ public class FnModule extends AbstractInternalModule {
         new FunctionDef(FnFormatDates.FNS_FORMAT_DATE_5, FnFormatDates.class),
         new FunctionDef(FnFormatDates.FNS_FORMAT_TIME_2, FnFormatDates.class),
         new FunctionDef(FnFormatDates.FNS_FORMAT_TIME_5, FnFormatDates.class),
+        new FunctionDef(FnFormatIntegers.FS_FORMAT_INTEGER[0], FnFormatIntegers.class),
+        new FunctionDef(FnFormatIntegers.FS_FORMAT_INTEGER[1], FnFormatIntegers.class),
         new FunctionDef(FnFormatNumbers.FS_FORMAT_NUMBER[0], FnFormatNumbers.class),
         new FunctionDef(FnFormatNumbers.FS_FORMAT_NUMBER[1], FnFormatNumbers.class),
         new FunctionDef(FunGenerateId.signatures[0], FunGenerateId.class),