added PBXVariantGroup for localization and nodeunit test cases

Author: kelvinhokk

lib/pbxFile.js

@@ -29,7 +29,8 @@ var FILETYPE_BY_EXTENSION = {
         xcdatamodel: 'wrapper.xcdatamodel',
         xcodeproj: 'wrapper.pb-project',
         xctest: 'wrapper.cfbundle',
-        xib: 'file.xib'
+        xib: 'file.xib',
+        strings: 'text.plist.strings'
     },
     GROUP_BY_FILETYPE = {
         'archive.ar': 'Frameworks',
@@ -59,7 +60,8 @@ var FILETYPE_BY_EXTENSION = {
         'text': 4,
         'text.plist.xml': 4,
         'text.script.sh': 4,
-        'text.xcconfig': 4
+        'text.xcconfig': 4,
+        'text.plist.strings': 4
     };
 
 

lib/pbxProject.js

@@ -241,14 +241,21 @@ pbxProject.prototype.addResourceFile = function(path, opt, group) {
         correctForResourcesPath(file, this);
         file.fileRef = this.generateUuid();
     }
-    
-    this.addToPbxBuildFileSection(file);        // PBXBuildFile
-    this.addToPbxResourcesBuildPhase(file);     // PBXResourcesBuildPhase
-    
+
+    if (!opt.variantGroup) {
+        this.addToPbxBuildFileSection(file);        // PBXBuildFile
+        this.addToPbxResourcesBuildPhase(file);     // PBXResourcesBuildPhase
+    }
+
     if (!opt.plugin) {
         this.addToPbxFileReferenceSection(file);    // PBXFileReference
         if (group) {
-            this.addToPbxGroup(file, group);            //Group other than Resources (i.e. 'splash')
+            if (this.getPBXGroupByKey(group)) {
+                this.addToPbxGroup(file, group);        //Group other than Resources (i.e. 'splash')
+            }
+            else if (this.getPBXVariantGroupByKey(group)) {
+                this.addToPbxVariantGroup(file, group);  // PBXVariantGroup
+            }
         }
         else {
             this.addToResourcesPbxGroup(file);          // PBXGroup
@@ -275,7 +282,12 @@ pbxProject.prototype.removeResourceFile = function(path, opt, group) {
     this.removeFromPbxBuildFileSection(file);        // PBXBuildFile
     this.removeFromPbxFileReferenceSection(file);    // PBXFileReference
     if (group) {
-        this.removeFromPbxGroup(file, group);           //Group other than Resources (i.e. 'splash')
+        if (this.getPBXGroupByKey(group)) {
+            this.removeFromPbxGroup(file, group);        //Group other than Resources (i.e. 'splash')
+        }
+        else if (this.getPBXVariantGroupByKey(group)) {
+            this.removeFromPbxVariantGroup(file, group);  // PBXVariantGroup
+        }
     }
     else {
         this.removeFromResourcesPbxGroup(file);          // PBXGroup
@@ -1696,15 +1708,20 @@ pbxProject.prototype.getFirstTarget = function() {
 
 /*** NEW ***/
 
-pbxProject.prototype.addToPbxGroup = function (file, groupKey) {
-    var group = this.getPBXGroupByKey(groupKey);
+pbxProject.prototype.addToPbxGroupType = function (file, groupKey, groupType) {
+    var group = this.getPBXGroupByKeyAndType(groupKey, groupType);
     if (group && group.children !== undefined) {
         if (typeof file === 'string') {
             //Group Key
             var childGroup = {
                 value:file,
-                comment: this.getPBXGroupByKey(file).name
             };
+            if (this.getPBXGroupByKey(file)) {
+                childGroup.comment = this.getPBXGroupByKey(file).name;
+            }
+            else if (this.getPBXVariantGroupByKey(file)) {
+                childGroup.comment = this.getPBXVariantGroupByKey(file).name;
+            }
 
             group.children.push(childGroup);
         }
@@ -1715,8 +1732,53 @@ pbxProject.prototype.addToPbxGroup = function (file, groupKey) {
     }
 }
 
-pbxProject.prototype.removeFromPbxGroup = function (file, groupKey) {
-    var group = this.getPBXGroupByKey(groupKey);
+pbxProject.prototype.addToPbxVariantGroup = function (file, groupKey) {
+    this.addToPbxGroupType(file, groupKey, 'PBXVariantGroup');
+}
+
+pbxProject.prototype.addToPbxGroup = function (file, groupKey) {
+    this.addToPbxGroupType(file, groupKey, 'PBXGroup');
+}
+
+
+
+pbxProject.prototype.pbxCreateGroupWithType = function(name, pathName, groupType) {
+    //Create object
+    var model = {
+        isa: '"' + groupType + '"',
+        children: [],
+        name: name,
+        sourceTree: '"<group>"'
+    };
+    if (pathName) model.path = pathName;
+    var key = this.generateUuid();
+
+    //Create comment
+    var commendId = key + '_comment';
+
+    //add obj and commentObj to groups;
+    var groups = this.hash.project.objects[groupType];
+    if (!groups) {
+        groups = this.hash.project.objects[groupType] = new Object();
+    }
+    groups[commendId] = name;
+    groups[key] = model;
+
+    return key;
+}
+
+pbxProject.prototype.pbxCreateVariantGroup = function(name) {
+    return this.pbxCreateGroupWithType(name, undefined, 'PBXVariantGroup')
+}
+
+pbxProject.prototype.pbxCreateGroup = function(name, pathName) {
+    return this.pbxCreateGroupWithType(name, pathName, 'PBXGroup');
+}
+
+
+
+pbxProject.prototype.removeFromPbxGroupAndType = function (file, groupKey, groupType) {
+    var group = this.getPBXGroupByKeyAndType(groupKey, groupType);
     if (group) {
         var groupChildren = group.children, i;
         for(i in groupChildren) {
@@ -1729,12 +1791,32 @@ pbxProject.prototype.removeFromPbxGroup = function (file, groupKey) {
     }
 }
 
+pbxProject.prototype.removeFromPbxGroup = function (file, groupKey) {
+    this.removeFromPbxGroupAndType(file, groupKey, 'PBXGroup');
+}
+
+pbxProject.prototype.removeFromPbxVariantGroup = function (file, groupKey) {
+    this.removeFromPbxGroupAndType(file, groupKey, 'PBXVariantGroup');
+}
+
+
+
+pbxProject.prototype.getPBXGroupByKeyAndType = function(key, groupType) {
+    return this.hash.project.objects[groupType][key];
+};
+
 pbxProject.prototype.getPBXGroupByKey = function(key) {
     return this.hash.project.objects['PBXGroup'][key];
 };
 
-pbxProject.prototype.findPBXGroupKey = function(criteria) {
-    var groups = this.hash.project.objects['PBXGroup'];
+pbxProject.prototype.getPBXVariantGroupByKey = function(key) {
+    return this.hash.project.objects['PBXVariantGroup'][key];
+};
+
+
+
+pbxProject.prototype.findPBXGroupKeyAndType = function(criteria, groupType) {
+    var groups = this.hash.project.objects[groupType];
     var target;
 
     for (var key in groups) {
@@ -1765,28 +1847,30 @@ pbxProject.prototype.findPBXGroupKey = function(criteria) {
     return target;
 }
 
-pbxProject.prototype.pbxCreateGroup = function(name, pathName) {
+pbxProject.prototype.findPBXGroupKey = function(criteria) {
+    return this.findPBXGroupKeyAndType(criteria, 'PBXGroup');
+}
 
-    //Create object
-    var model = {
-        isa:"PBXGroup",
-        children: [],
-        name: name,
-        path: pathName,
-        sourceTree: '"<group>"'
-    };
-    var key = this.generateUuid();
+pbxProject.prototype.findPBXVariantGroupKey = function(criteria) {
+    return this.findPBXGroupKeyAndType(criteria, 'PBXVariantGroup');
+}
 
-    //Create comment
-    var commendId = key + '_comment';
+pbxProject.prototype.addLocalizationVariantGroup = function(name) {
+    var groupKey = this.pbxCreateVariantGroup(name);
 
-    //add obj and commentObj to groups;
-    var groups = this.hash.project.objects['PBXGroup'];
-    groups[commendId] = name;
-    groups[key] = model;
+    var resourceGroupKey = this.findPBXGroupKey({name: 'Resources'});
+    this.addToPbxGroup(groupKey, resourceGroupKey);
 
-    return key;
-}
+    var localizationVariantGroup = {
+        uuid: this.generateUuid(),
+        fileRef: groupKey,
+        basename: name
+    }
+    this.addToPbxBuildFileSection(localizationVariantGroup);        // PBXBuildFile
+    this.addToPbxResourcesBuildPhase(localizationVariantGroup);     //PBXResourcesBuildPhase
+
+    return localizationVariantGroup;
+};
 
 
 pbxProject.prototype.getPBXObject = function(name) {
@@ -1804,7 +1888,13 @@ pbxProject.prototype.addFile = function (path, group, opt) {
     file.fileRef = this.generateUuid();
 
     this.addToPbxFileReferenceSection(file);    // PBXFileReference
-    this.addToPbxGroup(file, group);            // PBXGroup
+
+    if (this.getPBXGroupByKey(group)) {
+        this.addToPbxGroup(file, group);        // PBXGroup
+    }
+    else if (this.getPBXVariantGroupByKey(group)) {
+        this.addToPbxVariantGroup(file, group);            // PBXVariantGroup
+    }
 
     return file;
 }
@@ -1813,7 +1903,13 @@ pbxProject.prototype.removeFile = function (path, group, opt) {
     var file = new pbxFile(path, opt);
 
     this.removeFromPbxFileReferenceSection(file);    // PBXFileReference
-    this.removeFromPbxGroup(file, group);            // PBXGroup
+
+    if (this.getPBXGroupByKey(group)) {
+        this.removeFromPbxGroup(file, group);            // PBXGroup
+    }
+    else if (this.getPBXVariantGroupByKey(group)) {
+        this.removeFromPbxVariantGroup(file, group);     // PBXVariantGroup
+    }
 
     return file;
 }

test/addResourceFile.js

@@ -210,6 +210,22 @@ exports.addResourceFile = {
             test.done();
         }
     },
+    'when added with { variantGroup: true }': {
+
+        'should not add to the PBXResourcesBuildPhase and PBXBuildFile': function (test) {
+            var newFile = proj.addResourceFile('en.lproj/Localization.strings',
+                { variantGroup: true });
+
+            var sources = proj.pbxResourcesBuildPhaseObj();
+            test.equal(sources.files.length, 12);
+
+            var buildFileSection = proj.pbxBuildFileSection();
+            test.ok(buildFileSection[newFile.uuid] === undefined);
+
+            test.done();
+        },
+
+    },
     'duplicate entries': {
         'should return false': function (test) {
             var newFile = proj.addResourceFile('Plugins/assets.bundle');