refactor: address pr comments, replace app_resources usage for whatever

the name of the app_resources directory basename is

Author: petekanev

lib/constants.ts

@@ -29,7 +29,7 @@ export const OUTPUTS_DIR = "outputs";
 export const APK_DIR = "apk";
 export const RESOURCES_DIR = "res";
 export const CONFIG_NS_FILE_NAME = "nsconfig.json";
-export const CONFIG_NS_APP_RESOURCES_ENTRY = "app_resources";
+export const CONFIG_NS_APP_RESOURCES_ENTRY = "appResourcesPath";
 
 export class PackageVersion {
 	static NEXT = "next";

lib/project-data.ts

@@ -93,6 +93,10 @@ export class ProjectData implements IProjectData {
 			projectDir = this.projectDir;
 		}
 
+		if (!projectDir) {
+			return null;
+		}
+
 		const configNSFilePath = path.join(projectDir, constants.CONFIG_NS_FILE_NAME);
 		let absoluteAppResourcesDirPath: string;
 
@@ -103,10 +107,13 @@ export class ProjectData implements IProjectData {
 				const appResourcesDirPath = configNS[constants.CONFIG_NS_APP_RESOURCES_ENTRY];
 
 				absoluteAppResourcesDirPath = path.resolve(projectDir, appResourcesDirPath);
+
+				return absoluteAppResourcesDirPath;
 			}
 		}
 
-		return absoluteAppResourcesDirPath || path.join(projectDir, constants.APP_FOLDER_NAME, constants.APP_RESOURCES_FOLDER_NAME);
+		// if no nsconfig is present default to app/App_Resources
+		return path.join(projectDir, constants.APP_FOLDER_NAME, constants.APP_RESOURCES_FOLDER_NAME);
 	}
 
 	private getProjectType(): string {

lib/services/app-files-updater.ts

@@ -11,8 +11,8 @@ export class AppFilesUpdater {
 	) {
 	}
 
-	public updateApp(beforeCopyAction: (sourceFiles: string[]) => void, filesToSync?: string[]): void {
-		const sourceFiles = filesToSync || this.resolveAppSourceFiles();
+	public updateApp(beforeCopyAction: (sourceFiles: string[]) => void, projectData: IProjectData, filesToSync?: string[]): void {
+		const sourceFiles = filesToSync || this.resolveAppSourceFiles(projectData);
 
 		beforeCopyAction(sourceFiles);
 		this.copyAppSourceFiles(sourceFiles);
@@ -41,15 +41,19 @@ export class AppFilesUpdater {
 		this.fs.deleteDirectory(path.join(this.appDestinationDirectoryPath, directoryItem));
 	}
 
-	protected readSourceDir(): string[] {
+	protected readSourceDir(projectData: IProjectData): string[] {
 		const tnsDir = path.join(this.appSourceDirectoryPath, constants.TNS_MODULES_FOLDER_NAME);
-		const defaultAppResourcesDir = path.join(this.appSourceDirectoryPath, constants.APP_RESOURCES_FOLDER_NAME);
-		return this.fs.enumerateFilesInDirectorySync(this.appSourceDirectoryPath, null, { includeEmptyDirectories: true }).filter(dirName => dirName !== tnsDir).filter(dirName => !dirName.startsWith(defaultAppResourcesDir));
+
+		return this.fs.enumerateFilesInDirectorySync(this.appSourceDirectoryPath, null, { includeEmptyDirectories: true }).filter(dirName => dirName !== tnsDir);
 	}
 
-	protected resolveAppSourceFiles(): string[] {
-		// Copy all files from app dir, but make sure to exclude tns_modules and App_Resources
-		let sourceFiles = this.readSourceDir();
+	protected resolveAppSourceFiles(projectData: IProjectData): string[] {
+		if (this.options.bundle) {
+			return [];
+		}
+
+		// Copy all files from app dir, but make sure to exclude tns_modules and application resources
+		let sourceFiles = this.readSourceDir(projectData);
 
 		if (this.options.release) {
 			const testsFolderPath = path.join(this.appSourceDirectoryPath, 'tests');
@@ -61,9 +65,11 @@ export class AppFilesUpdater {
 			constants.LIVESYNC_EXCLUDED_FILE_PATTERNS.forEach(pattern => sourceFiles = sourceFiles.filter(file => !minimatch(file, pattern, { nocase: true })));
 		}
 
-		if (this.options.bundle) {
-			sourceFiles = sourceFiles.filter(file => minimatch(file, "**/App_Resources/**", { nocase: true }));
-		}
+		// exclude the app_resources directory from being enumerated
+		// for copying if it is present in the application sources dir
+		const appResourcesPath = projectData.appResourcesDirectoryPath;
+		sourceFiles = sourceFiles.filter(dirName => !path.normalize(dirName).startsWith(path.normalize(appResourcesPath)));
+
 		return sourceFiles;
 	}
 

lib/services/prepare-platform-service.ts

@@ -25,6 +25,6 @@ export class PreparePlatformService {
 		const appUpdater = new AppFilesUpdater(appSourceDirectoryPath, appDestinationDirectoryPath, copyAppFilesData.appFilesUpdaterOptions, this.$fs);
 		appUpdater.updateApp(sourceFiles => {
 			this.$xmlValidator.validateXmlFiles(sourceFiles);
-		}, copyAppFilesData.filesToSync);
+		}, copyAppFilesData.projectData, copyAppFilesData.filesToSync);
 	}
 }

test/app-files-updates.ts

@@ -1,8 +1,17 @@
 import { assert } from "chai";
 import { AppFilesUpdater } from "../lib/services/app-files-updater";
+import * as yok from "../lib/common/yok";
 
 require("should");
 
+function createTestInjector(): IInjector {
+	const testInjector = new yok.Yok();
+
+	testInjector.register("projectData", { appResourcesDirectoryPath: "App_Resources"});
+
+	return testInjector;
+}
+
 describe("App files cleanup", () => {
 	class CleanUpAppFilesUpdater extends AppFilesUpdater {
 		public deletedDestinationItems: string[] = [];
@@ -54,23 +63,25 @@ describe("App files copy", () => {
 		}
 
 		public copy(): void {
-			this.copiedDestinationItems = this.resolveAppSourceFiles();
+			const injector = createTestInjector();
+			const projectData = <IProjectData>injector.resolve("projectData");
+			this.copiedDestinationItems = this.resolveAppSourceFiles(projectData);
 		}
 	}
 
-	it("copies all app files when not bundling", () => {
+	it("copies all app files but app_resources when not bundling", () => {
 		const updater = new CopyAppFilesUpdater([
 			"file1", "dir1/file2", "App_Resources/Android/blah.png"
 		], { bundle: false });
 		updater.copy();
-		assert.deepEqual(["file1", "dir1/file2", "App_Resources/Android/blah.png"], updater.copiedDestinationItems);
+		assert.deepEqual(["file1", "dir1/file2"], updater.copiedDestinationItems);
 	});
 
-	it("skips copying non-App_Resource files when bundling", () => {
+	it("skips copying files when bundling", () => {
 		const updater = new CopyAppFilesUpdater([
 			"file1", "dir1/file2", "App_Resources/Android/blah.png"
 		], { bundle: true });
 		updater.copy();
-		assert.deepEqual(["App_Resources/Android/blah.png"], updater.copiedDestinationItems);
+		assert.deepEqual([], updater.copiedDestinationItems);
 	});
 });

test/ios-entitlements-service.ts

@@ -47,7 +47,7 @@ describe("IOSEntitlements Service Tests", () => {
 		injector = createTestInjector();
 
 		platformsData = injector.resolve("platformsData");
-		projectData = injector.resolve("projectData");
+		projectData = $injector.resolve<IProjectData>("projectData");
 		projectData.projectName = 'testApp';
 
 		projectData.platformsDir = temp.mkdirSync("platformsDir");

test/stubs.ts

@@ -4,7 +4,6 @@ import * as util from "util";
 import * as chai from "chai";
 import { EventEmitter } from "events";
 
-import * as fs from "fs";
 import * as path from "path";
 import * as constants from "./../lib/constants";
 
@@ -267,20 +266,8 @@ export class ProjectDataStub implements IProjectData {
 			projectDir = this.projectDir;
 		}
 
-		const configNSFilePath = path.join(projectDir, constants.CONFIG_NS_FILE_NAME);
-		let absoluteAppResourcesDirPath: string;
-
-		if (fs.existsSync(configNSFilePath)) {
-			const configNS = JSON.parse(fs.readFileSync(configNSFilePath).toString());
-
-			if (configNS && configNS[constants.CONFIG_NS_APP_RESOURCES_ENTRY]) {
-				const appResourcesDirPath = configNS[constants.CONFIG_NS_APP_RESOURCES_ENTRY];
-
-				absoluteAppResourcesDirPath = path.resolve(projectDir, appResourcesDirPath);
-			}
-		}
-
-		return absoluteAppResourcesDirPath || path.join(projectDir, constants.APP_FOLDER_NAME, constants.APP_RESOURCES_FOLDER_NAME);
+		// always return app/App_Resources
+		return path.join(projectDir, constants.APP_FOLDER_NAME, constants.APP_RESOURCES_FOLDER_NAME);
 	}
 }