evolvedbinary / elemental / 982

Committed 29 Apr 2025 08:34PM UTC coverage: 56.409% (+0.007%) from 56.402%

Build # 982

Build Type

push

circleci

Committed by

adamretter

Commit Message

[feature] Improve README.md badges

Run Details

28451 of 55847 branches covered (50.94%)

Branch coverage included in aggregate %.

77468 of 131924 relevant lines covered (58.72%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

20.45

/exist-core/src/main/java/org/exist/xquery/functions/system/FunctionAvailable.java

/*
 * Elemental
 * Copyright (C) 2024, Evolved Binary Ltd
 *
 * admin@evolvedbinary.com
 * https://www.evolvedbinary.com | https://www.elemental.xyz
 *
 * Use of this software is governed by the Business Source License 1.1
 * included in the LICENSE file and at www.mariadb.com/bsl11.
 *
 * Change Date: 2028-04-27
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by the Apache License, Version 2.0.
 *
 * Additional Use Grant: Production use of the Licensed Work for a permitted
 * purpose. A Permitted Purpose is any purpose other than a Competing Use.
 * A Competing Use means making the Software available to others in a commercial
 * product or service that: substitutes for the Software; substitutes for any
 * other product or service we offer using the Software that exists as of the
 * date we make the Software available; or offers the same or substantially
 * similar functionality as the Software.
 *
 * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
 *       The original license header is included below.
 *
 * =====================================================================
 *
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * info@exist-db.org
 * 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.system;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.exist.dom.QName;
import org.exist.xquery.*;
import org.exist.xquery.value.BooleanValue;
import org.exist.xquery.value.FunctionParameterSequenceType;
import org.exist.xquery.value.FunctionReturnSequenceType;
import org.exist.xquery.value.IntegerValue;
import org.exist.xquery.value.QNameValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;

import javax.annotation.Nullable;

/**
 * Return whether the function is available
 * 
 * @author <a href="mailto:adam@exist-db.org">Adam Retter</a>
 */
public class FunctionAvailable extends BasicFunction {

    protected final static Logger logger = LogManager.getLogger(FunctionAvailable.class);
    public final static FunctionSignature signature =
            new FunctionSignature(
            new QName("function-available", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),
            "Returns whether a function is available.",
            new SequenceType[]{
                new FunctionParameterSequenceType("function-name", Type.QNAME, Cardinality.EXACTLY_ONE, "The fully qualified name of the function"),
                new FunctionParameterSequenceType("arity", Type.INTEGER, Cardinality.EXACTLY_ONE, "The arity of the function")
            },
            new FunctionReturnSequenceType(Type.BOOLEAN, Cardinality.EXACTLY_ONE, "true() if the function exists, false() otherwise."));

    public FunctionAvailable(XQueryContext context) {
        super(context, signature);
    }

    @Override
    public Sequence eval(final Sequence[] args, final Sequence contextSequence) throws XPathException {
        final QName functionName = ((QNameValue)args[0].itemAt(0)).getQName();
        final int arity = ((IntegerValue)args[1].itemAt(0)).getInt();
        
        @Nullable final org.exist.xquery.Module[] modules = context.getModules(functionName.getNamespaceURI());
        boolean found = false;
        if (modules == null || modules.length == 0) {
            found = context.resolveFunction(functionName, arity) != null;
        } else {
            for (final org.exist.xquery.Module module : modules) {
                if (module instanceof InternalModule) {
                    found = ((InternalModule)module).getFunctionDef(functionName, arity) != null;
                } else if (module instanceof ExternalModule) {
                    found = ((ExternalModule)module).getFunction(functionName, arity, context) != null;
                }

                if (found) {
                    break;
                }
            }
        }
        
        return BooleanValue.valueOf(found);
    }    
}

1	/*
2	* Elemental
3	* Copyright (C) 2024, Evolved Binary Ltd
4	*
5	* admin@evolvedbinary.com
6	* https://www.evolvedbinary.com \| https://www.elemental.xyz
7	*
8	* Use of this software is governed by the Business Source License 1.1
9	* included in the LICENSE file and at www.mariadb.com/bsl11.
10	*
11	* Change Date: 2028-04-27
12	*
13	* On the date above, in accordance with the Business Source License, use
14	* of this software will be governed by the Apache License, Version 2.0.
15	*
16	* Additional Use Grant: Production use of the Licensed Work for a permitted
17	* purpose. A Permitted Purpose is any purpose other than a Competing Use.
18	* A Competing Use means making the Software available to others in a commercial
19	* product or service that: substitutes for the Software; substitutes for any
20	* other product or service we offer using the Software that exists as of the
21	* date we make the Software available; or offers the same or substantially
22	* similar functionality as the Software.
23	*
24	* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
25	* The original license header is included below.
26	*
27	* =====================================================================
28	*
29	* eXist-db Open Source Native XML Database
30	* Copyright (C) 2001 The eXist-db Authors
31	*
32	* info@exist-db.org
33	* http://www.exist-db.org
34	*
35	* This library is free software; you can redistribute it and/or
36	* modify it under the terms of the GNU Lesser General Public
37	* License as published by the Free Software Foundation; either
38	* version 2.1 of the License, or (at your option) any later version.
39	*
40	* This library is distributed in the hope that it will be useful,
41	* but WITHOUT ANY WARRANTY; without even the implied warranty of
42	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
43	* Lesser General Public License for more details.
44	*
45	* You should have received a copy of the GNU Lesser General Public
46	* License along with this library; if not, write to the Free Software
47	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
48	*/
49	package org.exist.xquery.functions.system;
50
51	import org.apache.logging.log4j.LogManager;
52	import org.apache.logging.log4j.Logger;
53	import org.exist.dom.QName;
54	import org.exist.xquery.*;
55	import org.exist.xquery.value.BooleanValue;
56	import org.exist.xquery.value.FunctionParameterSequenceType;
57	import org.exist.xquery.value.FunctionReturnSequenceType;
58	import org.exist.xquery.value.IntegerValue;
59	import org.exist.xquery.value.QNameValue;
60	import org.exist.xquery.value.Sequence;
61	import org.exist.xquery.value.SequenceType;
62	import org.exist.xquery.value.Type;
63
64	import javax.annotation.Nullable;
65
66	/**
67	* Return whether the function is available
68	*
69	* @author <a href="mailto:adam@exist-db.org">Adam Retter</a>
70	*/
71	public class FunctionAvailable extends BasicFunction {
72
73	protected final static Logger logger = LogManager.getLogger(FunctionAvailable.class);	1✔
74	public final static FunctionSignature signature =	1✔
75	new FunctionSignature(	1✔
76	new QName("function-available", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),	1✔
77	"Returns whether a function is available.",	1✔
78	new SequenceType[]{	1✔
79	new FunctionParameterSequenceType("function-name", Type.QNAME, Cardinality.EXACTLY_ONE, "The fully qualified name of the function"),	1✔
80	new FunctionParameterSequenceType("arity", Type.INTEGER, Cardinality.EXACTLY_ONE, "The arity of the function")	1✔
81	},
82	new FunctionReturnSequenceType(Type.BOOLEAN, Cardinality.EXACTLY_ONE, "true() if the function exists, false() otherwise."));	1✔
83
84	public FunctionAvailable(XQueryContext context) {
85	super(context, signature);	×
86	}	×
87
88	@Override
89	public Sequence eval(final Sequence[] args, final Sequence contextSequence) throws XPathException {
90	final QName functionName = ((QNameValue)args[0].itemAt(0)).getQName();	×
91	final int arity = ((IntegerValue)args[1].itemAt(0)).getInt();	×
92
93	@Nullable final org.exist.xquery.Module[] modules = context.getModules(functionName.getNamespaceURI());	×
94	boolean found = false;	×
95	if (modules == null \|\| modules.length == 0) {	×
96	found = context.resolveFunction(functionName, arity) != null;	×
97	} else {	×
98	for (final org.exist.xquery.Module module : modules) {	×
99	if (module instanceof InternalModule) {	×
100	found = ((InternalModule)module).getFunctionDef(functionName, arity) != null;	×
101	} else if (module instanceof ExternalModule) {	×
102	found = ((ExternalModule)module).getFunction(functionName, arity, context) != null;	×
103	}
104
105	if (found) {	×
106	break;	×
107	}
108	}
109	}
110
111	return BooleanValue.valueOf(found);	×
112	}
113	}

evolvedbinary / elemental / 982

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous