xml-toolkit 0.0.1 → 0.0.3

package/index.js

@@ -1,5 +1,6 @@
 const XMLLexer        = require ('./lib/XMLLexer')
 const SAXEventEmitter = require ('./lib/SAXEventEmitter')
 const SAXEvent        = require ('./lib/SAXEvent')
+const AttributesMap   = require ('./lib/AttributesMap')
 
-module.exports = {SAXEventEmitter, XMLLexer, SAXEvent}
+module.exports = {SAXEventEmitter, XMLLexer, SAXEvent, AttributesMap}

package/lib/AttributesMap.js

@@ -0,0 +1,37 @@
+const AttributesMap = class extends Map {
+
+	constructor (xmlReader) {
+
+		super ()
+		
+		this._xmlReader = xmlReader
+		
+		this.fix = null
+		
+		if (xmlReader.useEntities) {
+		
+			const {entityResolver} = xmlReader
+			
+			this.fix = s => entityResolver.fix (s)
+		
+		}
+
+	}
+	
+	set (k, v) {
+	
+		{
+		
+			const {fix} = this
+		
+			if (fix !== null) v = fix (v)
+
+		}
+
+		return super.set (k, v)
+	
+	}
+
+}
+
+module.exports = AttributesMap

package/lib/EntityResolver.js

@@ -0,0 +1,66 @@
+const XMLReader  = require ('./XMLReader.js')
+
+const CH_HASH    = '#'.charCodeAt (0)
+
+const PREDEFINED = new Map ([
+	['lt'   , '<'],
+	['gt'   , '>'],
+	['quot' , '"'],
+	['amp'  , '&'],
+	['apos' , "'"],
+])
+
+const EntityResolver = class {
+
+	constructor () {
+
+		this.body = new Map (PREDEFINED)
+
+	}
+	
+	fix (s) {
+
+		let start = s.indexOf ('&'); if (start === -1) return s
+		
+		let r = s.slice (0, start)
+		
+		const {body} = this
+		
+		while (true) {
+
+			let end = s.indexOf (';', ++ start); if (end === -1) throw new Error ('Unterminated entity reference in ' + JSON.stringify ([s]))
+
+			const key = s.slice (start, end)
+
+			if (body.has (key)) {
+
+				r += body.get (key)
+
+			}
+			else {
+
+				const charCode = key.charCodeAt (0) === CH_HASH ? parseInt (key.slice (1), 16) : parseInt (key, 10)
+				
+				if (isNaN (charCode) || charCode <= 0) throw new Error ('Unknown entity reference ' + key + ' in ' + JSON.stringify ([s]))
+				
+				const c = String.fromCharCode (charCode)
+				
+				body.set (key, c)
+				
+				r += c
+
+			}
+			
+			start = s.indexOf ('&', ++ end)
+			
+			if (start === -1) return r + s.slice (end)
+			
+			r += s.slice (end, start)
+			
+		}
+
+	}
+
+}
+
+module.exports = EntityResolver

package/lib/SAXEvent.js

@@ -117,12 +117,12 @@ const SAXEvent = class {
 			const  q = src.indexOf (src.charAt (eq + 1), eq + 2); if (q === -1) break
 
 			let k = src.slice (start, eq)
-			
+
 			if (start === 0) {
-			
-				let p = k.length - 2; while (p !== 0 && k.charCodeAt (p) <= 32) p --
 
-				k = k.slice (this._afterName = p)
+				let p = k.length - 1; while (p !== 0 && k.charCodeAt (p) > 32) p --
+
+				k = k.slice (this._afterName = ++ p)
 
 			}
 			else {

package/lib/SAXEventEmitter.js

@@ -1,39 +1,12 @@
-const assert     = require ('assert')
-const {Writable} = require ('stream')
-const SAXEvent   = require ('./SAXEvent.js')
+const XMLReader  = require ('./XMLReader.js')
 
-const SAXEventEmitter = class extends Writable {
+const SAXEventEmitter = class extends XMLReader {
 
 	constructor (options = {}) {
 
-		options.decodeStrings = false
-
 		super (options)
 		
-		this.on ('finish', () => this.emit (SAXEvent.TYPES.END_DOCUMENT))
-
-	}
-
-	_write (chunk, encoding, callback) {
-
-		if (chunk.length !== 0) {
-		
-			let e = new SAXEvent (chunk), {type} = e
-			
-			if (type === SAXEvent.TYPES.CDATA) {
-				e = new SAXEvent (e.text)
-				type = SAXEvent.TYPES.CHARACTERS
-			}
-
-			this.emit (type, e)
-		
-			if (type === SAXEvent.TYPES.TYPE_START_ELEMENT && e.isSelfEnclosing ()) {
-				this.emit (SAXEvent.TYPES.TYPE_END_ELEMENT, e)
-			}
-		
-		}
-
-		callback ()
+		this.on ('data', e => this.emit (e.type, e))
 
 	}
 

package/lib/XMLLexer.js

@@ -38,14 +38,10 @@ const XMLLexer = class extends Transform {
 		assert (Number.isInteger (maxLength), 'maxLength must be integer, not ' + maxLength)
 		assert (maxLength > 0, 'maxLength must be positive, not ' + maxLength)
 		
-		if (!('stripSpace' in options)) options.stripSpace = false
-		assert (options.stripSpace === true || options.stripSpace === false, 'options.stripSpace must be boolean, not ' + typeof options.stripSpace)
-
 		super (options)
 		
 		this.decoder      = new StringDecoder ('utf8')
 
-		this.stripSpace   = options.stripSpace
 		this.body		  = ''
 		this.start        = 0
 		this.setState (ST_TEXT)
@@ -237,8 +233,6 @@ const XMLLexer = class extends Transform {
 
 		this.start = pos
 		
-		if (this.stripSpace) lexeme = lexeme.trim ()
-
 		if (lexeme.length !== 0) this.push (lexeme)
 
 	}

package/lib/XMLReader.js

@@ -0,0 +1,87 @@
+const assert      = require ('assert')
+const {Transform} = require ('stream')
+const SAXEvent    = require ('./SAXEvent.js')
+
+const XMLReader = class extends Transform {
+
+	constructor (options = {}) {
+
+		options.decodeStrings = false
+		options.objectMode = true
+		
+		if (!('stripSpace' in options)) options.stripSpace = false
+		assert (options.stripSpace === true || options.stripSpace === false, 'options.stripSpace must be boolean, not ' + typeof options.stripSpace)
+
+		if (!('useEntities' in options)) options.useEntities = true
+		assert (options.useEntities === true || options.useEntities === false, 'options.useEntities must be boolean, not ' + typeof options.useEntities)
+
+		super (options)
+
+		this.stripSpace  = options.stripSpace
+		this.useEntities = options.useEntities
+		
+		if (this.useEntities) this.entityResolver = new (require ('./EntityResolver.js')) ()
+		
+		this.text = ''
+
+	}
+
+	_flush (callback) {
+	
+		this.flush_text ()
+
+		this.push ({type: SAXEvent.TYPES.END_DOCUMENT})
+
+		callback ()
+
+	}
+	
+	flush_text () {
+		
+		let {text} = this; if (text.length === 0) return
+		
+		if (this.stripSpace) text = text.trim ()
+		
+		if (text.length !== 0) this.push (new SAXEvent (text))
+		
+		this.text = ''
+
+	}
+
+	_transform (chunk, encoding, callback) {
+
+		if (chunk.length !== 0) {
+
+			let e = new SAXEvent (chunk), {type} = e
+
+			switch (type) {
+
+				case SAXEvent.TYPES.CHARACTERS:
+
+					this.text += this.useEntities ? this.entityResolver.fix (e.text) : e.text
+					break
+
+				case SAXEvent.TYPES.CDATA:
+
+					this.text += e.text
+					break
+
+				default:
+
+					this.flush_text ()
+					this.push (e)
+					break
+
+			}
+
+			if (type === SAXEvent.TYPES.START_ELEMENT && e.isSelfEnclosed) this.push (new SAXEvent ('</>'))
+
+		}
+
+		callback ()
+
+	}
+
+}
+
+module.exports = XMLReader

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xml-toolkit",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Collection of classes for dealing with XML",
   "main": "index.js",
   "scripts": {
@@ -11,7 +11,9 @@
     "url": "git+https://github.com/do-/node-xml-toolkit.git"
   },
   "keywords": [
-    "xml sax stax"
+    "xml",
+    "sax",
+    "stax"
   ],
   "author": "Dmitry Ovsyanko",
   "license": "MIT",

package/test/ent.xml

@@ -0,0 +1,6 @@
+<doc>
+	<p>&amp;</p>
+	<p>ss&32;ss&#20;ss&33;</p>
+	<p>&lt;&gt;&quot;&apos;</p>
+	<a name="&lt;"/>
+</doc>

package/test/test.js

@@ -1,6 +1,6 @@
 const fs = require ('fs')
 const assert = require ('assert')
-const {SAXEventEmitter, SAXEvent, XMLLexer} = require ('../')
+const {SAXEventEmitter, SAXEvent, XMLLexer, AttributesMap} = require ('../')
 
 async function test_001_lexer_sync (fn) {
 
@@ -60,13 +60,17 @@ console.log (xml)
 	const lex = new XMLLexer ({
 //		maxLength: 40,
 //		encoding: 'ascii',
-		stripSpace: true,
+//		stripSpace: true,
 	})
 
-	const sax = new SAXEventEmitter ({})
+	const sax = new SAXEventEmitter ({
+		stripSpace: true,
+//		useEntities: false,
+	})
 
 	lex.pipe (sax)
 
+/*
 	for (let event of [
 		'StartDocument',
 		'ProcessingInstruction',
@@ -77,6 +81,19 @@ console.log (xml)
 		'EndElement',
 		'EndDocument',
 	]) sax.on (event, data => console.log ([event, data]))
+*/
+
+	sax.on ('StartElement', event => {
+	
+		console.log ({event})
+		
+		const attr = new AttributesMap (sax)
+		
+		event.writeAttributesToMap (attr)
+		
+		console.log ({attr})
+		
+	})
 
 //	lexer.on ('data', data => console.log ({data}))
 	
@@ -92,13 +109,14 @@ async function main () {
 //	await test_001_lexer_sync ('E05a.xml')
 //	await test_001_lexer_sync ('not-sa01.xml')
 //	await test_001_lexer_sync ('not-sa02.xml')
-	await test_001_lexer_sync ('param_types.xml')
+//	await test_001_lexer_sync ('param_types.xml')
 //	await test_002_lexer_stream ('E05a.xml')
 //	await test_002_lexer_stream ('param_types.xml')
 //	await test_002_lexer_stream ('not-sa02.xml')
 //	await test_003_emitter_sync ('E05a.xml')
 //	await test_003_emitter_sync ('param_types.xml')
 //	await test_003_emitter_sync ('not-sa01.xml')
+	await test_003_emitter_sync ('ent.xml')
 
 }