Merge pull request #163 from Clement134/feature/null-properties

json2xml ignore null properties

Author: c4milo

README.md

@@ -85,11 +85,13 @@ var chars =  {
 Default values:
 ```javascript
 var options = {
-    sanitize: false
+    sanitize: false,
+    ignoreNull: false
 };
 ```
 
-`sanitize: false` is the default option to behave like previous versions
+* `sanitize: false` is the default option to behave like previous versions
+* **ignoreNull:** Ignores all null values
 
 
 (*) xml2json tranforms CDATA content to JSON, but it doesn't generate a reversible structure.

lib/json2xml.js

@@ -21,6 +21,8 @@ module.exports = function (json, options) {
 }
 
 ToXml.prototype.parse = function(obj) {
+    if (!obj) return;
+
     var self = this;
     var keys = Object.keys(obj);
     var len = keys.length;
@@ -60,7 +62,7 @@ ToXml.prototype.parse = function(obj) {
                     self.closeTag(key);
                 }
             }
-        } else if (typeof(obj[key]) == 'object') {
+        } else if (typeof(obj[key]) == 'object' && !(self.options.ignoreNull && obj[key] === null)) {
             self.openTag(key);
             self.parse(obj[key]);
             self.closeTag(key);
@@ -97,7 +99,8 @@ ToXml.prototype.completeTag = function() {
 }
 function ToXml(options) {
     var defaultOpts = {
-        sanitize: false
+        sanitize: false,
+        ignoreNull: false
     };
 
     if (options) {

test/fixtures/null-properties-ignored.xml

@@ -0,0 +1 @@
+<subObject propertyNotNull="value"></subObject>

test/fixtures/null-properties-not-ignored.xml

@@ -0,0 +1 @@
+<subObject propertyNotNull="value"><propertyNull></propertyNull></subObject>

test/fixtures/null-properties.json

@@ -0,0 +1 @@
+{"subObject": {"propertyNotNull": "value","propertyNull":null}}

test/test.js

@@ -220,7 +220,7 @@ describe('xml2json', function () {
             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();
@@ -231,13 +231,13 @@ describe('xml2json', function () {
             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');
@@ -248,13 +248,13 @@ describe('xml2json', function () {
 
             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();
@@ -299,6 +299,32 @@ describe('json2xml', function () {
 
         done();
     });
+
+    describe('ignore null', function () {
+
+        it('ignore null properties {ignoreNull: true}', function (done) {
+
+            var json = JSON.parse( internals.readFixture('null-properties.json') );
+            var expectedXml = internals.readFixture('null-properties-ignored.xml');
+
+            var xml = parser.toXml(json, {ignoreNull: true});
+            expect(xml).to.equal(expectedXml);
+
+            done();
+        });
+
+        it('don\'t ignore null properties (default)', function (done) {
+
+            var json = JSON.parse( internals.readFixture('null-properties.json') );
+            var expectedXml = internals.readFixture('null-properties-not-ignored.xml');
+
+            var xml = parser.toXml(json);
+            expect(xml).to.equal(expectedXml);
+
+            done();
+        });
+
+    });
 });