fix: return existing reference in addFramework and tests

Author: KristianDD

lib/pbxProject.js

@@ -348,27 +348,33 @@ pbxProject.prototype.addFramework = function(fpath, opt) {
     }
 
     if (link) {
-        if(this.addToPbxFrameworksBuildPhase(file)) {   // PBXFrameworksBuildPhase)
+        const buildFileUuid = this.addToPbxFrameworksBuildPhase(file);
+        if(buildFileUuid === file.uuid) {   // PBXFrameworksBuildPhase)
             this.addToPbxBuildFileSection(file);        // PBXBuildFile
+        } else {
+            file.uuid = buildFileUuid;
         }
     }
 
     if (customFramework) {
         this.addToFrameworkSearchPaths(file);
 
         if (embed) {
-          opt.embed = embed;
-          var embeddedFile = new pbxFile(fpath, opt);
-
-          embeddedFile.uuid = this.generateUuid();
-          embeddedFile.fileRef = file.fileRef;
-          embeddedFile.target = file.target;
-
-            if(this.addToPbxEmbedFrameworksBuildPhase(embeddedFile)) {  // PBXCopyFilesBuildPhase
+            opt.embed = embed;
+            var embeddedFile = new pbxFile(fpath, opt);
+
+            embeddedFile.uuid = this.generateUuid();
+            embeddedFile.fileRef = file.fileRef;
+            embeddedFile.target = file.target;
+            const embedBuildFileUuid = this.addToPbxEmbedFrameworksBuildPhase(embeddedFile);
+            if(embedBuildFileUuid === embeddedFile.uuid) {  // PBXCopyFilesBuildPhase
                 //keeping a separate PBXBuildFile entry for Embed Frameworks
                 this.addToPbxBuildFileSection(embeddedFile);            // PBXBuildFile
-                return embeddedFile;
+            } else {
+                embeddedFile.uuid = embedBuildFileUuid;
             }
+
+            return embeddedFile;
         }
     }
 
@@ -861,11 +867,11 @@ pbxProject.prototype.removeFromFrameworksPbxGroup = function(file) {
     }
 }
 
-function hasReferenceInPbxBuildFile(buildFileReferences, fileReference) {
+function getReferenceInPbxBuildFile(buildFileReferences, fileReference) {
     var buildFileSection = this.pbxBuildFileSection();
     for(let buildFileReference of buildFileReferences) {
         if(buildFileSection[buildFileReference.value] && buildFileSection[buildFileReference.value].fileRef === fileReference.fileRef){
-            return true;
+            return buildFileReference.value;
         }
     }
 }
@@ -874,12 +880,13 @@ pbxProject.prototype.addToPbxEmbedFrameworksBuildPhase = function (file) {
     var sources = this.pbxEmbedFrameworksBuildPhaseObj(file.target);
 
     if (sources) {
-        if(hasReferenceInPbxBuildFile.call(this, sources.files, file)){
-            return false;
+        var referenceUuid = getReferenceInPbxBuildFile.call(this, sources.files, file)
+        if(referenceUuid){
+            return referenceUuid;
         }
 
         sources.files.push(pbxBuildPhaseObj(file));
-        return true;
+        return file.uuid;
     }
 }
 
@@ -955,12 +962,13 @@ pbxProject.prototype.addToPbxFrameworksBuildPhase = function(file) {
     var sources = this.pbxFrameworksBuildPhaseObj(file.target);
 
     if (sources) {
-        if (hasReferenceInPbxBuildFile.call(this, sources.files, file)) {
-            return false;
+        var frameworkBuildUuid = getReferenceInPbxBuildFile.call(this, sources.files, file);
+        if (frameworkBuildUuid) {
+            return frameworkBuildUuid;
         }
 
         sources.files.push(pbxBuildPhaseObj(file));
-        return true;
+        return file.uuid;
     }
 }
 

test/addFramework.js

@@ -188,10 +188,20 @@ exports.addFramework = {
         test.done();
     },
     'duplicate entries': {
-        'should return false': function (test) {
+        'should return same build file': function (test) {
             var newFile = proj.addFramework('libsqlite3.dylib');
+            var sameFile = proj.addFramework('libsqlite3.dylib');
 
-            test.ok(!proj.addFramework('libsqlite3.dylib'));
+            test.equal(newFile.uuid, sameFile.uuid);
+            test.equal(newFile.fileRef, sameFile.fileRef);
+            test.done();
+        },
+        'should return different build file with same ref for different target': function (test) {
+            var newFile = proj.addFramework('libsqlite3.dylib');
+            var differentFile = proj.addFramework('libsqlite3.dylib', { target: "1D6058900D05DD3D006BFB54"});
+
+            test.notEqual(newFile.uuid, differentFile.uuid);
+            test.equal(newFile.fileRef, differentFile.fileRef);
             test.done();
         }
     },

test/fixtures/full-project.json

@@ -564,7 +564,15 @@
           ],
           "runOnlyForDeploymentPostprocessing": 0
         },
-        "1D60588F0D05DD3D006BFB54_comment": "Frameworks"
+        "1D60588F0D05DD3D006BFB54_comment": "Frameworks",
+        "2D60588F0D05DD3D006BFB55": {
+          "isa": "PBXFrameworksBuildPhase",
+          "buildActionMask": 2147483647,
+          "files": [
+          ],
+          "runOnlyForDeploymentPostprocessing": 0
+        },
+        "2D60588F0D05DD3D006BFB55_comment": "Frameworks"
       },
       "PBXGroup": {
         "080E96DDFE201D6D7F000001": {
@@ -866,7 +874,7 @@
               "comment": "Sources"
             },
             {
-              "value": "1D60588F0D05DD3D006BFB54",
+              "value": "2D60588F0D05DD3D006BFB55",
               "comment": "Frameworks"
             }
           ],