Enable image resources from App_Resources in iOS

Fixes #520

Author: Fatme Havaluova

bin/nativescript.js

@@ -27,6 +27,7 @@ interface IPlatformProjectService {
 	interpolateData(projectRoot: string): IFuture<void>;
 	afterCreateProject(projectRoot: string): IFuture<void>;
 	buildProject(projectRoot: string): IFuture<void>;
+	prepareProject(): IFuture<void>;
 	isPlatformPrepared(projectRoot: string): IFuture<boolean>;
 	addLibrary(platformData: IPlatformData, libraryPath: string): IFuture<void>;
 	canUpdatePlatform(currentVersion: string, newVersion: string): IFuture<boolean>;

lib/definitions/project.d.ts

@@ -273,6 +273,10 @@ class AndroidProjectService implements IPlatformProjectService {
 	public getFrameworkFilesExtensions(): string[] {
 		return [".jar", ".dat"];
 	}
+	
+	public prepareProject(): IFuture<void> {
+		return (() => { }).future<void>()();
+	}
 
 	private copy(projectRoot: string, frameworkDir: string, files: string, cpArg: string): IFuture<void> {
 		return (() => {

lib/services/android-project-service.ts

@@ -182,13 +182,11 @@ class IOSProjectService implements  IPlatformProjectService {
             this.$fs.ensureDirectoryExists(targetPath).wait();
             shell.cp("-R", libraryPath, targetPath);
 
-            var pbxProjPath = path.join(platformData.projectRoot, this.$projectData.projectName + ".xcodeproj", "project.pbxproj");
-            var project = new xcode.project(pbxProjPath);
-            project.parseSync();
+            let project = this.createPbxProj();
 
             project.addFramework(path.join(targetPath, frameworkName + ".framework"), { customFramework: true, embed: true });
             project.updateBuildProperty("IPHONEOS_DEPLOYMENT_TARGET", "8.0");
-            this.$fs.writeFile(pbxProjPath, project.writeSync()).wait();
+            this.savePbxProj(project).wait();
             this.$logger.info("The iOS Deployment Target is now 8.0 in order to support Cocoa Touch Frameworks.");
         }).future<void>()();
 	}
@@ -221,11 +219,63 @@ class IOSProjectService implements  IPlatformProjectService {
 			shell.cp("-R", path.join(cachedPackagePath, "*"), path.join(this.platformData.projectRoot, util.format("%s.xcodeproj", this.$projectData.projectName)));
 			this.$logger.info("Copied from %s at %s.", cachedPackagePath, this.platformData.projectRoot);
 
-
 			var pbxprojFilePath = path.join(this.platformData.projectRoot, this.$projectData.projectName + IOSProjectService.XCODE_PROJECT_EXT_NAME, "project.pbxproj");
 			this.replaceFileContent(pbxprojFilePath).wait();
 		}).future<void>()();
 	}
+	
+	public prepareProject(): IFuture<void> {
+		return (() => {
+			let project = this.createPbxProj();
+			let resources = project.pbxGroupByName("Resources");
+			
+			if(resources) {
+				let references = project.pbxFileReferenceSection();
+				
+				let xcodeProjectImages = _.map(<any[]>resources.children, resource => this.replace(references[resource.value].name));
+				this.$logger.trace("Images from Xcode project");
+				this.$logger.trace(xcodeProjectImages);
+				
+				let appResourcesImages = this.$fs.readDirectory(this.platformData.appResourcesDestinationDirectoryPath).wait();
+				this.$logger.trace("Current images from App_Resources");
+				this.$logger.trace(appResourcesImages);
+	
+				let imagesToAdd = _.difference(appResourcesImages, xcodeProjectImages);
+				this.$logger.trace(`New images to add into xcode project: ${imagesToAdd.join(", ")}`);			
+				_.each(imagesToAdd, image => project.addResourceFile(path.relative(this.platformData.projectRoot, path.join( this.platformData.appResourcesDestinationDirectoryPath, image))));
+				
+				let imagesToRemove = _.difference(xcodeProjectImages, appResourcesImages);
+				this.$logger.trace(`Images to remove from xcode project: ${imagesToRemove.join(", ")}`);			
+				_.each(imagesToRemove, image => project.removeResourceFile(path.join(this.platformData.appResourcesDestinationDirectoryPath, image))); 
+				
+				this.savePbxProj(project).wait();
+			}
+			
+		}).future<void>()();
+	}
+	
+	private replace(name: string): string {
+		if(_.startsWith(name, '"')) {
+			name = name.substr(1, name.length-2);
+		}
+		
+		return name.replace(/\\\"/g, "\"");
+	}
+	
+	private get pbxProjPath(): string {
+		return path.join(this.platformData.projectRoot, this.$projectData.projectName + ".xcodeproj", "project.pbxproj");
+	}
+	
+	private createPbxProj(): any {
+		let project = new xcode.project(this.pbxProjPath);
+		project.parseSync();
+		
+		return project;
+	}
+	
+	private savePbxProj(project: any): IFuture<void> {
+		 return this.$fs.writeFile(this.pbxProjPath, project.writeSync());
+	}
 
 	private buildPathToXcodeProjectFile(version: string): string {
 		return path.join(this.$npmInstallationManager.getCachedPackagePath(this.platformData.frameworkPackageName, version), constants.PROJECT_FRAMEWORK_FOLDER_NAME, util.format("%s.xcodeproj", IOSProjectService.IOS_PROJECT_NAME_PLACEHOLDER), "project.pbxproj");

lib/services/ios-project-service.ts

@@ -160,7 +160,8 @@ export class PlatformService implements IPlatformService {
 			this.$fs.ensureDirectoryExists(platformData.appResourcesDestinationDirectoryPath).wait(); // Should be deleted
 			var appResourcesDirectoryPath = path.join(platformData.appDestinationDirectoryPath, constants.APP_FOLDER_NAME, constants.APP_RESOURCES_FOLDER_NAME);
 			if (this.$fs.exists(appResourcesDirectoryPath).wait()) {
-				shell.cp("-Rf", path.join(appResourcesDirectoryPath, platformData.normalizedPlatformName, "*"), platformData.appResourcesDestinationDirectoryPath);
+				this.$fs.deleteDirectory(platformData.appResourcesDestinationDirectoryPath).wait(); // Respect removed files
+				shell.cp("-R", path.join(appResourcesDirectoryPath, platformData.normalizedPlatformName, "*"), platformData.appResourcesDestinationDirectoryPath);
 				this.$fs.deleteDirectory(appResourcesDirectoryPath).wait();
 			}
 
@@ -178,6 +179,8 @@ export class PlatformService implements IPlatformService {
 				}
 			});
 			this.processPlatformSpecificFiles(platform, files).wait();
+			
+			platformData.platformProjectService.prepareProject().wait();
 
 			// Process node_modules folder
 			this.$pluginsService.ensureAllDependenciesAreInstalled().wait();

lib/services/platform-service.ts

@@ -68,7 +68,7 @@
     "utf-8-validate": "https://github.com/telerik/utf-8-validate/tarball/master",
     "winreg": "0.0.12",
     "ws": "0.7.1",
-    "xcode": "https://github.com/NativeScript/node-xcode/archive/NativeScript-0.9.tar.gz",
+    "xcode": "https://github.com/NativeScript/node-xcode/archive/NativeScript-1.1.tar.gz",
     "xmldom": "0.1.19",
     "xmlhttprequest": "https://github.com/telerik/node-XMLHttpRequest/tarball/master",
     "xmlmerge-js": "0.2.4",

package.json

@@ -19,6 +19,7 @@ import BroccoliBuilderLib = require("../lib/tools/broccoli/builder");
 import NodeModulesTreeLib = require("../lib/tools/broccoli/trees/node-modules-tree");
 import PluginsServiceLib = require("../lib/services/plugins-service");
 import ChildProcessLib = require("../lib/common/child-process");
+import Future = require("fibers/future");
 
 import path = require("path");
 import temp = require("temp");
@@ -118,7 +119,10 @@ describe("Npm support tests", () => {
 				appDestinationDirectoryPath: appDestinationFolderPath,
 				appResourcesDestinationDirectoryPath: path.join(appDestinationFolderPath, "app", "App_Resources"),
 				frameworkPackageName: "tns-android",
-				normalizedPlatformName: "Android"
+				normalizedPlatformName: "Android",
+				platformProjectService: {
+					prepareProject: () => Future.fromResult()
+				}
 			}	
 		};
 

test/npm-support.ts

@@ -223,7 +223,10 @@ describe('Platform Service Tests', () => {
 				return {
 					appDestinationDirectoryPath: appDestFolderPath,
 					appResourcesDestinationDirectoryPath: appResourcesFolderPath,
-					normalizedPlatformName: "iOS"
+					normalizedPlatformName: "iOS",
+					platformProjectService: {
+						prepareProject: () => Future.fromResult()
+					}
 				}	
 			};
 
@@ -274,7 +277,10 @@ describe('Platform Service Tests', () => {
 				return {
 					appDestinationDirectoryPath: appDestFolderPath,
 					appResourcesDestinationDirectoryPath: appResourcesFolderPath,
-					normalizedPlatformName: "Android"
+					normalizedPlatformName: "Android",
+					platformProjectService: {
+						prepareProject: () => Future.fromResult()
+					}
 				}	
 			};
 

test/platform-service.ts

@@ -276,8 +276,8 @@ export class PlatformProjectServiceStub implements IPlatformProjectService {
 	afterCreateProject(projectRoot: string): IFuture<void> {
 		return Future.fromResult();
 	}
-	prepareProject(platformData: IPlatformData): IFuture<string> {
-		return Future.fromResult("");
+	prepareProject(): IFuture<void> {
+		return Future.fromResult();
 	}
 	buildProject(projectRoot: string): IFuture<void> {
 		return Future.fromResult();