[pbxProject] addHeaderFile

plus some refactoring

Author: alunny

lib/pbxProject.js

@@ -68,42 +68,30 @@ pbxProject.prototype.generateUuid = function () {
 }
 
 pbxProject.prototype.addSourceFile = function (path, opt) {
-    var file = new pbxFile(path, opt),
-        commentKey, pluginsGroup, sources;
+    var file = new pbxFile(path, opt);
 
     file.uuid = this.generateUuid();
     file.fileRef = this.generateUuid();
 
-    // PBXBuildFile
-    commentKey = f("%s_comment", file.uuid);
+    this.addToPbxBuildFileSection(file); // PBXBuildFile
+    this.addToPbxFileReferenceSection(file); // PBXFileReference
+    this.addToPluginsPbxGroup(file); // PBXGroup
+    this.addToPbxSourcesBuildPhase(file); // PBXSourcesBuildPhase
 
-    this.pbxBuildFileSection()[file.uuid] = pbxBuildFileObj(file);
-    this.pbxBuildFileSection()[commentKey] = pbxBuildFileComment(file);
-
-    // PBXFileReference
-    commentKey = f("%s_comment", file.fileRef);
+    return file;
+}
 
-    this.pbxFileReferenceSection()[file.fileRef] = pbxFileReferenceObj(file);
-    this.pbxFileReferenceSection()[commentKey] = pbxFileReferenceComment(file);
+pbxProject.prototype.addHeaderFile = function (path, opt) {
+    var file = new pbxFile(path, opt);
 
-    // PBXGroup
-    pluginsGroup = this.pbxGroupByName('Plugins');
-    pluginsGroup.children.push(pbxGroupChild(file));
+    file.fileRef = this.generateUuid();
 
-    // PBXSourcesBuildPhase
-    sources = this.pbxSourcesBuildPhaseObj();
-    sources.files.push(pbxSourceFileObj(file));
+    this.addToPbxFileReferenceSection(file); // PBXFileReference
+    this.addToPluginsPbxGroup(file); // PBXGroup
 
     return file;
 }
 
-pbxProject.prototype.addHeaderFile = function (path, opt) {
-    /*
-     * PBXFileReference
-     * PBXGroup (Plugins)
-     */
-}
-
 pbxProject.prototype.addResourceFile = function (path, opt) {
     /*
      * PBXBuildFile
@@ -114,6 +102,30 @@ pbxProject.prototype.addResourceFile = function (path, opt) {
 }
 
 // helper access functions
+pbxProject.prototype.addToPbxBuildFileSection = function (file) {
+    var commentKey = f("%s_comment", file.uuid);
+
+    this.pbxBuildFileSection()[file.uuid] = pbxBuildFileObj(file);
+    this.pbxBuildFileSection()[commentKey] = pbxBuildFileComment(file);
+}
+
+pbxProject.prototype.addToPbxFileReferenceSection = function (file) {
+    var commentKey = f("%s_comment", file.fileRef);
+
+    this.pbxFileReferenceSection()[file.fileRef] = pbxFileReferenceObj(file);
+    this.pbxFileReferenceSection()[commentKey] = pbxFileReferenceComment(file);
+}
+
+pbxProject.prototype.addToPluginsPbxGroup = function (file) {
+    var pluginsGroup = this.pbxGroupByName('Plugins');
+    pluginsGroup.children.push(pbxGroupChild(file));
+}
+
+pbxProject.prototype.addToPbxSourcesBuildPhase = function (file) {
+    var sources = this.pbxSourcesBuildPhaseObj();
+    sources.files.push(pbxSourceFileObj(file));
+}
+
 pbxProject.prototype.pbxBuildFileSection = function () {
     return this.hash.project.objects['PBXBuildFile'];
 }

test/addHeaderFile.js

@@ -0,0 +1,78 @@
+var fullProject = require('./fixtures/full-project')
+    fullProjectStr = JSON.stringify(fullProject),
+    pbx = require('../lib/pbxProject'),
+    pbxFile = require('../lib/pbxFile'),
+    proj = new pbx('.');
+
+function cleanHash() {
+    return JSON.parse(fullProjectStr);
+}
+
+exports.setUp = function (callback) {
+    proj.hash = cleanHash();
+    callback();
+}
+
+exports.addHeaderFile = {
+    'should return a pbxFile': function (test) {
+        var newFile = proj.addHeaderFile('file.h');
+
+        test.equal(newFile.constructor, pbxFile);
+        test.done()
+    },
+    'should set a fileRef on the pbxFile': function (test) {
+        var newFile = proj.addHeaderFile('file.h');
+
+        test.ok(newFile.fileRef);
+        test.done()
+    },
+    'should populate the PBXFileReference section with 2 fields': function (test) {
+        var newFile = proj.addHeaderFile('file.h'),
+            fileRefSection = proj.pbxFileReferenceSection(),
+            frsLength = Object.keys(fileRefSection).length;
+
+        test.equal(68, frsLength);
+        test.ok(fileRefSection[newFile.fileRef]);
+        test.ok(fileRefSection[newFile.fileRef + '_comment']);
+
+        test.done();
+    },
+    'should populate the PBXFileReference comment correctly': function (test) {
+        var newFile = proj.addHeaderFile('file.h'),
+            fileRefSection = proj.pbxFileReferenceSection(),
+            commentKey = newFile.fileRef + '_comment';
+
+        test.equal(fileRefSection[commentKey], 'file.h');
+        test.done();
+    },
+    'should add the PBXFileReference object correctly': function (test) {
+        var newFile = proj.addHeaderFile('Plugins/file.h'),
+            fileRefSection = proj.pbxFileReferenceSection(),
+            fileRefEntry = fileRefSection[newFile.fileRef];
+
+        test.equal(fileRefEntry.isa, 'PBXFileReference');
+        test.equal(fileRefEntry.fileEncoding, 4);
+        test.equal(fileRefEntry.lastKnownFileType, 'sourcecode.c.h');
+        test.equal(fileRefEntry.name, 'file.h');
+        test.equal(fileRefEntry.path, 'Plugins/file.h');
+        test.equal(fileRefEntry.sourceTree, '"<group>"');
+
+        test.done();
+    },
+    'should add to the Plugins PBXGroup group': function (test) {
+        var newFile = proj.addHeaderFile('Plugins/file.h'),
+            plugins = proj.pbxGroupByName('Plugins');
+
+        test.equal(plugins.children.length, 1);
+        test.done();
+    },
+    'should have the right values for the PBXGroup entry': function (test) {
+        var newFile = proj.addHeaderFile('Plugins/file.h'),
+            plugins = proj.pbxGroupByName('Plugins'),
+            pluginObj = plugins.children[0];
+
+        test.equal(pluginObj.comment, 'file.h');
+        test.equal(pluginObj.value, newFile.fileRef);
+        test.done();
+    }
+}