simple-xspec-wrapper 0.1.0-java

data/vendor/xspec-1.0.0/src/harnesses/basex/basex-xquery-harness.xproc

@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ===================================================================== -->
+<!--  File:       basex-xquery-harness.xproc                               -->
+<!--  Author:     Florent Georges                                          -->
+<!--  Date:       2011-08-30                                               -->
+<!--  URI:        http://xspec.googlecode.com/                             -->
+<!--  Tags:                                                                -->
+<!--    Copyright (c) 2011 Florent Georges (see end of file.)              -->
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<p:pipeline xmlns:p="http://www.w3.org/ns/xproc" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:t="http://www.jenitennison.com/xslt/xspec" xmlns:pkg="http://expath.org/ns/pkg" pkg:import-uri="http://www.jenitennison.com/xslt/xspec/basex/harness/xquery.xproc" name="basex-xquery-harness" type="t:basex-xquery-harness" version="1.0">
+	<p:documentation>
+		<p>This pipeline executes an XSpec test suite with BaseX standalone.</p>
+		<p><b>Primary input:</b> A XSpec test suite document.</p>
+		<p><b>Primary output:</b> A formatted HTML XSpec report.</p>
+		<p>The dir where you unzipped the XSpec archive on your filesystem is passed
+			in the option 'xspec-home'.  The compiled test suite (the XQuery file to be
+			actually evaluated) is saved on the filesystem to be passed to BaseX.  The
+			name of this file is passed in the option 'compiled-file' (it defaults to a
+			file in /tmp).</p>
+	</p:documentation>
+
+	<p:serialization port="result" indent="true" method="xhtml" encoding="UTF-8" include-content-type="true"/>
+
+	<p:option name="xspec-home" required="true"/>
+	<p:option name="basex-jar" required="true"/>
+	<!-- TODO: Use a robust way to get a tmp file name from the OS... -->
+	<p:option name="compiled-file" select="'file:/tmp/xspec-basex-compiled-suite.xq'"/>
+	<!-- TODO: Use the absolute URIs through the EXPath Packaging System. -->
+	<p:variable name="compiler" select="resolve-uri('src/compiler/generate-query-tests.xsl', $xspec-home)"/>
+	<p:variable name="formatter" select="resolve-uri('src/reporter/format-xspec-report.xsl', $xspec-home)"/>
+	<p:variable name="utils-lib" select="resolve-uri('src/compiler/generate-query-utils.xql', $xspec-home)"/>
+
+	<p:string-replace match="xsl:import/@href" name="compiler">
+		<p:with-option name="replace" select="concat('''', $compiler, '''')"/>
+		<p:input port="source">
+			<p:inline>
+				<xsl:stylesheet version="2.0">
+					<xsl:import href="..."/>
+					<xsl:template match="/">
+						<c:query>
+							<xsl:call-template name="t:generate-tests"/>
+						</c:query>
+					</xsl:template>
+				</xsl:stylesheet>
+			</p:inline>
+		</p:input>
+	</p:string-replace>
+
+	<p:xslt name="compile">
+		<p:input port="source">
+			<p:pipe step="basex-xquery-harness" port="source"/>
+		</p:input>
+		<p:input port="stylesheet">
+			<p:pipe step="compiler" port="result"/>
+		</p:input>
+		<p:with-param name="utils-library-at" select="$utils-lib"/>
+	</p:xslt>
+
+	<p:escape-markup name="escape"/>
+
+	<p:store method="text">
+		<p:with-option name="href" select="$compiled-file"/>
+	</p:store>
+
+	<!-- rely on a script 'basex' being in the PATH -->
+	<!--p:exec command="basex" name="run">
+	  <p:with-option name="args" select="$compiled-file"/>
+	  <p:input port="source">
+		 <p:empty/>
+	  </p:input>
+   	</p:exec-->
+	<p:exec command="java" name="run">
+		<p:with-option name="args" select="string-join(('-cp', $basex-jar, 'org.basex.BaseX', $compiled-file),' ')"/>
+		<p:input port="source">
+			<p:empty/>
+		</p:input>
+	</p:exec>
+
+	<p:choose>
+		<p:when test="exists(/c:result/t:report)">
+			<p:load name="formatter">
+				<p:with-option name="href" select="$formatter"/>
+			</p:load>
+			<p:unwrap name="unwrap" match="/c:result">
+				<p:input port="source">
+					<p:pipe step="run" port="result"/>
+				</p:input>
+			</p:unwrap>
+			<p:xslt name="format-report">
+				<p:input port="source">
+					<p:pipe step="unwrap" port="result"/>
+				</p:input>
+				<p:input port="stylesheet">
+					<p:pipe step="formatter" port="result"/>
+				</p:input>
+			</p:xslt>
+		</p:when>
+		<p:otherwise>
+			<p:error code="t:ERR001">
+				<p:input port="source">
+					<p:pipe step="run" port="result"/>
+				</p:input>
+			</p:error>
+		</p:otherwise>
+	</p:choose>
+</p:pipeline>
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<!-- DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS COMMENT.             -->
+<!--                                                                       -->
+<!-- Copyright (c) 2008, 2010 Jeni Tennison                                -->
+<!--                                                                       -->
+<!-- The contents of this file are subject to the MIT License (see the URI -->
+<!-- http://www.opensource.org/licenses/mit-license.php for details).      -->
+<!--                                                                       -->
+<!-- Permission is hereby granted, free of charge, to any person obtaining -->
+<!-- a copy of this software and associated documentation files (the       -->
+<!-- "Software"), to deal in the Software without restriction, including   -->
+<!-- without limitation the rights to use, copy, modify, merge, publish,   -->
+<!-- distribute, sublicense, and/or sell copies of the Software, and to    -->
+<!-- permit persons to whom the Software is furnished to do so, subject to -->
+<!-- the following conditions:                                             -->
+<!--                                                                       -->
+<!-- The above copyright notice and this permission notice shall be        -->
+<!-- included in all copies or substantial portions of the Software.       -->
+<!--                                                                       -->
+<!-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       -->
+<!-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    -->
+<!-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.-->
+<!-- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  -->
+<!-- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  -->
+<!-- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     -->
+<!-- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                -->
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

data/vendor/xspec-1.0.0/src/harnesses/exist/exist-xquery-harness.xproc

@@ -0,0 +1,161 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ===================================================================== -->
+<!--  File:       exist-xquery-harness.xproc                               -->
+<!--  Author:     Florent Georges                                          -->
+<!--  Date:       2011-08-30                                               -->
+<!--  URI:        http://xspec.googlecode.com/                             -->
+<!--  Tags:                                                                -->
+<!--    Copyright (c) 2011 Florent Georges (see end of file.)              -->
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<p:pipeline xmlns:p="http://www.w3.org/ns/xproc" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:t="http://www.jenitennison.com/xslt/xspec" xmlns:exist="http://exist.sourceforge.net/NS/exist" xmlns:pkg="http://expath.org/ns/pkg" pkg:import-uri="http://www.jenitennison.com/xslt/xspec/exist/harness/xquery.xproc" name="exist-harness" type="t:exist-harness" version="1.0">
+    <p:documentation>
+        <p>This pipeline executes an XSpec test suite on an eXist instance.</p>
+        <p><b>Primary input:</b> A XSpec test suite document.</p>
+        <p><b>Primary output:</b> A formatted HTML XSpec report.</p>
+        <p>The XQuery library module to test must already be on the eXist instance.
+            The instance endpoint is passed in the option 'endpoint'.  The runtime
+            utils library (also known as generate-query-utils.xql) must also be on
+            the instance (its location hint, that is the 'at' clause to use) is
+            passed in the option 'utils-lib'.  The dir where you unzipped the XSpec
+            archive on your filesystem is passed in the option 'xspec-home'.</p>
+    </p:documentation>
+
+    <p:serialization port="result" indent="true" method="xhtml" encoding="UTF-8" include-content-type="true"/>
+
+    <p:option name="xspec-home" required="true"/>
+    <p:option name="query-at"/>
+    <p:option name="utils-lib" select="'xmldb:exist:///db/xspec/generate-query-utils.xql'"/>
+    <p:option name="endpoint" select="'http://localhost:8080/exist/rest/db/'"/>
+    <!-- if set, then save the generated query at this URI -->
+    <p:option name="compiled-uri"/>
+    <!-- if set, then save the generated query at this URI -->
+    <p:option name="report-uri"/>
+
+    <!-- TODO: Use the absolute URIs through the EXPath Packaging System. -->
+    <p:variable name="compiler" select="resolve-uri('src/compiler/generate-query-tests.xsl', $xspec-home)"/>
+    <p:variable name="formatter" select="resolve-uri('src/reporter/format-xspec-report.xsl', $xspec-home)"/>
+
+    <p:string-replace match="xsl:import/@href" name="compiler">
+        <p:with-option name="replace" select="concat('''', $compiler, '''')"/>
+        <p:input port="source">
+            <p:inline>
+                <xsl:stylesheet version="2.0">
+                    <xsl:import href="..."/>
+                    <xsl:template match="/">
+                        <exist:text>
+                            <xsl:call-template name="t:generate-tests"/>
+                        </exist:text>
+                    </xsl:template>
+                </xsl:stylesheet>
+            </p:inline>
+        </p:input>
+    </p:string-replace>
+
+    <p:choose>
+        <p:when test="p:value-available('query-at')">
+            <p:xslt name="compile">
+                <p:input port="source">
+                    <p:pipe step="exist-harness" port="source"/>
+                </p:input>
+                <p:input port="stylesheet">
+                    <p:pipe step="compiler" port="result"/>
+                </p:input>
+                <p:with-param name="query-at" select="$query-at"/>
+                <p:with-param name="utils-library-at" select="$utils-lib"/>
+            </p:xslt>
+        </p:when>
+        <p:otherwise>
+            <p:xslt name="compile">
+                <p:input port="source">
+                    <p:pipe step="exist-harness" port="source"/>
+                </p:input>
+                <p:input port="stylesheet">
+                    <p:pipe step="compiler" port="result"/>
+                </p:input>
+                <p:with-param name="utils-library-at" select="$utils-lib"/>
+            </p:xslt>
+        </p:otherwise>
+    </p:choose>
+
+    <p:escape-markup name="escape"/>
+
+    <p:choose>
+        <p:when test="p:value-available('compiled-uri')">
+            <p:store method="text">
+                <p:with-option name="href" select="$compiled-uri"/>
+            </p:store>
+            <p:identity>
+                <p:input port="source">
+                    <p:pipe step="escape" port="result"/>
+                </p:input>
+            </p:identity>
+        </p:when>
+        <p:otherwise>
+            <p:identity/>
+        </p:otherwise>
+    </p:choose>
+
+    <p:wrap wrapper="exist:query" match="/*"/>
+    <p:wrap wrapper="c:body" match="/*"/>
+    <p:add-attribute attribute-name="content-type" attribute-value="application/xml" match="/*"/>
+    <p:wrap wrapper="c:request" match="/*"/>
+    <p:add-attribute attribute-name="method" attribute-value="POST" match="/*"/>
+    <p:add-attribute attribute-name="href" match="/*">
+        <p:with-option name="attribute-value" select="$endpoint"/>
+    </p:add-attribute>
+    <p:http-request name="run"/>
+    <p:choose>
+        <p:when test="exists(/exist:result/t:report)">
+            <p:load name="formatter">
+                <p:with-option name="href" select="$formatter"/>
+            </p:load>
+            <p:unwrap name="unwrap" match="/c:result">
+                <p:input port="source">
+                    <p:pipe step="run" port="result"/>
+                </p:input>
+            </p:unwrap>
+            <p:xslt name="format-report">
+                <p:input port="source">
+                    <p:pipe step="unwrap" port="result"/>
+                </p:input>
+                <p:input port="stylesheet">
+                    <p:pipe step="formatter" port="result"/>
+                </p:input>
+            </p:xslt>
+        </p:when>
+        <p:otherwise>
+            <p:error code="t:ERR001">
+                <p:input port="source">
+                    <p:pipe step="run" port="result"/>
+                </p:input>
+            </p:error>
+        </p:otherwise>
+    </p:choose>
+</p:pipeline>
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<!-- DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS COMMENT.             -->
+<!--                                                                       -->
+<!-- Copyright (c) 2008, 2010 Jeni Tennison                                -->
+<!--                                                                       -->
+<!-- The contents of this file are subject to the MIT License (see the URI -->
+<!-- http://www.opensource.org/licenses/mit-license.php for details).      -->
+<!--                                                                       -->
+<!-- Permission is hereby granted, free of charge, to any person obtaining -->
+<!-- a copy of this software and associated documentation files (the       -->
+<!-- "Software"), to deal in the Software without restriction, including   -->
+<!-- without limitation the rights to use, copy, modify, merge, publish,   -->
+<!-- distribute, sublicense, and/or sell copies of the Software, and to    -->
+<!-- permit persons to whom the Software is furnished to do so, subject to -->
+<!-- the following conditions:                                             -->
+<!--                                                                       -->
+<!-- The above copyright notice and this permission notice shall be        -->
+<!-- included in all copies or substantial portions of the Software.       -->
+<!--                                                                       -->
+<!-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       -->
+<!-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    -->
+<!-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.-->
+<!-- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  -->
+<!-- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  -->
+<!-- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     -->
+<!-- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                -->
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

data/vendor/xspec-1.0.0/src/harnesses/harness-lib.xpl

@@ -0,0 +1,327 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ===================================================================== -->
+<!--  File:       harness-lib.xpl                                          -->
+<!--  Author:     Florent Georges                                          -->
+<!--  Date:       2011-11-08                                               -->
+<!--  URI:        http://xspec.googlecode.com/                             -->
+<!--  Tags:                                                                -->
+<!--    Copyright (c) 2011 Florent Georges (see end of file.)              -->
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+
+
+<p:library xmlns:p="http://www.w3.org/ns/xproc"
+           xmlns:c="http://www.w3.org/ns/xproc-step"
+           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+           xmlns:t="http://www.jenitennison.com/xslt/xspec"
+           xmlns:pkg="http://expath.org/ns/pkg"
+           pkg:import-uri="#none"
+           version="1.0">
+
+   <!--
+       Ensure there is exactly one document on the input port.
+       
+       If this is the case, it behaves like p:identity, if not, it throws an error.
+       
+       TODO: Does not work as is...
+   -->
+   <!--p:declare-step type="t:ensure-input">
+      <p:input  port="source" primary="true"/>
+      <p:output port="result" primary="true"/>
+      <p:choose>
+         <p:xpath-context>
+            <p:pipe step="ensure-input" port="source"/>
+         </p:xpath-context>
+         <p:when test="empty(/)">
+            <p:error code="t:ERR002"/>
+         </p:when>
+         <p:otherwise>
+            <p:identity/>
+         </p:otherwise>
+      </p:choose>
+   </p:declare-step-->
+
+   <!--
+       Short-cut for p:parameters which passes through input, with primary parameters input.
+       
+       Inspired from Geert Josten util library:
+       https://github.com/grtjn/xproc-ebook-conv/blob/master/src/nl/grtjn/xproc/util/utils.xpl
+   -->
+   <p:declare-step type="t:parameters" name="parameters">
+      <p:input port="source"        primary="true"/>
+      <p:input port="in-parameters" primary="true" kind="parameter" sequence="true"/>
+      <p:output port="result"       primary="true">
+         <p:pipe step="parameters" port="source"/>
+      </p:output>
+      <p:output port="parameters"   primary="false">
+         <p:pipe step="params" port="result"/>
+      </p:output>
+      <p:parameters name="params">
+         <p:input port="parameters">
+            <p:pipe step="parameters" port="in-parameters"/>
+         </p:input>
+      </p:parameters>
+   </p:declare-step>
+
+   <!--
+       Pass through and possibly log the input.
+       
+       If there is a parameter with the name $if-set, its value must be a URI, where
+       to log the input.  If there is not, then no log is produced.
+   -->
+   <p:declare-step type="t:log" name="log">
+      <!-- the port declarations -->
+      <p:input  port="source"     primary="true"/>
+      <p:input  port="parameters" primary="true" kind="parameter"/>
+      <p:output port="result"     primary="true"/>
+      <p:option name="if-set" required="true"/>
+      <!-- retrieve the params -->
+      <t:parameters name="params"/>
+      <p:group>
+         <p:variable name="uri" select="/c:param-set/c:param[@name eq $if-set]/@value">
+            <p:pipe step="params" port="parameters"/>
+         </p:variable>
+         <p:choose>
+            <p:when test="$uri">
+               <p:store method="text">
+                  <p:with-option name="href" select="$uri"/>
+               </p:store>
+               <p:identity>
+                  <p:input port="source">
+                     <p:pipe step="log" port="source"/>
+                  </p:input>
+               </p:identity>
+            </p:when>
+            <p:otherwise>
+               <p:identity/>
+            </p:otherwise>
+         </p:choose>
+      </p:group>
+   </p:declare-step>
+
+   <!--
+       Compile the suite on source into a stylesheet on result.
+   -->
+   <p:declare-step type="t:compile-xslt" name="compile-xsl">
+      <!-- the port declarations -->
+      <p:input  port="source"     primary="true"/>
+      <p:input  port="parameters" primary="true" kind="parameter"/>
+      <p:output port="result"     primary="true"/>
+      <!-- retrieve the params -->
+      <t:parameters name="params"/>
+      <p:group>
+         <p:variable name="xspec-home" select="
+             /c:param-set/c:param[@name eq 'xspec-home']/@value">
+            <p:pipe step="params" port="parameters"/>
+         </p:variable>
+         <p:variable name="compiler-uri" select="
+             /c:param-set/c:param[@name eq 'compiler-uri']/@value">
+            <p:pipe step="params" port="parameters"/>
+         </p:variable>
+         <!-- if compiler-uri is not passed, then use xspec-home to resolve the compiler -->
+         <!-- if xspec-home is not passed, then use the packaging public URI -->
+         <p:variable name="compiler" select="
+             if ( $compiler-uri ) then
+               $compiler-uri
+             else if ( $xspec-home ) then
+               resolve-uri('src/compiler/generate-xspec-tests.xsl', $xspec-home)
+             else
+               'http://www.jenitennison.com/xslt/xspec/generate-xspec-tests.xsl'"/>
+         <!-- load the compiler -->
+         <p:load name="compiler" pkg:kind="xslt">
+            <p:with-option name="href" select="$compiler"/>
+         </p:load>
+         <!-- actually compile the suite in a stylesheet -->
+         <p:xslt>
+            <p:input port="source">
+               <p:pipe port="source" step="compile-xsl"/>
+            </p:input>
+            <p:input port="stylesheet">
+               <p:pipe port="result" step="compiler"/>
+            </p:input>
+            <p:input port="parameters">
+               <p:empty/>
+            </p:input>
+         </p:xslt>
+      </p:group>
+      <!-- log the result? -->
+      <t:log if-set="log-compilation">
+         <p:input port="parameters">
+            <p:pipe step="params" port="parameters"/>
+         </p:input>
+      </t:log>
+   </p:declare-step>
+
+   <!--
+       Compile the suite on source into a query on result.
+       
+       The query is wrapped into an element c:query.  Parameters to the XSpec
+       XQuery compiler, AKA generate-query-tests.xsl, can be passed on the
+       parameters port (e.g. utils-library-at to set the at location hint to use
+       to import the XSpec utils library module in the generated query).
+   -->
+   <p:declare-step type="t:compile-xquery" name="compile-xq">
+      <!-- the port declarations -->
+      <p:input  port="source" primary="true"/>
+      <p:input  port="parameters" kind="parameter"/>
+      <p:output port="result" primary="true"/>
+      <!-- retrieve the params -->
+      <t:parameters name="params"/>
+      <p:group>
+        <!-- param: xspec-home: the dir with the sources of XSpec if EXPath packaging
+             is not supported -->
+         <p:variable name="xspec-home" select="
+             /c:param-set/c:param[@name eq 'xspec-home']/@value">
+            <p:pipe step="params" port="parameters"/>
+         </p:variable>
+         <!-- param: compiler-uri: the URI of the XSpec compiler to XQuery -->
+         <p:variable name="compiler-uri" select="
+             /c:param-set/c:param[@name eq 'compiler-uri']/@value">
+            <p:pipe step="params" port="parameters"/>
+         </p:variable>
+         <!-- if compiler-uri is not passed, then use xspec-home to resolve the compiler -->
+         <!-- if xspec-home is not passed, then use the packaging public URI -->
+         <p:variable name="compiler" select="
+             if ( $compiler-uri ) then
+               $compiler-uri
+             else if ( $xspec-home ) then
+               resolve-uri('src/compiler/generate-query-tests.xsl', $xspec-home)
+             else
+               'http://www.jenitennison.com/xslt/xspec/generate-query-tests.xsl'"/>
+         <!-- wrap the generated query in a c:query element -->
+         <p:string-replace match="xsl:import/@href" name="compiler">
+            <p:with-option name="replace" select="concat('''', $compiler, '''')"/>
+            <p:input port="source">
+               <p:inline>
+                  <!-- TODO: I think this is due to a bug in Calabash, if I don't create a node
+                       using the prefix 't', then the biding is not visible to Saxon and it throws
+                       a compilation error for this stylesheet... -->
+                  <xsl:stylesheet version="2.0" t:dummy="...">
+                     <xsl:import href="..."/>
+                     <xsl:template match="/">
+                        <c:query>
+                           <xsl:call-template name="t:generate-tests"/>
+                        </c:query>
+                     </xsl:template>
+                  </xsl:stylesheet>
+               </p:inline>
+            </p:input>
+         </p:string-replace>
+         <!-- actually compile the suite in a query -->
+         <p:xslt name="do-it">
+            <p:input port="source">
+               <p:pipe step="compile-xq" port="source"/>
+            </p:input>
+            <p:input port="stylesheet">
+               <p:pipe step="compiler" port="result"/>
+            </p:input>
+         </p:xslt>
+      </p:group>
+      <!-- log the result? -->
+      <t:log if-set="log-compilation">
+         <p:input port="parameters">
+            <p:pipe step="params" port="parameters"/>
+         </p:input>
+      </t:log>
+   </p:declare-step>
+
+   <!--
+       Get the XML report on source, and give the HTML report on result.
+       
+       If xspec-home is set, it is used to resolve the XSLT that formats the
+       report.  If not, its public URI is used, to be resolved through the
+       EXPath packaging system.  If the document element is not an XSpec
+       t:report, the error t:ERR001 is thrown.
+   -->
+   <p:declare-step type="t:format-report" name="format">
+      <!-- the port declarations -->
+      <p:input  port="source"     primary="true"/>
+      <p:input  port="parameters" kind="parameter"/>
+      <p:output port="result"     primary="true"/>
+      <!-- retrieve the params -->
+      <t:parameters name="params"/>
+      <p:group>
+        <!-- param: xspec-home: the dir with the sources of XSpec if EXPath packaging
+             is not supported -->
+         <p:variable name="xspec-home" select="
+             /c:param-set/c:param[@name eq 'xspec-home']/@value">
+            <p:pipe step="params" port="parameters"/>
+         </p:variable>
+         <!-- either the public URI, or resolved from xspec-home if packaging not supported -->
+         <p:variable name="formatter" select="
+             if ( $xspec-home ) then
+               resolve-uri('src/reporter/format-xspec-report.xsl', $xspec-home)
+             else
+               'http://www.jenitennison.com/xslt/xspec/format-xspec-report.xsl'"/>
+         <!-- log the report? -->
+         <t:log if-set="log-xml-report">
+            <p:input port="parameters">
+               <p:pipe step="format" port="parameters"/>
+            </p:input>
+         </t:log>
+         <!-- if there is a report, format it, or it is an error -->
+         <p:choose>
+            <p:when test="exists(/t:report)">
+               <p:load name="formatter" pkg:kind="xslt">
+                  <p:with-option name="href" select="$formatter"/>
+               </p:load>
+               <p:xslt name="format-report">
+                  <p:input port="source">
+                     <p:pipe step="format" port="source"/>
+                  </p:input>
+                  <p:input port="stylesheet">
+                     <p:pipe step="formatter" port="result"/>
+                  </p:input>
+                  <p:input port="parameters">
+                     <p:empty/>
+                  </p:input>
+               </p:xslt>
+            </p:when>
+            <p:otherwise>
+               <p:error code="t:ERR001">
+                  <p:input port="source">
+                     <p:inline>
+                        <message>Not a t:report document</message>
+                     </p:inline>
+                  </p:input>
+               </p:error>
+            </p:otherwise>
+         </p:choose>
+      </p:group>
+      <!-- log the report? -->
+      <t:log if-set="log-report">
+         <p:input port="parameters">
+            <p:pipe step="format" port="parameters"/>
+         </p:input>
+      </t:log>
+   </p:declare-step>
+
+</p:library>
+
+
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+<!-- DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS COMMENT.             -->
+<!--                                                                       -->
+<!-- Copyright (c) 2011 Florent Georges                                    -->
+<!--                                                                       -->
+<!-- The contents of this file are subject to the MIT License (see the URI -->
+<!-- http://www.opensource.org/licenses/mit-license.php for details).      -->
+<!--                                                                       -->
+<!-- Permission is hereby granted, free of charge, to any person obtaining -->
+<!-- a copy of this software and associated documentation files (the       -->
+<!-- "Software"), to deal in the Software without restriction, including   -->
+<!-- without limitation the rights to use, copy, modify, merge, publish,   -->
+<!-- distribute, sublicense, and/or sell copies of the Software, and to    -->
+<!-- permit persons to whom the Software is furnished to do so, subject to -->
+<!-- the following conditions:                                             -->
+<!--                                                                       -->
+<!-- The above copyright notice and this permission notice shall be        -->
+<!-- included in all copies or substantial portions of the Software.       -->
+<!--                                                                       -->
+<!-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       -->
+<!-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    -->
+<!-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.-->
+<!-- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  -->
+<!-- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  -->
+<!-- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     -->
+<!-- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                -->
+<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->