Plugin variables

Author: Fatme Havaluova

bootstrap.ts

@@ -27,6 +27,7 @@ $injector.require("httpClient", "./http-client");
 $injector.require("childProcess", "./child-process");
 $injector.require("prompter", "./prompter");
 $injector.require("projectHelper", "./project-helper");
+$injector.require("pluginVariablesHelper", "./plugin-variables-helper");
 $injector.require("propertiesParser", "./properties-parser");
 
 $injector.requireCommand(["help", "/?"], "./commands/help");

declarations.d.ts

@@ -386,6 +386,7 @@ interface ICommonOptions {
 	force: boolean;
 	companion: boolean;
 	emulator: boolean;
+	var: Object;
 }
 
 interface IYargArgv extends IDictionary<any> {
@@ -507,3 +508,8 @@ interface IResourceLoader {
 	 */
 	getPathToAppResources(framework: string): string;
 }
+
+interface IPluginVariablesHelper {
+	getPluginVariableFromVarOption(variableName: string, configuration?: string): any;
+	simplifyYargsObject(obj: any, configuration?: string): any;
+}

definitions/node-fibers.d.ts

@@ -76,6 +76,7 @@ declare module "fibers/future" {
 		static settle(...future_list: IFuture<any>[]): void;
 
 		static fromResult<T>(value: T): IFuture<T>;
+		static fromResult<T>(value: any): IFuture<T>;
 		static fromResult(): IFuture<void>;
 
 		static assertNoFutureLeftBehind(): void;

options.ts

@@ -66,7 +66,8 @@ export class OptionsBase {
 			"file": { type: OptionType.String },
 			"force": { type: OptionType.Boolean, alias: "f" },
 			"companion": { type: OptionType.Boolean },
-			"emulator": { type: OptionType.Boolean }
+			"emulator": { type: OptionType.Boolean },
+			var: {type: OptionType.Object},
 		};
 	}
 

plugin-variables-helper.ts

@@ -0,0 +1,93 @@
+///<reference path=".d.ts"/>
+"use strict";
+
+export class PluginVariablesHelper implements IPluginVariablesHelper {
+	constructor(private $options: ICommonOptions) { }
+
+	/**
+	 * Checks if the specified pluginVariable exists in the --var option specified by user.
+	 * The variable can be added to --var option for configuration or globally, for ex.:
+	 * `--var.APP_ID myAppIdentifier` or `--var.debug.APP_ID myAppIdentifier`.
+	 * NOTE: If the variable is added for specific configuration and globally,
+	 * the value for the specified configuration will be used as it has higher priority. For ex.:
+	 * `--var.APP_ID myAppIdentifier1 --var.debug.APP_ID myAppIdentifier2` will return myAppIdentifier2 for debug configuration
+	 * and myAppIdentifier for release configuration.
+	 * @param {string} variableName The name of the plugin variable.
+	 * @param {string} configuration The configuration for which the variable will be used.
+	 * @returns {any} The value of the plugin variable specified in --var or undefined.
+	 */
+	public getPluginVariableFromVarOption(variableName: string, configuration?: string): any {
+		let varOption = this.$options.var;
+		configuration = configuration ? configuration.toLowerCase() : undefined;
+		let lowerCasedVariableName = variableName.toLowerCase();
+		if(varOption) {
+			let configVariableValue: string;
+			let generalVariableValue: string;
+			 if(variableName.indexOf(".") !== -1) {
+				varOption = this.simplifyYargsObject(varOption, configuration);
+			 }
+			_.each(varOption, (propValue: any, propKey: string) => {
+				if(propKey.toLowerCase() === configuration) {
+					_.each(propValue, (configPropValue: string, configPropKey: string) => {
+						if(configPropKey.toLowerCase() === lowerCasedVariableName) {
+							configVariableValue = configPropValue;
+							return false;
+						}
+					});
+				} else if(propKey.toLowerCase() === lowerCasedVariableName) {
+					generalVariableValue = propValue;
+				}
+			});
+
+			let value = configVariableValue || generalVariableValue;
+			if(value) {
+				let obj = Object.create(null);
+				obj[variableName] = value.toString();
+				return obj;
+			}
+		}
+
+		return undefined;
+	}
+
+	/**
+	 * Converts complicated yargs object with many subobjects, to simplified one.
+	 * Use it when the plugin variable contains dots ("."). In this case yargs treats them as inner object instead of propery name.
+	 * For ex. '--var.debug.DATA.APP.ID testId' will be converted to {debug: {DATA: {APP: {ID: testId}}}}, while we need {debug: {DATA.APP.ID: testId}}
+	 * '--var.DATA.APP.ID testId' will be converted to DATA: {APP: {ID: testId}}}, while we need {DATA.APP.ID: testId}
+	 * @param {any} obj varObject created by yargs
+	 * @param {string} configuration The configuration for which the plugin variable will be used.
+	 * @return {any} Converted object if the obj paramater is of type object, otherwise - the object itself.
+	 */
+	public simplifyYargsObject(obj: any, configuration?: string): any {
+		if(obj && typeof(obj) === "object") {
+			let convertedObject:any = Object.create({});
+
+			_.each(obj, (propValue: any, propKey: string) => {
+				if(typeof(propValue) !== "object") {
+					convertedObject[propKey] = propValue;
+					return false;
+				}
+
+				configuration = configuration ? configuration.toLowerCase() : undefined;
+				let innerObj = this.simplifyYargsObject(propValue, configuration);
+
+				if(propKey.toLowerCase() === configuration) {
+					// for --var.debug.DATA.APP.ID testId
+					convertedObject[propKey] = innerObj;
+				} else {
+					// for --var.DATA.APP.ID testId
+					_.each(innerObj, (innerPropValue: any, innerPropKey: string) => {
+						convertedObject[`${propKey}.${innerPropKey}`] = innerPropValue;
+					});
+				}
+
+			});
+
+			return convertedObject;
+		}
+
+		return obj;
+	}
+}
+$injector.register("pluginVariablesHelper", PluginVariablesHelper);