feat: omit objects with empty values (apache#24)

and add tests

Author: n1ru4l

lib/pbxProject.js

@@ -64,8 +64,8 @@ pbxProject.prototype.parseSync = function() {
     return this;
 }
 
-pbxProject.prototype.writeSync = function() {
-    this.writer = new pbxWriter(this.hash);
+pbxProject.prototype.writeSync = function(options) {
+    this.writer = new pbxWriter(this.hash, options);
     return this.writer.writeSync();
 }
 

lib/pbxWriter.js

@@ -49,10 +49,18 @@ function isArray(obj) {
     return Array.isArray(obj)
 }
 
-function pbxWriter(contents) {
+function pbxWriter(contents, options) {
+    if (!options) {
+        options = {}
+    }
+    if (options.omitEmptyValues === undefined) {
+        options.omitEmptyValues = false
+    }
+
     this.contents = contents;
     this.sync = false;
     this.indentLevel = 0;
+    this.omitEmptyValues = options.omitEmptyValues
 }
 
 util.inherits(pbxWriter, EventEmitter);
@@ -123,6 +131,8 @@ pbxWriter.prototype.writeProject = function () {
 
                 this.indentLevel--;
                 this.write("};\n");
+            } else if (this.omitEmptyValues && (obj === undefined || obj === null)) {
+                continue;
             } else if (cmt) {
                 this.write("%s = %s /* %s */;\n", key, obj, cmt)
             } else {
@@ -156,7 +166,9 @@ pbxWriter.prototype.writeObject = function (object) {
             this.indentLevel--;
             this.write("};\n");
         } else {
-            if (cmt) {
+            if (this.omitEmptyValues && (obj === undefined || obj === null)) {
+                continue;
+            } else if (cmt) {
                 this.write("%s = %s /* %s */;\n", key, obj, cmt)
             } else {
                 this.write("%s = %s;\n", key, obj)
@@ -255,6 +267,7 @@ pbxWriter.prototype.writeSection = function (section) {
 
 pbxWriter.prototype.writeInlineObject = function (n, d, r) {
     var output = [];
+    var self = this
 
     var inlineObjectHelper = function (name, desc, ref) {
         var key, cmt, obj;
@@ -281,6 +294,8 @@ pbxWriter.prototype.writeInlineObject = function (n, d, r) {
                 output.push("); ");
             } else if (isObject(obj)) {
                 inlineObjectHelper(key, cmt, obj)
+            } else if (self.omitEmptyValues && (obj === undefined || obj === null)) {
+                continue;
             } else if (cmt) {
                 output.push(f("%s = %s /* %s */; ", key, obj, cmt))
             } else {

test/parser/projects/expected/with_omit_empty_values_disabled_expected.pbxproj

@@ -96,5 +96,37 @@ exports.writeSync = {
     },
     'should write out the "file-references" test': function (test) {
         testProjectContents('test/parser/projects/file-references.pbxproj', test);
+    },
+    'should not null and undefined with the "omitEmptyValues" option set to false test': function (test) {
+        var filename = 'test/parser/projects/with_omit_empty_values_disabled.pbxproj'
+        var expectedFilename = 'test/parser/projects/expected/with_omit_empty_values_disabled_expected.pbxproj'
+        var content = fs.readFileSync(expectedFilename, 'utf-8').replace(/    /g, '\t');
+        var project = new pbx(filename);
+        project.parse(function (err) {
+            if (err) {
+                return test.done(err);
+            }
+            const group = project.addPbxGroup([], 'CustomGroup', undefined)
+            var written = project.writeSync();
+            content = content.replace('CUSTOM_GROUP_UUID_REPLACED_BY_TEST', group.uuid)
+            test.equal(content, written);
+            test.done();
+        });
+    },
+    'should drop null and undefined with the "omitEmptyValues" option set to true test': function (test) {
+        var filename = 'test/parser/projects/with_omit_empty_values_enabled.pbxproj'
+        var expectedFilename = 'test/parser/projects/expected/with_omit_empty_values_enabled_expected.pbxproj'
+        var content = fs.readFileSync(expectedFilename, 'utf-8').replace(/    /g, '\t');
+        var project = new pbx(filename);
+        project.parse(function (err) {
+            if (err) {
+                return test.done(err);
+            }
+            var group = project.addPbxGroup([], 'CustomGroup', undefined);
+            var written = project.writeSync({ omitEmptyValues: true });
+            content = content.replace('CUSTOM_GROUP_UUID_REPLACED_BY_TEST', group.uuid)
+            test.equal(content, written);
+            test.done();
+        });
     }
 }