Fixes in xsl:choose and xsl:copy-of + better docs (#90)

leonelsanchesdasilva · web-flow · commit 19b85e446b83 · 2024-03-23T10:09:13.000-07:00
* Checking a corresponding `outputNode` in `xsltChoose` instead of using the `output` directly.

* - Resolving predence with `copy-of`;
- Improving `options.cData` documentation;
- Escaping text under `CDATA` as especified by XSLT CDATA spec.
diff --git a/README.md b/README.md
@@ -74,6 +74,7 @@ const options = {
 const xslt = new Xslt(options);
 ```
 
+- `cData` (`boolean`, default `true`): resolves CDATA elements in the output. Content under CDATA is resolved as text. This overrides `escape` for CDATA content.
 - `escape` (`boolean`, default `true`): replaces symbols like `<`, `>`, `&` and `"` by the corresponding [XML entities](https://www.tutorialspoint.com/xml/xml_character_entities.htm).
 - `selfClosingTags` (`boolean`, default `true`): Self-closes tags that don't have inner elements, if `true`. For instance, `<test></test>` becomes `<test />`.
 - `outputMethod` (`string`, default `xml`): Specifies the default output method. if `<xsl:output>` is declared in your XSLT file, this will be overridden.
diff --git a/interactive-tests/js/simplelog.js b/interactive-tests/js/simplelog.js
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005-2006 Google
 //
diff --git a/interactive-tests/xpath.html b/interactive-tests/xpath.html
@@ -2,7 +2,7 @@
     <head>
         <script type="application/javascript" src="js/xslt-processor.js"></script>
         <script>
-            // Copyright 2023 Design Liquido
+            // Copyright 2023-2024 Design Liquido
             // Copyright 2018 Johannes Wilm
             // Copyright 2005 Google Inc.
             // All Rights Reserved
diff --git a/src/dom/functions.ts b/src/dom/functions.ts
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005 Google Inc.
 // All Rights Reserved
diff --git a/src/dom/util.ts b/src/dom/util.ts
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005 Google
 //
diff --git a/src/dom/xml-functions.ts b/src/dom/xml-functions.ts
@@ -77,35 +77,40 @@ export function xmlValue2(node: any, disallowBrowserSpecificOptimization: boolea
         return '';
     }
 
-    let ret = '';
-    if (node.nodeType == DOM_TEXT_NODE || node.nodeType == DOM_CDATA_SECTION_NODE) {
-        ret += node.nodeValue;
-    } else if (node.nodeType == DOM_ATTRIBUTE_NODE) {
-        ret += node.nodeValue;
-    } else if (
-        node.nodeType == DOM_ELEMENT_NODE ||
-        node.nodeType == DOM_DOCUMENT_NODE ||
-        node.nodeType == DOM_DOCUMENT_FRAGMENT_NODE
-    ) {
-        if (!disallowBrowserSpecificOptimization) {
-            // IE, Safari, Opera, and friends
-            const innerText = node.innerText;
-            if (innerText != undefined) {
-                return innerText;
+    let returnedXmlString = '';
+    switch (node.nodeType) {
+        case DOM_ATTRIBUTE_NODE:
+        case DOM_TEXT_NODE:
+            returnedXmlString += node.nodeValue;
+            break;
+        case DOM_CDATA_SECTION_NODE:
+            returnedXmlString += node.nodeValue;
+            break;
+        case DOM_DOCUMENT_NODE:
+        case DOM_DOCUMENT_FRAGMENT_NODE:
+        case DOM_ELEMENT_NODE:
+            if (!disallowBrowserSpecificOptimization) {
+                // IE, Safari, Opera, and friends
+                const innerText = node.innerText;
+                if (innerText != undefined) {
+                    return innerText;
+                }
+                // Firefox
+                const textContent = node.textContent;
+                if (textContent != undefined) {
+                    return textContent;
+                }
             }
-            // Firefox
-            const textContent = node.textContent;
-            if (textContent != undefined) {
-                return textContent;
+
+            const len = node.transformedChildNodes.length;
+            for (let i = 0; i < len; ++i) {
+                returnedXmlString += xmlValue(node.transformedChildNodes[i]);
             }
-        }
 
-        const len = node.transformedChildNodes.length;
-        for (let i = 0; i < len; ++i) {
-            ret += xmlValue(node.transformedChildNodes[i]);
-        }
+            break;
     }
-    return ret;
+
+    return returnedXmlString;
 }
 
 /**
@@ -117,7 +122,7 @@ export function xmlValue2(node: any, disallowBrowserSpecificOptimization: boolea
  * @see xmlTransformedText
  */
 export function xmlText(node: XNode, options: XmlOutputOptions = {
-    cData: false,
+    cData: true,
     escape: true,
     selfClosingTags: true,
     outputMethod: 'xml'
@@ -181,7 +186,7 @@ function xmlTextRecursive(node: XNode, buffer: string[], options: XmlOutputOptio
 export function xmlTransformedText(
     node: XNode,
     options: XmlOutputOptions = {
-        cData: false,
+        cData: true,
         escape: true,
         selfClosingTags: true,
         outputMethod: 'xml'
@@ -205,7 +210,7 @@ function xmlTransformedTextRecursive(node: XNode, buffer: any[], options: XmlOut
         }
     } else if (nodeType === DOM_CDATA_SECTION_NODE) {
         if (options.cData) {
-            buffer.push(nodeValue);
+            buffer.push(xmlEscapeText(nodeValue));
         } else {
             buffer.push(`<![CDATA[${nodeValue}]]>`);
         }
diff --git a/src/dom/xmltoken.ts b/src/dom/xmltoken.ts
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2006 Google Inc.
 // All Rights Reserved
diff --git a/src/xpath/xpath.ts b/src/xpath/xpath.ts
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005 Google Inc.
 // All Rights Reserved
diff --git a/src/xpathdebug.ts b/src/xpathdebug.ts
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005 Google Inc.
 // All Rights Reserved
diff --git a/src/xslt/xslt-options.ts b/src/xslt/xslt-options.ts
@@ -1,6 +1,7 @@
 import { XsltParameter } from "./xslt-parameter"
 
 export type XsltOptions = {
+    cData: boolean,
     escape: boolean,
     selfClosingTags: boolean,
     parameters?: XsltParameter[]
diff --git a/src/xslt/xslt.ts b/src/xslt/xslt.ts
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005 Google Inc.
 // All Rights Reserved
@@ -38,7 +38,7 @@ import {
     DOM_TEXT_NODE
 } from '../constants';
 
-import { StringValue, NodeSetValue } from '../xpath/values';
+import { StringValue, NodeSetValue, NodeValue } from '../xpath/values';
 import { XsltOptions } from './xslt-options';
 import { XsltDecimalFormatSettings } from './xslt-decimal-format-settings';
 import { MatchResolver } from '../xpath/match-resolver';
@@ -80,6 +80,7 @@ export class Xslt {
 
     constructor(
         options: Partial<XsltOptions> = {
+            cData: true,
             escape: true,
             selfClosingTags: true,
             parameters: []
@@ -88,6 +89,7 @@ export class Xslt {
         this.xPath = new XPath();
         this.matchResolver = new MatchResolver();
         this.options = {
+            cData: options.cData === true,
             escape: options.escape === true,
             selfClosingTags: options.selfClosingTags === true,
             parameters: options.parameters || []
@@ -127,7 +129,7 @@ export class Xslt {
 
         this.xsltProcessContext(expressionContext, stylesheet, this.outputDocument);
         const transformedOutputXml = xmlTransformedText(outputDocument, {
-            cData: false,
+            cData: this.options.cData,
             escape: this.options.escape,
             selfClosingTags: this.options.selfClosingTags,
             outputMethod: this.outputMethod
@@ -327,7 +329,7 @@ export class Xslt {
                 case 'copy-of':
                     select = xmlGetAttribute(template, 'select');
                     value = this.xPath.xPathEval(select, context);
-                    const destinationNode = output || context.outputNodeList[context.outputPosition];
+                    const destinationNode = context.outputNodeList[context.outputPosition] || output;
                     if (value.type === 'node-set') {
                         nodes = value.nodeSetValue();
                         for (let i = 0; i < nodes.length; ++i) {
@@ -488,9 +490,9 @@ export class Xslt {
      * `xsl:otherwise`.
      * @param context The Expression Context.
      * @param template The template.
-     * @param output The output.
+     * @param output The output. Only used if there's no corresponding output node already defined.
      */
-    protected xsltChoose(context: ExprContext, template: XNode, output: any) {
+    protected xsltChoose(context: ExprContext, template: XNode, output: XNode) {
         for (const childNode of template.childNodes) {
             if (childNode.nodeType !== DOM_ELEMENT_NODE) {
                 continue;
@@ -499,11 +501,13 @@ export class Xslt {
             if (this.isXsltElement(childNode, 'when')) {
                 const test = xmlGetAttribute(childNode, 'test');
                 if (this.xPath.xPathEval(test, context).booleanValue()) {
-                    this.xsltChildNodes(context, childNode, output);
+                    const outputNode = context.outputNodeList[context.outputPosition] || output;
+                    this.xsltChildNodes(context, childNode, outputNode);
                     break;
                 }
             } else if (this.isXsltElement(childNode, 'otherwise')) {
-                this.xsltChildNodes(context, childNode, output);
+                const outputNode = context.outputNodeList[context.outputPosition] || output;
+                this.xsltChildNodes(context, childNode, outputNode);
                 break;
             }
         }
@@ -557,12 +561,6 @@ export class Xslt {
         } else {
             const node = this.xsltCopy(destination, source);
             if (node) {
-                // This was an element node -- recurse to attributes and
-                // children.
-                /* for (let i = 0; i < source.attributes.length; ++i) {
-                    this.xsltCopyOf(node, source.attributes[i]);
-                } */
-
                 for (let i = 0; i < source.childNodes.length; ++i) {
                     this.xsltCopyOf(node, source.childNodes[i]);
                 }
@@ -679,7 +677,7 @@ export class Xslt {
         const name = xmlGetAttribute(template, 'name');
         const select = xmlGetAttribute(template, 'select');
 
-        let value: any;
+        let value: NodeValue;
 
         const nonAttributeChildren = template.childNodes.filter(n => n.nodeType !== DOM_ATTRIBUTE_NODE);
         if (nonAttributeChildren.length > 0) {
diff --git a/tests/dom.test.tsx b/tests/dom.test.tsx
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005 Google Inc.
 // All Rights Reserved
diff --git a/tests/xml/html.test.tsx b/tests/xml/html.test.tsx
@@ -108,7 +108,7 @@ describe('HTML', () => {
         const xmlParser = new XmlParser();
         const parsedHtml = xmlParser.xmlParse(htmlString);
         const outHtmlString = xmlText(parsedHtml, {
-            cData: false,
+            cData: true,
             selfClosingTags: false,
             escape: true,
             outputMethod: 'html'
diff --git a/tests/xml/xml.test.tsx b/tests/xml/xml.test.tsx
@@ -18,9 +18,10 @@ describe('General XML', () => {
 
         const xmlParser = new XmlParser();
         const outXmlString = xmlText(xmlParser.xmlParse(xmlString), {
-            cData: false,
+            cData: true,
             selfClosingTags: false,
-            escape: true
+            escape: true,
+            outputMethod: 'xml'
         });
         assert.equal(outXmlString, '<root><typeA></typeA><typeB></typeB></root>');
     });
diff --git a/tests/xml/xmltoken.test.tsx b/tests/xml/xmltoken.test.tsx
@@ -1,4 +1,4 @@
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2006, Google Inc.
 // All Rights Reserved
diff --git a/tests/xpath/functions.test.tsx b/tests/xpath/functions.test.tsx
@@ -1,6 +1,6 @@
 /* eslint-disable no-undef */
 
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // All Rights Reserved.
 
 import assert from 'assert';
diff --git a/tests/xpath/xpath.test.tsx b/tests/xpath/xpath.test.tsx
@@ -1,7 +1,7 @@
 /* eslint-disable no-script-url */
 /* eslint-disable guard-for-in */
 
-// Copyright 2023 Design Liquido
+// Copyright 2023-2024 Design Liquido
 // Copyright 2018 Johannes Wilm
 // Copyright 2005, Google Inc.
 // All Rights Reserved.
diff --git a/tests/xslt/choose.test.tsx b/tests/xslt/choose.test.tsx
@@ -0,0 +1,47 @@
+import assert from 'assert';
+
+import { XmlParser } from '../../src/dom';
+import { Xslt } from '../../src/xslt';
+
+describe('xsl:choose', () => {
+    it('Trivial', () => {
+        const xmlSource = `<?xml version="1.0" encoding="UTF-8"?>
+            <products>
+                <product>
+                    <product_id>ABC</product_id>
+                </product>
+                <product>
+                    <product_id>ABB</product_id>
+                </product>
+            </products>`;
+
+        const xsltSource = `<?xml version="1.0" encoding="UTF-8"?><xsl:stylesheet version="2.0"
+            xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+            <xsl:output method="xml" indent="yes"/>
+        
+            <xsl:template match="/products">
+                <products>
+                    <xsl:for-each select="product">
+                        <product>
+                            <xsl:choose>
+                                <xsl:when test="product_id = 'ABB'">
+                                    <xsl:text>Yes</xsl:text>
+                                </xsl:when>
+                                <xsl:otherwise>
+                                    <xsl:text>No</xsl:text>
+                                </xsl:otherwise>
+                            </xsl:choose>
+                        </product>
+                    </xsl:for-each>
+                </products>
+            </xsl:template>
+        </xsl:stylesheet>`;
+
+        const xsltClass = new Xslt();
+        const xmlParser = new XmlParser();
+        const xml = xmlParser.xmlParse(xmlSource);
+        const xslt = xmlParser.xmlParse(xsltSource);
+        const html = xsltClass.xsltProcess(xml, xslt);
+        assert.equal(html, '<products><product>No</product><product>Yes</product></products>');
+    });
+});
diff --git a/tests/xslt/copy-of.test.tsx b/tests/xslt/copy-of.test.tsx
@@ -0,0 +1,38 @@
+import assert from 'assert';
+
+import { XmlParser } from '../../src/dom';
+import { Xslt } from '../../src/xslt';
+
+describe('xsl:copy-of', () => {
+    it('Trivial', () => {
+        const xmlSource = `<?xml version="1.0" encoding="UTF-8"?>
+            <test>
+                <A>
+                    <B>
+                        <D><![CDATA[Hello]]></D>
+                    </B>
+                    <C>
+                        <D><![CDATA[World]]></D>
+                    </C>
+                </A>
+            </test>`;
+
+        const xsltSource = `<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+            <xsl:output method="html" version="4.0" encoding="utf-8" omit-xml-declaration="yes" />
+            <xsl:template match="/test">
+                <xsl:variable name="varA" select="A/B/D" />
+                <xsl:variable name="varB" select="A/C/D" />
+                <h1>
+                    <xsl:copy-of select="$varA" />-<xsl:copy-of select="$varB" />
+                </h1>
+            </xsl:template>
+        </xsl:stylesheet>`;
+
+        const xsltClass = new Xslt();
+        const xmlParser = new XmlParser();
+        const xml = xmlParser.xmlParse(xmlSource);
+        const xslt = xmlParser.xmlParse(xsltSource);
+        const html = xsltClass.xsltProcess(xml, xslt);
+        assert.equal(html, '<h1><D>Hello</D>-<D>World</D></h1>');
+    });
+});
diff --git a/tests/xslt/xslt.test.tsx b/tests/xslt/xslt.test.tsx

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2023 Design Liquido`
	`1`	`+// Copyright 2023-2024 Design Liquido`
`2`	`2`	`// Copyright 2018 Johannes Wilm`
`3`	`3`	`// Copyright 2005-2006 Google`
`4`	`4`	`//`