Merge branch 'master' into master

Author: ehoogerbeets

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

@@ -20,7 +20,7 @@ function startElement(name, attrs) {
     }
 
     if (! (name in currentObject)) {
-        if(options.arrayNotation) {
+        if(options.arrayNotation || options.forceArrays[name]) {
             currentObject[name] = [attrs];
         } else {
             currentObject[name] = attrs;
@@ -51,35 +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()
         }
 
-        // node-expat already reverse sanitizes it whether we like it or not
         //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()];
             }
         }
     }
@@ -113,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.
@@ -125,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.
@@ -148,12 +155,19 @@ 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.boolean().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);
     options = validation.value;
-
+    options.forceArrays = {};
+    if (Array.isArray(options.arrayNotation)) {
+        options.arrayNotation.forEach(function(i) {
+            options.forceArrays[i] = true;
+        });
+        options.arrayNotation = false;
+    }
     if (!parser.parse(xml)) {
         throw new Error('There are errors in your xml file: ' + parser.getError());
     }
@@ -166,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;
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "xml2json",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Converts xml to json and vice-versa, using node-expat.",
   "repository": "git://github.com/buglabs/node-xml2json.git",
   "license": "MIT",

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/fixtures/forceArray.json

@@ -0,0 +1 @@
+{"json":{"id":"123b","vehicles":[{"year":"1989","annual_mileage":"18000","average_mileage":"30","alarm":"1","ownership":"Financed","make":"TOYOTA","model":"Camry","commute_days_per_week":"5","collision":"$ 500","comprehensive":"$ 500","primary_purpose":"Pleasure"},{"year":"2006","annual_mileage":"37500","average_mileage":"10","alarm":"1","ownership":"Owned","make":"CHRYSLER","model":"CROSSFIRE","commute_days_per_week":"3","collision":"$ 5000","comprehensive":"$ 500","primary_purpose":"CommuteWork"}],"drivers":[{"driver":"Bray Wyatt","birth_date":"1987-05-23","marital_status":"Single","relationship":"Self","gender":"Male","first_licensed":"18","license_status":"ValidLicense","occupation":"Unemployed","education":"HighSchoolDiploma","credit_rating":"Unsure"}]}}