Add ability to toString a fragment, without declarations and all that bullshit. Add ability to set a raw value in writer

Author: magnusjt

package.json

@@ -1,6 +1,6 @@
 {
   "name": "njs-tfso-xml",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "main": "./index.js",
   "scripts": {
     "test": "mocha --recursive ./test/**/test*"

src/XmlReader.js

@@ -6,9 +6,9 @@ const parse = require('./parse')
 const XmlWriter = require('./XmlWriter')
 
 class XmlReader{
-    constructor(data, documentTag){
+    constructor(data, currentTag){
         this.data = data
-        this.documentTag = documentTag
+        this.currentTag = currentTag
     }
 
     static streamParseFromString(xmlString, splitOn){
@@ -23,6 +23,10 @@ class XmlReader{
             }))
     }
 
+    /**
+     * @param xmlString
+     * @returns {Promise<XmlReader>}
+     */
     static async parse(xmlString){
         return parse(xmlString)
             .then(({data, documentTag}) => {
@@ -55,7 +59,7 @@ class XmlReader{
     }
 
     keys(){
-        return Object.keys(this.data.children || {})
+        return Object.keys((this.data && this.data.children) || {})
     }
 
     /**
@@ -65,9 +69,10 @@ class XmlReader{
      * @returns {XmlReader}
      */
     asObject(path){
+        const tag = path.split('.').reverse()[0]
         path = path.replace(/\./g, '.0.children.')
         path = `children.${path}.0`
-        return new XmlReader(_.get(this.data, path))
+        return new XmlReader(_.get(this.data, path), tag)
     }
 
     /**
@@ -78,9 +83,10 @@ class XmlReader{
      * @returns {XmlReader[]}
      */
     asArray(path){
+        const tag = path.split('.').reverse()[0]
         path = path.replace(/\./g, '.0.children.')
         path = `children.${path}`
-        return _.get(this.data, path, []).map(obj => new XmlReader(obj))
+        return _.get(this.data, path, []).map(obj => new XmlReader(obj, tag))
     }
 
     /**
@@ -95,12 +101,12 @@ class XmlReader{
             return []
         }
 
-        let parts = path.split('.')
+        const parts = path.split('.')
 
-        let firstPath = parts[0]
-        let remainingPath = parts.slice(1).join('.')
+        const firstPath = parts[0]
+        const remainingPath = parts.slice(1).join('.')
 
-        let curr = this.asArray(firstPath)
+        const curr = this.asArray(firstPath)
 
         if(remainingPath.length === 0){
             return curr
@@ -116,6 +122,10 @@ class XmlReader{
     toString(){
         return XmlWriter.fromReader(this).toString()
     }
+
+    toFragmentString(){
+        return XmlWriter.fromReader(this).toFragmentString()
+    }
 }
 
 module.exports = XmlReader

src/XmlWriter.js

@@ -1,5 +1,7 @@
 const DOMImplementation = require('xmldom').DOMImplementation
 const XMLSerializer = require('xmldom').XMLSerializer
+const DOMParser = require('xmldom').DOMParser
+const XmlReader = require('./XmlReader')
 
 class XmlWriter{
     /**
@@ -19,11 +21,11 @@ class XmlWriter{
      * @returns {XmlWriter}
      */
     static create(namespace, namespaceURI, schemaLocation, documentName = 'Document'){
-        let dom = new DOMImplementation()
-        let doc = dom.createDocument(namespace, documentName)
+        const dom = new DOMImplementation()
+        const doc = dom.createDocument(namespace, documentName)
 
         doc.insertBefore(doc.createProcessingInstruction('xml', 'version="1.0" encoding="utf-8"'), doc.documentElement)
-        let documentElement = doc.documentElement
+        const documentElement = doc.documentElement
 
         if(namespaceURI && schemaLocation){
             documentElement.setAttributeNS(namespaceURI, 'xsi:schemaLocation', schemaLocation)
@@ -37,7 +39,7 @@ class XmlWriter{
      * @returns {*}
      */
     static fromReader(reader){
-        let writer = XmlWriter.create('', '', '', reader.documentTag)
+        const writer = XmlWriter.create('', '', '', reader.currentTag)
 
         /**
          * @param {XmlReader} reader
@@ -46,7 +48,7 @@ class XmlWriter{
         let write = (reader, writer) => {
             for(let key of reader.keys()){
                 for(let obj of reader.asArray(key)){
-                    let writeChildren = nextWriter => write(obj, nextWriter)
+                    const writeChildren = nextWriter => write(obj, nextWriter)
                     writer.add(key, writeChildren, obj.attributes(), obj.val())
                 }
             }
@@ -82,13 +84,13 @@ class XmlWriter{
      * @returns {XmlWriter}
      */
     addAndGet(path, valueOrFunctionOrNull = null, attributes = null, value = null){
-        let parts = path.split('.')
-        let firstPath = parts[0]
-        let remainingPath = parts.slice(1).join('.')
+        const parts = path.split('.')
+        const firstPath = parts[0]
+        const remainingPath = parts.slice(1).join('.')
 
-        let elem = this._doc.createElementNS(this._doc.documentElement.namespaceURI, firstPath)
+        const elem = this._doc.createElementNS(this._doc.documentElement.namespaceURI, firstPath)
         this._elem.appendChild(elem)
-        let writer = new XmlWriter(this._doc, elem)
+        const writer = new XmlWriter(this._doc, elem)
 
         if(remainingPath.length === 0){
             if(typeof valueOrFunctionOrNull === 'function'){
@@ -112,6 +114,12 @@ class XmlWriter{
         return writer.addAndGet(remainingPath, valueOrFunctionOrNull, attributes)
     }
 
+    setValRaw(raw){
+        const parser = new DOMParser()
+        this._elem.appendChild(parser.parseFromString(raw))
+        return this
+    }
+
     setVal(value){
         this._elem.textContent = value
         return this
@@ -123,9 +131,17 @@ class XmlWriter{
     }
 
     toString(){
-        let s = new XMLSerializer()
+        const s = new XMLSerializer()
         return s.serializeToString(this._doc)
     }
+
+    /**
+     * toString of the current document element
+     */
+    toFragmentString(){
+        const s = new XMLSerializer()
+        return s.serializeToString(this._elem)
+    }
 }
 
 module.exports = XmlWriter

test/testXmlWriter.js

@@ -0,0 +1,50 @@
+const XmlReader = require('../src/XmlReader')
+const XmlWriter = require('../src/XmlWriter')
+const chai = require('chai')
+
+let testData1 = `
+<document>
+    <test hello="world">yo</test>
+    <list>
+        <otheritem>yoyo</otheritem>
+        <item>
+            <nestedlist>
+                <nesteditem attr="attr1">1</nesteditem>
+                <nesteditem attr="attr2">2</nesteditem>
+            </nestedlist>
+        </item>
+        <item>
+            <nestedlist>
+                <nesteditem attr="attr3">3</nesteditem>
+                <nesteditem attr="attr4">4</nesteditem>
+            </nestedlist>
+        </item>
+    </list>
+</document>
+`
+
+describe('XmlWriter', () => {
+    it('should be able to print a fragment', async () => {
+        const reader = await XmlReader.parse(testData1)
+
+        const subReader = reader.asObject('list.item')
+
+        const writer = XmlWriter.fromReader(subReader)
+
+        const finalReader = await XmlReader.parse(writer.toFragmentString())
+
+        chai.expect(finalReader.valAt('nestedlist.nesteditem')).to.equal('1')
+    })
+
+    it('should set a raw value', async () => {
+        const writer = XmlWriter.create('', '', '', 'Document')
+
+        writer.setValRaw(`
+            <test>hello!</test>
+        `)
+
+        const reader = await XmlReader.parse(writer.toString())
+
+        chai.expect(reader.valAt('test')).to.equal('hello!')
+    })
+})