Merge pull request #134 from LaughingBubba/alt-text-node

alternate text node

Author: c4milo

README.md

@@ -54,14 +54,15 @@ var options = {
     sanitize: true,
     trim: true,
     arrayNotation: false
+    alternateTextNode: false
 };
 ```
 
 * **object:** Returns a Javascript object instead of a JSON string
 * **reversible:** Makes the JSON reversible to XML (*)
 * **coerce:** Makes type coercion. i.e.: numbers and booleans present in attributes and element values are converted from string to its correspondent data types. Coerce can be optionally defined as an object with specific methods of coercion based on attribute name or tag name, with fallback to default coercion.
 * **trim:** Removes leading and trailing whitespaces as well as line terminators in element values.
-* **arrayNotation:** XML child nodes are always treated as arrays
+* **arrayNotation:** XML child nodes are always treated as arrays NB: you can specify a selective array of nodes for this to apply to instead of the whole document. 
 * **sanitize:** Sanitizes the following characters present in element values:
 
 ```javascript
@@ -76,6 +77,8 @@ var chars =  {
     "'": '''
 };
 ```
+* **alternateTextNode:** Changes the default textNode property from $t to _t when option is set to true. Alternatively a string can be specified which will override $t to what ever the string is.
+
 
 ### Options object for `toXml`
 

lib/xml2json.js

@@ -51,34 +51,34 @@ function startElement(name, attrs) {
 }
 
 function text(data) {
-    currentObject['$t'] = (currentObject['$t'] || '') + data;
+    currentObject[textNodeName()] = (currentObject[textNodeName()] || '') + data;
 }
 
 function endElement(name) {
-    if (currentObject['$t']) {
+    if (currentObject[textNodeName()]) {
         if (options.trim) {
-            currentObject['$t'] = currentObject['$t'].trim()
+            currentObject[textNodeName()] = currentObject[textNodeName()].trim()
         }
 
         if (options.sanitize) {
-            currentObject['$t'] = sanitizer.sanitize(currentObject['$t'], true);
+            currentObject[textNodeName()] = sanitizer.sanitize(currentObject[textNodeName()], true);
         }
 
-        currentObject['$t'] = coerce(currentObject['$t'],name);
+        currentObject[textNodeName()] = coerce(currentObject[textNodeName()],name);
     }
 
     if (currentElementName !== name) {
-        delete currentObject['$t'];
+        delete currentObject[textNodeName()];
     }
     // This should check to make sure that the name we're ending
     // matches the name we started on.
     var ancestor = ancestors.pop();
     if (!options.reversible) {
-        if (('$t' in currentObject) && (Object.keys(currentObject).length == 1)) {
+        if ((textNodeName() in currentObject) && (Object.keys(currentObject).length == 1)) {
             if (ancestor[name] instanceof Array) {
-                ancestor[name].push(ancestor[name].pop()['$t']);
+                ancestor[name].push(ancestor[name].pop()[textNodeName()]);
             } else {
-                ancestor[name] = currentObject['$t'];
+                ancestor[name] = currentObject[textNodeName()];
             }
         }
     }
@@ -112,6 +112,10 @@ function coerce(value,key) {
     return value;
 }
 
+function textNodeName() {
+    return options.alternateTextNode ? typeof options.alternateTextNode === 'string' ? options.alternateTextNode : '_t' : '$t'
+}
+
 
 /**
  * Parses xml to json using node-expat.
@@ -124,6 +128,10 @@ function coerce(value,key) {
  *                characterized by the presence of the property $t.
  *  - sanitize_values: If true, the parser escapes any element value in the xml
  * that has any of the following characters: <, >, (, ), #, #, &, ", '.
+ *  - alternateTextNode (boolean OR string): 
+ *      If false or not specified: default of $t is used 
+ *      If true, whenever $t is returned as an end point, is is substituted with _t  
+ *      it String, whenever $t is returned as an end point, is is substituted with the String value (care advised)
  *
  * @return {String|Object} A String or an Object with the JSON representation
  * of the XML.
@@ -147,7 +155,8 @@ module.exports = function(xml, _options) {
         coerce: joi.alternatives([joi.boolean(), joi.object()]).default(false),
         sanitize: joi.boolean().default(true),
         trim: joi.boolean().default(true),
-        arrayNotation: joi.alternatives([joi.boolean(), joi.array()]).default(false)
+        arrayNotation: joi.alternatives([joi.boolean(), joi.array()]).default(false),
+        alternateTextNode: [joi.boolean().default(false), joi.string().default(false)]
     };
     var validation = joi.validate(_options, schema);
     hoek.assert(validation.error === null, validation.error);
@@ -171,6 +180,6 @@ module.exports = function(xml, _options) {
 
     //See: http://timelessrepo.com/json-isnt-a-javascript-subset
     json = json.replace(/\u2028/g, '\\u2028').replace(/\u2029/g, '\\u2029');
-
+    
     return json;
 };

test/fixtures/alternate-text-node-A.json

@@ -0,0 +1 @@
+{"unit":{"test":{"case":[{"justText":{"$t":"blah blah"}},{"attribText":{"attrib":"das","$t":"capital"}}]}}}

test/fixtures/alternate-text-node-A.xml

@@ -0,0 +1,11 @@
+<unit>
+  <test>
+    <case>
+      <justText>blah blah</justText>
+    </case>
+    <case>
+      <attribText attrib='das'>capital
+      </attribText>
+    </case>
+  </test>
+</unit>

test/fixtures/alternate-text-node-B.json

@@ -0,0 +1 @@
+{"unit":{"test":{"case":[{"justText":{"_t":"blah blah"}},{"attribText":{"attrib":"das","_t":"capital"}}]}}}

test/fixtures/alternate-text-node-C.json

@@ -0,0 +1 @@
+{"unit":{"test":{"case":[{"justText":{"xx":"blah blah"}},{"attribText":{"attrib":"das","xx":"capital"}}]}}}

test/fixtures/alternate-text-node-D.json

@@ -0,0 +1 @@
+{"unit":{"test":{"case":[{"justText":{"zz":"blah blah"}},{"attribText":{"attrib":"das","zz":"capital"}},{"spaces":{"zz":"abc\nasdf\n  a"}},{"type":"SANATISE","san":{"b":"Smith & Son","zz":"Alpha & Omega"}}]}}}

test/fixtures/alternate-text-node-D.xml

@@ -0,0 +1,22 @@
+<unit>
+  <test>
+    <case>
+      <justText>blah blah</justText>
+    </case>
+    <case>
+      <attribText attrib='das'>capital
+      </attribText>
+    </case>
+    <case> 
+      <spaces>  abc
+asdf
+  a  </spaces>
+    </case>
+    <case type="SANATISE">
+      <san b="Smith &amp; Son">
+        Alpha &amp; Omega
+      </san>
+    </case>
+  </test>
+</unit>
+

test/test.js

@@ -170,6 +170,65 @@ describe('xml2json', function () {
         });
     })
 
+    describe('alternateTextNode', function () {
+
+        it('A1: defaults without the option being defined', function(done) {
+
+            var xml = internals.readFixture('alternate-text-node-A.xml');
+            var result = parser.toJson(xml, {reversible: true});
+            var json = internals.readFixture('alternate-text-node-A.json');
+            
+            expect(result).to.equal(json);
+
+            done();
+        });
+
+        it('A2: defaults with option as false', function(done) {
+
+            var xml = internals.readFixture('alternate-text-node-A.xml');
+            var result = parser.toJson(xml, {alternateTextNode: false, reversible: true});
+            var json = internals.readFixture('alternate-text-node-A.json');
+            
+            expect(result).to.equal(json);
+
+            done();
+        });
+
+        
+        it('B: uses alternate text node with option as true', function(done) {
+
+            var xml = internals.readFixture('alternate-text-node-A.xml');
+            var result = parser.toJson(xml, {alternateTextNode: true, reversible: true});
+            var json = internals.readFixture('alternate-text-node-B.json');
+
+            expect(result).to.equal(json);
+
+            done();
+        });
+        
+        it('C: overrides text node with option as "xx" string', function(done) {
+
+            var xml = internals.readFixture('alternate-text-node-A.xml');
+            var result = parser.toJson(xml, {alternateTextNode: "xx", reversible: true});
+            var json = internals.readFixture('alternate-text-node-C.json');
+            
+            expect(result).to.equal(json);
+
+            done();
+        });
+
+        it('D: double check sanatize and trim', function (done) {
+
+            var xml = internals.readFixture('alternate-text-node-D.xml');
+            var result = parser.toJson(xml, {alternateTextNode: "zz", sanitize: true, trim: true, reversible: true});
+            var json = internals.readFixture('alternate-text-node-D.json');
+
+            expect(result).to.equal(json);
+
+            done();
+        });
+
+    })
 });