xml-twig 1.7.0 → 1.7.4

package/demo.js

@@ -1,12 +0,0 @@
-const fs = require('fs');
-const twig = require('./twig.js');
-
-
-const parser = twig.createParser({ tag: 'book', event: 'bookElement' });
-fs.createReadStream(`${__dirname}/samples/bookstore.xml`).pipe(parser);
-
-
-parser.on('bookElement', (elt) => {
-   console.log(`<${elt.name}> finished after ${parser.currentLine} lines`);
-}) 
-

package/doc/build.sh

@@ -1,6 +0,0 @@
-#!/bin/bash
-
-jsdoc2md --private ../twig.js > ./twig.md
-
-# see https://github.com/jsdoc2md/jsdoc-to-markdown
-

package/samples/bookstore.xml

@@ -1,48 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<bookstore id="a">
-	<book category="cooking">
-		<title lang="en">Everyday Italian</title>
-		<author>Giada De Laurentiis</author>
-		<year>2005</year>
-		<price>30.00</price>
-	</book>
-	<!-- A comment -->
-	<book category="children">
-		<title lang="en">Harry Potter</title>
-		<author>J K. Rowling</author>
-		<year>2005</year>
-		<price>29.99</price>
-	</book>
-	<ebook category="fantasy">
-		<title lang="en">Harry Potter</title>
-		<author>Joanne Kathleen Rowling</author>
-		<year>2001 </year>
-		<price>12.99</price>
-		<format>Kindle</format>
-		<device>ePub</device>
-	</ebook>
-	<book category="web">
-		<title lang="en">XQuery Kick Start</title>
-		<author>James McGovern</author>
-		<author>Per Bothner</author>
-		<author>Kurt Cagle</author>
-		<author>James Linn</author>
-		<author>Vaidyanathan Nagarajan</author>
-		<year>2003</year>
-		<price>29.99</price>
-	</book>
-	<ebook category="biography">
-		<title lang="en">The Autobiography of Benjamin Franklin</title>
-		<author>Benjamin Franklin</author>
-		<year>1996</year>
-		<price>39.99</price>
-		<format>Kindle</format>
-		<device>ePub</device>
-	</ebook>	
-	<book category="web">
-		<title lang="en">Learning XML</title>
-		<author>Erik T. Ray</author>
-		<year>2003</year>
-		<price>39.95</price>
-	</book>
-</bookstore>

package/samples/breakfast-menu.xml

@@ -1,44 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<breakfast_menu>
-	<food>
-		<name>Belgian Waffles</name>
-		<price>$5.95</price>
-		<description>
-			Two of our famous Belgian Waffles with plenty of real maple syrup
-		</description>
-		<calories>650</calories>
-	</food>
-	<food>
-		<name>Strawberry Belgian Waffles</name>
-		<price>$7.95</price>
-		<description>
-			Light Belgian waffles covered with strawberries and whipped cream
-		</description>
-		<calories>900</calories>
-	</food>
-	<food>
-		<name>Berry-Berry Belgian Waffles</name>
-		<price>$8.95</price>
-		<description><![CDATA[
-Belgian waffles covered with assorted <bold>fresh</bold> berries and whipped cream
-]]>
-		</description>
-		<calories>900</calories>
-	</food>
-	<food>
-		<name>French Toast</name>
-		<price>$4.50</price>
-		<description>
-			Thick slices made from our homemade sourdough bread
-		</description>
-		<calories>600</calories>
-	</food>
-	<food>
-		<name>Homestyle Breakfast</name>
-		<price>$6.95</price>
-		<description>
-			Two eggs, bacon or sausage, toast, and our ever-popular hash browns
-		</description>
-		<calories>950</calories>
-	</food>
-</breakfast_menu>

package/samples/encoding-UTF-8.xml

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<person>Jérôme Picard</person>

package/samples/memory-test.js

@@ -1,77 +0,0 @@
-const fs = require('fs');
-const process = require('process');
-const twig = require('xml-twig');
-
-let Entry = 0;
-
-let parser = twig.createParser([{ tag: 'Entry', function: EntryHandler }], { method: 'expat' })
-// http://aiweb.cs.washington.edu/research/projects/xmltk/xmldata/data/SwissProt/SwissProt.xml.gz
-// For more files see http://aiweb.cs.washington.edu/research/projects/xmltk/xmldata/www/repository.html
-let reader = fs.createReadStream(`SwissProt.xml`);
-reader.pipe(parser);
-
-function EntryHandler(elt) {
-   Entry++;
-   if (Entry % 10000 === 0) {
-      console.log(`Entry ${Entry}`)
-      let len = elt.root().writer().toString().length;
-      len = Math.round((len / 1024 / 1024 + Number.EPSILON) * 100) / 100;
-      console.log(`Size of XML string: ${len} MiB`);
-      for (const [key, value] of Object.entries(process.memoryUsage())) {
-         console.log(`   Memory usage by ${key}, ${Math.round((value / 1024 / 1024 + Number.EPSILON) * 100) / 100} MiB`)
-      }
-   }   
-}
-
-
-
-/*
-**********************
-* Results
-**********************
-
-# Set memory limit to 4GiB for demonstration reasons:
-NODE_OPTIONS=--max-old-space-size=4096
-
-Entry 10000
-Size of XML string: 21.08 MiB
-   Memory usage by rss, 1897.36 MiB
-   Memory usage by heapTotal, 1855.68 MiB
-   Memory usage by heapUsed, 1807.43 MiB
-   Memory usage by external, 1.13 MiB
-   Memory usage by arrayBuffers, 0.7 MiB
-
-Entry 20000
-Size of XML string: 40.86 MiB
-   Memory usage by rss, 3615.75 MiB
-   Memory usage by heapTotal, 3562.62 MiB
-   Memory usage by heapUsed, 3482.97 MiB
-   Memory usage by external, 0.63 MiB
-   Memory usage by arrayBuffers, 0.2 MiB
-
-<--- Last few GCs --->
-
-[18648:000001F930FC8F90]    13906 ms: Scavenge 4047.7 (4123.2) -> 4047.3 (4133.7) MB, 3.4 / 0.0 ms  (average mu = 0.332, current mu = 0.185) allocation failure;
-[18648:000001F930FC8F90]    13916 ms: Scavenge 4054.1 (4133.7) -> 4053.8 (4135.2) MB, 4.0 / 0.0 ms  (average mu = 0.332, current mu = 0.185) allocation failure;
-[18648:000001F930FC8F90]    13925 ms: Scavenge 4055.1 (4135.2) -> 4054.3 (4156.2) MB, 8.3 / 0.0 ms  (average mu = 0.332, current mu = 0.185) allocation failure;
-
-
-<--- JS stacktrace --->
-
-FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory
- 1: 00007FF604481C7F node_api_throw_syntax_error+175855
- 2: 00007FF604406476 EVP_MD_meth_get_input_blocksize+59654
- 3: 00007FF604408160 EVP_MD_meth_get_input_blocksize+67056
- 4: 00007FF604EB0434 v8::Isolate::ReportExternalAllocationLimitReached+116
- 5: 00007FF604E9B7C2 v8::Isolate::Exit+674
- 6: 00007FF604D1D65C v8::internal::EmbedderStackStateScope::ExplicitScopeForTesting+124
- 7: 00007FF604D1A87B v8::internal::Heap::CollectGarbage+3963
- 8: 00007FF604D30AB3 v8::internal::HeapAllocator::AllocateRawWithLightRetrySlowPath+2099
- 9: 00007FF604D3135D v8::internal::HeapAllocator::AllocateRawWithRetryOrFailSlowPath+93
-10: 00007FF604D40B20 v8::internal::Factory::NewFillerObject+816
-11: 00007FF604A31565 v8::internal::DateCache::Weekday+1349
-12: 00007FF604F4D961 v8::internal::SetupIsolateDelegate::SetupHeap+558193
-13: 00007FF5B03D1532
-
-*/
-

package/samples/processingInstruction.xml

@@ -1,28 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<?xml-stylesheet type="text/xsl" href="style.xsl"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
-	<xsl:template match="/">
-		<emptyElement/>
-		<html>
-			<body>xx<!--Your comment-->xx
-				<h2>My CD Collection</h2>
-				<table border="1">
-					<tr>
-						<th style="text-align:left">Title</th>
-						<th style="text-align:left">Artist</th>
-					</tr>
-					<xsl:for-each select="catalog/cd">
-						<tr>
-							<td>
-								<xsl:value-of select="title"/>
-							</td>
-							<td>
-								<xsl:value-of select="artist"/>
-							</td>
-						</tr>
-					</xsl:for-each>
-				</table>
-			</body>
-		</html>
-	</xsl:template>
-</xsl:stylesheet>

package/samples/sample.js

@@ -1,96 +0,0 @@
-const fs = require('fs');
-const twig = require('../twig.js');
-
-
-// Sample 1.1
-function rootHandler(elt) {
-   console.log(`<${elt.name}> finished after ${parser.currentLine} lines`);
-}
-
-parser = twig.createParser({ tag: twig.Root, function: rootHandler }, { method: 'sax' })
-fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser)
-
-
-// Sample 1.2
-parser = twig.createParser({ tag: twig.Root, function: rootHandler }, { method: 'expat' })
-/parser.write('<html><head><title>Hello World</title></head><body><p>Foobar</p></body></html>');
-
-
-// Sample 2
-parser = twig.createParser({ tag: twig.Root, event: 'rootElement' }, { method: 'sax' })
-fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser)
-
-parser.on('rootElement', (elt) => {
-   console.log(`<${elt.name}> finished after ${parser.currentLine} lines`);
-})
-
-
-
-// Sample 3
-function bookHandler(elt) {
-   console.log(`${elt.attr("category")} ${elt.name} at line ${parser.currentLine}`)
-   elt.purge() // -> without `purge()` the entire XML document will be loaded into memory
-}
-
-handle_book = [
-   { tag: 'book', function: bookHandler },
-   { tag: 'ebook', function: bookHandler }
-];
-handle_book = [
-   { tag: /book$/, function: bookHandler }
-];
-handle_book = [{
-   tag: function (name, elt) { return name.endsWith('book') },
-   function: bookHandler
-}];
-handle_book = [{
-   tag: function (name, elt) { return ['book', 'ebook'].includes(name) },
-   function: bookHandler
-}];
-handle_book = [{
-   tag: function (name, elt) { return ['book', 'ebook'].includes(elt.name) },
-   function: bookHandler
-}];
-
-parser = twig.createParser(handle_book, { method: 'sax' })
-fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser)
-
-
-
-// Sample 4
-function anyHandler(elt) {
-   console.log(`${'  '.repeat(elt.level)}${elt.name} => "${elt.text ?? ''}" at line ${parser.currentLine}`)
-   elt.purge() // -> without `purge()` the entire XML document will be loaded into memory
-}
-
-parser = twig.createParser({ tag: twig.Any, function: anyHandler }) 
-// or with Regular Expression: `{ tag: tag: /i/, function: anyHandler }` 
-// or with Function: `{ tag: () => {return true}, function: anyHandler }`
-fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser)
-
-
-// Sample 5
-const handle_ebook = [
-   { tag: 'ebook', function: ebookHandler },
-   { tag: twig.Root, function: rootHandler }
-];
-const parser = twig.createParser(handle_ebook, { partial: true })
-fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser);
-
-function ebookHandler(elt) {
-   //console.log(`${elt.name} at line ${parser.currentLine}`)
-}
-
-function rootHandler(elt) {
-   console.log( elt.writer('  ').toString() );
-}
-
-
-function bookHandler(elt) {
-   if (elt.attr('category') == 'fantasy') {
-      console.log(elt.writer(true).toString());
-      let t = elt.addElement('newTag', 'some Text > more', {id:1},2);
-      console.log(t.writer(true).toString());
-      console.log(elt.root().writer(true).toString());
-   }
-}

package/samples/speed-test.js

@@ -1,92 +0,0 @@
-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;
-let startTime = DateTime.now();
-let printNE = true;
-
-function anyHandler(elt) {
-   NE++;
-   if (printNE && NE % 25 === 0) {
-      let d = DateTime.now().diff(startTime);
-      console.log(`\t${NE} NE in ${d.toFormat('mm:ss.S')}`);
-   }
-   elt.purge();
-}
-
-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(`Finished with ${method} in ${d.toFormat('mm:ss.S')}`);
-   printNE = false;
-}
-
-const main = async () => {
-
-   for (let method of ["sax", "expat"]) {
-      console.log(`Running with ${method}...`);
-      printNE = true;
-      for (let i = 0; i <= 5; i++)
-         await parse(method);
-   }
-}
-
-main();
-
-
-/*
-**********************
-* Results
-**********************
-
-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
-
-
-Good old Perl XML::Twig
-	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/samples/xmlns.xml

@@ -1,19 +0,0 @@
-<root>
-	<h:table xmlns:h="http://www.w3.org/TR/html4/" id="1">
-		<h:tr>
-			<h:td>Apples</h:td>
-			<h:td>Bananas</h:td>
-		</h:tr>
-	</h:table>
-	<f:table xmlns:f="https://www.w3schools.com/furniture">
-		<f:name>African Coffee Table</f:name>
-		<f:width>80</f:width>
-		<f:length>120</f:length>
-	</f:table>
-	<book xmlns:a="http://www.w3.org/" category="web">
-		<title lang="en">Learning XML</title>
-		<a:author>Erik T. Ray</a:author>
-		<year>2003</year>
-		<price>39.95</price>
-	</book>	
-</root>

package/test.js

@@ -1,51 +0,0 @@
-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.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)}`);
-}
-
-function piHandler(elt) {
-   console.log(`${elt.name} -> ${JSON.stringify(elt.PI)}`);
-}
-
-
-const main = async () => {
-
-   for (let file of ["bookstore", "breakfast-menu"]) {
-      for (let method of ["sax", "expat"])
-         await parse(`${__dirname}/samples/${file}.xml`, { tag: twig.Any, function: anyHandler }, { method: method });
-   }
-
-   for (let method of ["sax", "expat"])
-      await parse(`${__dirname}/samples/xmlns.xml`, { tag: twig.Any, function: nsHandler }, { method: method, xmlns: true });
-
-   for (let method of ["sax", "expat"])
-      await parse(`${__dirname}/samples/processingInstruction.xml`, { tag: twig.Root, function: piHandler }, { method: method });
-
-}
-
-main();
-