xml-twig 1.3.2 → 1.3.4

package/doc/twig.md

@@ -40,9 +40,6 @@
 <dt><a href="#onClose">onClose(handler, options, name)</a></dt>
 <dd><p>Common Event hanlder for closing tag</p>
 </dd>
-<dt><a href="#reset">reset()</a></dt>
-<dd><p>Reset global variable if one like to parse multiple files</p>
-</dd>
 </dl>
 
 ## Typedefs
@@ -247,13 +244,13 @@ Purges the current, typically used after element has been processed.<br>The root
 <a name="Twig+purgeUpTo"></a>
 
 ### twig.purgeUpTo
-Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.
+Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.<br>
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. The `elt` object itself is not purged.<br> If `undefined` then the current element is purged (i.e. `purge()`) |
+| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. If `undefined` then the current element is purged (i.e. `purge()`) |
 
 <a name="Twig+escapeEntity"></a>
 
@@ -864,13 +861,13 @@ Purges the current, typically used after element has been processed.<br>The root
 <a name="Twig+purgeUpTo"></a>
 
 ### twig.purgeUpTo
-Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.
+Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.<br>
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. The `elt` object itself is not purged.<br> If `undefined` then the current element is purged (i.e. `purge()`) |
+| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. If `undefined` then the current element is purged (i.e. `purge()`) |
 
 <a name="Twig+escapeEntity"></a>
 
@@ -1460,12 +1457,6 @@ Common Event hanlder for closing tag
 | options | [<code>ParserOptions</code>](#ParserOptions) | Object of optional options |
 | name | <code>string</code> | Event handler parameter |
 
-<a name="reset"></a>
-
-## reset()
-Reset global variable if one like to parse multiple files
-
-**Kind**: global function  
 <a name="ParserOptions"></a>
 
 ## ParserOptions

package/package.json

@@ -5,7 +5,7 @@
   },
   "name": "xml-twig",
   "description": "Node module for processing huge XML documents in tree mode",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "main": "twig.js",
   "directories": {
     "doc": "doc"

package/samples/speed-test.js

@@ -1,29 +1,45 @@
-const { DateTime } = require('luxon');
 const fs = require('fs');
+const path = require('path');
 const twig = require('../twig.js');
+const { pipeline } = require('stream/promises');
+const { DateTime } = require('luxon');
 
 let NE = 0;
-const startTime = DateTime.now();
-
-let parser = twig.createParser([{ tag: 'subsession', function: anyHandler }], { method: process.argv[2] })
-let reader = fs.createReadStream(`${__dirname}/20240304015234.9-MSRAN.xml`);
-console.log(`Starting with ${parser.method}...`)
-reader.pipe(parser);
+let startTime = DateTime.now();
+let printNE = true;
 
 function anyHandler(elt) {
    NE++;
-   if (NE % 25 === 0) {
+   if (printNE && NE % 25 === 0) {
       let d = DateTime.now().diff(startTime);
       console.log(`\t${NE} NE in ${d.toFormat('mm:ss.S')}`);
    }
    elt.purge();
 }
 
-reader.on('end', () => {
+async function parse(method) {
+   const parser = twig.createParser([{ tag: 'subsession', function: anyHandler }], { method: method })
+   const reader = fs.createReadStream(`${__dirname}/20240304015234.9-MSRAN.xml`);
+
+   NE = 0;
+   startTime = DateTime.now();
+   await pipeline(reader, parser);
    let d = DateTime.now().diff(startTime);
-   console.log(`All done with ${parser.method} in ${d.toFormat('mm:ss.S')}`);
-});
+   console.log(`Finished with ${method} in ${d.toFormat('mm:ss.S')}`);
+   printNE = false;
+}
 
+const main = async () => {
+
+   for (let method of ["sax", "expat", "saxophone"]) {
+      console.log(`Running with ${method}...`);
+      printNE = true;
+      for (let i = 0; i <= 5; i++)
+         await parse(method);
+   }
+}
+
+main();
 
 
 /*
@@ -31,25 +47,61 @@ reader.on('end', () => {
 * Results
 **********************
 
-All done with expat in 02:52.676
-All done with expat in 02:53.644
-All done with expat in 02:54.894
-All done with expat in 03:02.545
-All done with expat in 03:23.34
+Running with sax...
+	25 NE in 00:21.260
+	50 NE in 00:46.36
+	75 NE in 01:08.314
+	100 NE in 01:36.5
+	125 NE in 02:11.869
+	150 NE in 02:49.940
+	175 NE in 03:15.653
+Finished with sax in 03:37.656
+Finished with sax in 03:41.884
+Finished with sax in 03:45.146
+Finished with sax in 03:42.84
+Finished with sax in 03:57.614
+Finished with sax in 03:42.634
+
+Running with expat...
+	25 NE in 00:15.746
+	50 NE in 00:33.605
+	75 NE in 00:48.993
+	100 NE in 01:07.777
+	125 NE in 01:32.327
+	150 NE in 01:59.544
+	175 NE in 02:17.560
+Finished with expat in 02:33.545
+Finished with expat in 02:32.371
+Finished with expat in 02:39.785
+Finished with expat in 02:33.270
+Finished with expat in 02:33.231
+Finished with expat in 02:38.269
 
-All done with sax in 04:28.915
-All done with sax in 04:05.760
-All done with sax in 04:06.718
-All done with sax in 04:03.962
-All done with sax in 03:54.540
+Running with saxophone...
+	25 NE in 00:12.874
+	50 NE in 00:27.736
+	75 NE in 00:41.591
+	100 NE in 00:58.430
+	125 NE in 01:20.685
+	150 NE in 01:43.568
+	175 NE in 01:58.438
+Finished with saxophone in 02:11.667
+Finished with saxophone in 02:07.623
+Finished with saxophone in 02:09.538
+Finished with saxophone in 02:09.965
+Finished with saxophone in 02:12.81
+Finished with saxophone in 02:09.792
 
-All done with saxophone in 02:12.565
-All done with saxophone in 02:10.86
-All done with saxophone in 02:13.447
-All done with saxophone in 02:12.14
-All done with saxophone in 02:08.658
 
 Good old Perl XML::Twig
-All done in 9:24
+	25 NE in 1:14
+	50 NE in 2:03
+	75 NE in 3:43
+	100 NE in 5:02
+	125 NE in 6:12
+	150 NE in 7:16
+	175 NE in 8:17
+	200 NE in 9:24
+Finished with perl in 9:24
 
 */

package/test.js

@@ -1,39 +1,30 @@
 const fs = require('fs');
+const path = require('path');
 const twig = require('./twig.js');
+const { pipeline } = require('stream/promises');
+
+async function parse(file, handler, options) {
+   const parser = twig.createParser(handler, options);
+   const reader = fs.createReadStream(file);
+   console.log(`Start parsing of ${path.basename(file)} with ${options.method}`);
+   await pipeline(reader, parser);
+   console.log(`Parsing ${path.basename(file)} done`);
+}
 
-
-const parser = twig.createParser({ tag: twig.Any, function: anyHandler }, { method: "sax" });
-//const parser = twig.createParser({ tag: twig.Any, function: anyHandler }, { method: "expat" });
-//const parser = twig.createParser({ tag: twig.Any, function: anyHandler }, { method: "saxophone" });
-fs.createReadStream(`${__dirname}/samples/bookstore.xml`).pipe(parser);
-//fs.createReadStream(`${__dirname}/samples/breakfast-menu.xml`).pipe(parser);
-
-//const parser = twig.createParser({ tag: twig.Any, function: nsHandler }, { method: "sax", xmlns: true });
-//const parser = twig.createParser({ tag: twig.Any, function: nsHandler }, { method: "expat", xmlns: true });
-//const parser = twig.createParser({ tag: twig.Any, function: nsHandler }, { method: "saxophone", xmlns: true });
-//fs.createReadStream(`${__dirname}/samples/xmlns.xml`).pipe(parser);
-
-//const parser = twig.createParser({ tag: twig.Root, function: piHandler }, { method: "sax" });
-//const parser = twig.createParser({ tag: twig.Root, function: piHandler }, { method: "expat" });
-//const parser = twig.createParser({ tag: twig.Root, function: piHandler }, { method: "saxophone" });
-//fs.createReadStream(`${__dirname}/samples/processingInstruction.xml`).pipe(parser);
+//const parser = twig.createParser({ tag: twig.Root, function: anyHandler }, { method: 'sax' });
+//fs.createReadStream(`${__dirname}/samples/bookstore.xml`).pipe(parser);
 
 
 //fs.createReadStream(`${__dirname}/samples/encoding-UTF-8.xml`).pipe(parser);
 //fs.createReadStream(`${__dirname}/samples/encoding-UTF-16LE.xml`).pipe(parser);
 //fs.createReadStream(`${__dirname}/samples/encoding-UTF-16BE.xml`).pipe(parser);
 
-
 function anyHandler(elt) {
    console.log(`<${elt.name}> => ${elt.text} -> ${JSON.stringify(elt.attributes)}`);
 }
 
-
 function nsHandler(elt) {
    console.log(`${elt.name} => ${JSON.stringify(elt.namespace)} -> ${JSON.stringify(elt.attributes)}`);
-   //console.log(`${elt.name} => isRoot = ${elt.isRoot}`);
-   //console.log(`${elt.name} -> ${JSON.stringify(elt.PI)}`);
-   //console.log(`${elt.name}`);
 }
 
 function piHandler(elt) {
@@ -41,3 +32,20 @@ function piHandler(elt) {
 }
 
 
+const main = async () => {
+
+   for (let file of ["bookstore", "breakfast-menu"]) {
+      for (let method of ["sax", "expat", "saxophone"])
+         await parse(`${__dirname}/samples/${file}.xml`, { tag: twig.Any, function: anyHandler }, { method: method });
+   }
+
+   for (let method of ["sax", "expat", "saxophone"])
+      await parse(`${__dirname}/samples/xmlns.xml`, { tag: twig.Any, function: nsHandler }, { method: method, xmlns: true });
+
+   for (let method of ["sax", "expat", "saxophone"])
+      await parse(`${__dirname}/samples/processingInstruction.xml`, { tag: twig.Root, function: piHandler }, { method: method });
+
+}
+
+main();
+

package/twig.js

@@ -212,11 +212,11 @@ function createParser(handler, options = {}) {
          current.text = options.trim ? str.trim() : str;
       });
 
-      const hndl = Array.isArray(handler) ? handler : [handler];
-      let rootHandler = hndl.find(x => x.tag instanceof RootHandler);
-      parser.on("end", function () {
-         if (typeof rootHandler?.function === 'function') rootHandler.function(tree);
-         if (typeof rootHandler?.event === 'string') parser.emit(rootHandler.event, tree);
+      parser.on('end', function () {
+         tree = undefined;
+         current = undefined;
+         parser.emit("finish");
+         parser.emit("close");
       });
 
    } else if (options.method === EXPAT) {
@@ -254,6 +254,12 @@ function createParser(handler, options = {}) {
          tree.PI = { target: target, data: data };
       });
 
+      parser.on('end', function () {
+         tree = undefined;
+         current = undefined;
+         parser.emit("finish");
+      });
+
    } else if (options.method === SAXOPHONE) {
       const Saxophone = require('saxophone');
       //const Saxophone = require('@alexbosworth/saxophone');
@@ -306,6 +312,12 @@ function createParser(handler, options = {}) {
 
       });
 
+      parser.on('finish', function () {
+         // saxophone parser does not emit 'end' Event
+         tree = undefined;
+         current = undefined;
+      });
+
    } else {
       throw new UnsupportedParser(options.method);
    }
@@ -389,9 +401,8 @@ function onStart(binds, node, attrs) {
       if (current.isRoot && current.name === undefined) {
          current.setRoot(name);
          if (attrs !== undefined) {
-            const att = options.xmlns ? attrNS : attrs;
-            for (let key of Object.keys(att))
-               current.attribute(key, att[key]);
+            for (let [key, val] of Object.entries(options.xmlns ? attrNS : attrs))
+               current.attribute(key, val);
          }
       } else {
          let elt = new Twig(name, current, options.xmlns ? attrNS : attrs);
@@ -449,7 +460,7 @@ function onClose(handler, options, name) {
          if (typeof hndl.function === 'function') hndl.function(current ?? tree);
          if (typeof hndl.event === 'string') parser.emit(hndl.event, current ?? tree);
          purge = false;
-      } else if (hndl.tag instanceof RootHandler && [EXPAT, SAXOPHONE].includes(options.method) && current.isRoot) {
+      } else if (hndl.tag instanceof RootHandler && current.isRoot) {
          if (typeof hndl.function === 'function') hndl.function(tree);
          if (typeof hndl.event === 'string') parser.emit(hndl.event, tree);
          purge = false;
@@ -474,15 +485,6 @@ function onClose(handler, options, name) {
 
 }
 
-
-/**
-* Reset global variable if one like to parse multiple files
-*/
-function reset() {
-   tree = undefined;
-   current = undefined;
-}
-
 /**
  * Generic class modeling a XML Node
  * @class Twig
@@ -608,19 +610,17 @@ class Twig {
    };
 
    /**
-   * Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.
-   * @param {Twig} [elt] - Up to this element the tree will be purged. The `elt` object itself is not purged.<br>
+   * Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.<br>
+   * The `elt` object is not purged. If you like to purge including `elt`, use `.purgeUpTo(elt.previous())`
+   * @param {Twig} [elt] - Up to this element the tree will be purged.
    * If `undefined` then the current element is purged (i.e. `purge()`)
    */
    purgeUpTo = function (elt) {
       if (elt === undefined) {
          this.purge();
       } else {
-         const purgeThis = this.descendantOrSelf();
-         let toPurge = purgeThis[purgeThis.length - 1];
-         const descendantOrSelf = elt.descendantOrSelf();
-         const stopAt = descendantOrSelf[descendantOrSelf.length - 1];
-         while (toPurge !== null && !Object.is(toPurge, stopAt)) {
+         let toPurge = this;
+         while (toPurge !== null && !Object.is(toPurge, elt)) {
             const prev = toPurge.previous();
             toPurge.purge();
             toPurge = prev;
@@ -779,7 +779,7 @@ class Twig {
             xw.writeAttribute(key, val);
          if (elt.text !== null)
             xw.text(elt.text);
-         this.#addChild(xw, elt.children(), elt, debug);         
+         this.#addChild(xw, elt.children(), elt, debug);
       }
       if (!debug || Object.isSealed(cur)) xw.endElement();
    };
@@ -1309,4 +1309,4 @@ class UnsupportedCondition extends TypeError {
 }
 
 
-module.exports = { createParser, Twig, Any, Root, reset };
+module.exports = { createParser, Twig, Any, Root };

package/samples/speed-test.bat

@@ -1,17 +0,0 @@
-node speed-test.js expat
-node speed-test.js expat
-node speed-test.js expat
-node speed-test.js expat
-node speed-test.js expat
-
-node speed-test.js sax
-node speed-test.js sax
-node speed-test.js sax
-node speed-test.js sax
-node speed-test.js sax
-
-node speed-test.js saxophone
-node speed-test.js saxophone
-node speed-test.js saxophone
-node speed-test.js saxophone
-node speed-test.js saxophone

package/samples/speed-test.txt

@@ -1,164 +0,0 @@
-C:\Developing\Source\xml-twig\samples>node speed-test.js expat 
-Starting with expat...
-	25 NE in 00:15.36
-	50 NE in 00:33.382
-	75 NE in 00:50.253
-	100 NE in 01:13.944
-	125 NE in 01:42.205
-	150 NE in 02:13.746
-	175 NE in 02:35.650
-All done with expat in 02:52.676
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js expat 
-Starting with expat...
-	25 NE in 00:18.216
-	50 NE in 00:37.92
-	75 NE in 00:54.888
-	100 NE in 01:17.224
-	125 NE in 01:44.272
-	150 NE in 02:15.283
-	175 NE in 02:36.463
-All done with expat in 02:53.644
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js expat 
-Starting with expat...
-	25 NE in 00:18.639
-	50 NE in 00:39.182
-	75 NE in 00:59.446
-	100 NE in 01:19.566
-	125 NE in 01:46.400
-	150 NE in 02:16.608
-	175 NE in 02:37.242
-All done with expat in 02:54.894
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js expat 
-Starting with expat...
-	25 NE in 00:17.702
-	50 NE in 00:36.765
-	75 NE in 00:55.178
-	100 NE in 01:16.259
-	125 NE in 01:47.37
-	150 NE in 02:18.862
-	175 NE in 02:42.671
-All done with expat in 03:02.545
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js expat 
-Starting with expat...
-	25 NE in 00:18.746
-	50 NE in 00:38.461
-	75 NE in 00:56.901
-	100 NE in 01:17.314
-	125 NE in 01:44.938
-	150 NE in 02:26.995
-	175 NE in 02:58.149
-All done with expat in 03:23.34
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js sax 
-Starting with sax...
-	25 NE in 00:33.781
-	50 NE in 01:08.679
-	75 NE in 01:39.504
-	100 NE in 02:11.68
-	125 NE in 02:51.186
-	150 NE in 03:36.142
-	175 NE in 04:04.731
-All done with sax in 04:28.915
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js sax 
-Starting with sax...
-	25 NE in 00:25.21
-	50 NE in 00:52.164
-	75 NE in 01:17.550
-	100 NE in 01:51.854
-	125 NE in 02:30.192
-	150 NE in 03:11.461
-	175 NE in 03:39.338
-All done with sax in 04:05.760
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js sax 
-Starting with sax...
-	25 NE in 00:25.778
-	50 NE in 00:52.603
-	75 NE in 01:19.686
-	100 NE in 01:52.268
-	125 NE in 02:30.279
-	150 NE in 03:13.159
-	175 NE in 03:42.640
-All done with sax in 04:06.718
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js sax 
-Starting with sax...
-	25 NE in 00:24.549
-	50 NE in 00:50.774
-	75 NE in 01:14.500
-	100 NE in 01:44.116
-	125 NE in 02:22.861
-	150 NE in 03:03.357
-	175 NE in 03:39.237
-All done with sax in 04:03.962
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js sax 
-Starting with sax...
-	25 NE in 00:25.36
-	50 NE in 00:51.544
-	75 NE in 01:15.580
-	100 NE in 01:45.389
-	125 NE in 02:22.834
-	150 NE in 03:03.487
-	175 NE in 03:31.416
-All done with sax in 03:54.540
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js saxophone 
-Starting with saxophone...
-	25 NE in 00:14.96
-	50 NE in 00:31.316
-	75 NE in 00:44.478
-	100 NE in 01:00.580
-	125 NE in 01:21.74
-	150 NE in 01:43.881
-	175 NE in 01:59.119
-All done with saxophone in 02:12.565
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js saxophone 
-Starting with saxophone...
-	25 NE in 00:14.565
-	50 NE in 00:28.947
-	75 NE in 00:42.211
-	100 NE in 00:58.533
-	125 NE in 01:19.194
-	150 NE in 01:41.595
-	175 NE in 01:57.24
-All done with saxophone in 02:10.86
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js saxophone 
-Starting with saxophone...
-	25 NE in 00:13.307
-	50 NE in 00:27.849
-	75 NE in 00:41.466
-	100 NE in 00:59.190
-	125 NE in 01:22.230
-	150 NE in 01:44.605
-	175 NE in 02:00.299
-All done with saxophone in 02:13.447
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js saxophone 
-Starting with saxophone...
-	25 NE in 00:13.884
-	50 NE in 00:28.340
-	75 NE in 00:41.720
-	100 NE in 00:57.897
-	125 NE in 01:19.260
-	150 NE in 01:42.974
-	175 NE in 01:58.791
-All done with saxophone in 02:12.14
-
-C:\Developing\Source\xml-twig\samples>node speed-test.js saxophone 
-Starting with saxophone...
-	25 NE in 00:13.443
-	50 NE in 00:28.99
-	75 NE in 00:40.821
-	100 NE in 00:56.989
-	125 NE in 01:16.787
-	150 NE in 01:40.205
-	175 NE in 01:55.451
-All done with saxophone in 02:08.658