Merge pull request #142 from NativeScript/vladimirov/commands-and-parameters

rosen-vladimirov · rosen-vladimirov · commit 74f1be7d8026 · 2014-11-07T12:10:40.000+02:00
Add validation for command parameters
diff --git a/lib/bootstrap.ts b/lib/bootstrap.ts
@@ -18,6 +18,7 @@ $injector.require("analyticsSettingsService", "./services/analytics-settings-ser
 
 $injector.require("emulatorSettingsService", "./services/emulator-settings-service");
 
+$injector.require("platformCommandParameter", "./platform-command-param");
 $injector.requireCommand("create", "./commands/create-project");
 $injector.requireCommand("platform|*list", "./commands/list-platforms");
 $injector.requireCommand("platform|add", "./commands/add-platform");
diff --git a/lib/commands/add-platform.ts b/lib/commands/add-platform.ts
@@ -1,12 +1,28 @@
 ///<reference path="../.d.ts"/>
+"use strict";
 
 export class AddPlatformCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $errors: IErrors) { }
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
 			this.$platformService.addPlatforms(args).wait();
 		}).future<void>()();
 	}
+
+	allowedParameters: ICommandParameter[] = [];
+
+	canExecute(args: string[]): IFuture<boolean> {
+		return (() => {
+			if(!args || args.length === 0) {
+				this.$errors.fail("No platform specified. Please specify a platform to add");
+			}
+
+			_.each(args, arg => this.$platformService.validatePlatform(arg));
+
+			return true;
+		}).future<boolean>()();
+	}
 }
 $injector.registerCommand("platform|add", AddPlatformCommand);
diff --git a/lib/commands/build.ts b/lib/commands/build.ts
@@ -1,12 +1,16 @@
 ///<reference path="../.d.ts"/>
+"use strict";
 
 export class BuildCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $platformCommandParameter: ICommandParameter) { }
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
 			this.$platformService.buildPlatform(args[0]).wait();
 		}).future<void>()();
 	}
+
+	allowedParameters = [this.$platformCommandParameter];
 }
 $injector.registerCommand("build", BuildCommand);
diff --git a/lib/commands/create-project.ts b/lib/commands/create-project.ts
@@ -1,7 +1,26 @@
 ///<reference path="../.d.ts"/>
+"use strict";
+
+export class ProjectCommandParameter implements ICommandParameter {
+	constructor(private $errors: IErrors,
+		private $projectNameValidator: IProjectNameValidator) { }
+
+	mandatory = true;
+	validate(value: string): IFuture<boolean> {
+		return (() => {
+			if(!value) {
+				this.$errors.fail("You must specify <App name> when creating a new project.");
+			}
+
+			return this.$projectNameValidator.validate(value);
+		}).future<boolean>()();
+	}
+}
 
 export class CreateProjectCommand implements ICommand {
-	constructor(private $projectService: IProjectService) { }
+	constructor(private $projectService: IProjectService,
+		private $errors: IErrors,
+		private $projectNameValidator: IProjectNameValidator) { }
 
 	public enableHooks = false;
 
@@ -10,5 +29,7 @@ export class CreateProjectCommand implements ICommand {
 			this.$projectService.createProject(args[0]).wait();
 		}).future<void>()();
 	}
+
+	allowedParameters = [new ProjectCommandParameter(this.$errors, this.$projectNameValidator) ]
 }
 $injector.registerCommand("create", CreateProjectCommand);
diff --git a/lib/commands/deploy.ts b/lib/commands/deploy.ts
@@ -1,10 +1,14 @@
 ///<reference path="../.d.ts"/>
+"use strict";
 
 export class DeployOnDeviceCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $platformCommandParameter: ICommandParameter) { }
 
 	execute(args: string[]): IFuture<void> {
 		return this.$platformService.deployOnDevice(args[0]);
 	}
+
+	allowedParameters = [this.$platformCommandParameter];
 }
-$injector.registerCommand("deploy", DeployOnDeviceCommand);
+$injector.registerCommand("deploy", DeployOnDeviceCommand);
diff --git a/lib/commands/emulate.ts b/lib/commands/emulate.ts
@@ -1,8 +1,11 @@
 ///<reference path="../.d.ts"/>
 
 export class EmulateCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $platformCommandParameter: ICommandParameter) { }
 
-	execute(args: string[]): IFuture<void> { return this.$platformService.deployOnEmulator(args[0]);}
+	execute(args: string[]): IFuture<void> { return this.$platformService.deployOnEmulator(args[0]); }
+
+	allowedParameters = [this.$platformCommandParameter];
 }
-$injector.registerCommand("emulate", EmulateCommand);
+$injector.registerCommand("emulate", EmulateCommand);
diff --git a/lib/commands/list-devices.ts b/lib/commands/list-devices.ts
@@ -4,7 +4,8 @@ import util = require("util")
 
 export class ListDevicesCommand implements ICommand {
 	constructor(private $devicesServices: Mobile.IDevicesServices,
-				private $logger: ILogger) { }
+		private $logger: ILogger,
+		private $stringParameter: ICommandParameter) { }
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
@@ -17,5 +18,7 @@ export class ListDevicesCommand implements ICommand {
 			this.$devicesServices.execute(action, undefined, {allowNoDevices: true}).wait();
 		}).future<void>()();
 	}
+
+	allowedParameters = [this.$stringParameter];
 }
 $injector.registerCommand("list-devices", ListDevicesCommand);
diff --git a/lib/commands/list-platforms.ts b/lib/commands/list-platforms.ts
@@ -24,5 +24,7 @@ export class ListPlatformsCommand implements ICommand {
 			}
 		}).future<void>()();
 	}
+
+	allowedParameters: ICommandParameter[] = [];
 }
 $injector.registerCommand("platform|*list", ListPlatformsCommand);
diff --git a/lib/commands/post-install.ts b/lib/commands/post-install.ts
@@ -21,5 +21,7 @@ export class PostInstallCommand implements ICommand {
 			this.$autoCompletionService.enableAutoCompletion().wait();
 		}).future<void>()();
 	}
+
+	public allowedParameters: ICommandParameter[] = [];
 }
 $injector.registerCommand("dev-post-install", PostInstallCommand);
diff --git a/lib/commands/prepare.ts b/lib/commands/prepare.ts
@@ -1,12 +1,15 @@
 ///<reference path="../.d.ts"/>
 
 export class PrepareCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $platformCommandParameter: ICommandParameter) { }
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
 			this.$platformService.preparePlatform(args[0]).wait();
 		}).future<void>()();
 	}
+
+	allowedParameters = [this.$platformCommandParameter];
 }
 $injector.registerCommand("prepare", PrepareCommand);
diff --git a/lib/commands/remove-platform.ts b/lib/commands/remove-platform.ts
@@ -1,12 +1,28 @@
 ///<reference path="../.d.ts"/>
+"use strict";
 
 export class RemovePlatformCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $errors: IErrors) { }
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
 			this.$platformService.removePlatforms(args).wait();
 		}).future<void>()();
 	}
+
+	canExecute(args: string[]): IFuture<boolean> {
+		return (() => {
+			if(!args || args.length === 0) {
+				this.$errors.fail("No platform specified. Please specify a platform to remove");
+			}
+
+			_.each(args, arg => this.$platformService.validatePlatformInstalled(arg));
+
+			return true;
+		}).future<boolean>()();
+	}
+
+	allowedParameters: ICommandParameter[] = [];
 }
 $injector.registerCommand("platform|remove", RemovePlatformCommand);
diff --git a/lib/commands/run.ts b/lib/commands/run.ts
@@ -1,12 +1,16 @@
 ///<reference path="../.d.ts"/>
+"use strict";
 
 export class RunCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $platformCommandParameter: ICommandParameter) { }
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
 			this.$platformService.runPlatform(args[0]).wait();
 		}).future<void>()();
 	}
+
+	allowedParameters = [this.$platformCommandParameter];
 }
 $injector.registerCommand("run", RunCommand);
diff --git a/lib/commands/update-platform.ts b/lib/commands/update-platform.ts
@@ -1,12 +1,28 @@
 ///<reference path="../.d.ts"/>
+"use strict";
 
 export class UpdatePlatformCommand implements ICommand {
-	constructor(private $platformService: IPlatformService) { }
+	constructor(private $platformService: IPlatformService,
+		private $errors:IErrors) { }
 
 	execute(args: string[]): IFuture<void> {
 		return (() => {
 			this.$platformService.updatePlatforms(args).wait();
 		}).future<void>()();
 	}
+
+	canExecute(args: string[]): IFuture<boolean> {
+		return (() => {
+			if(!args || args.length === 0) {
+				this.$errors.fail("No platform specified. Please specify platforms to update.");
+			}
+
+			_.each(args, arg => this.$platformService.validatePlatformInstalled(arg));
+
+			return true;
+		}).future<boolean>()();
+	}
+
+	allowedParameters: ICommandParameter[] = [];
 }
 $injector.registerCommand("platform|update", UpdatePlatformCommand);
diff --git a/lib/common b/lib/common
@@ -1 +1 @@
-Subproject commit 8426225275bc36770ea536008230a62059be3219
+Subproject commit 885bdcd12afaf3bfa82a5633c704a1c77634fb6a
diff --git a/lib/definitions/platform.d.ts b/lib/definitions/platform.d.ts
@@ -10,6 +10,8 @@ interface IPlatformService {
 	buildPlatform(platform: string): IFuture<void>;
 	deployOnDevice(platform: string): IFuture<void>;
 	deployOnEmulator(platform: string): IFuture<void>;
+	validatePlatformInstalled(platform: string): void;
+	validatePlatform(platform: string): void;
 }
 
 interface IPlatformData {
diff --git a/lib/platform-command-param.ts b/lib/platform-command-param.ts
@@ -0,0 +1,14 @@
+///<reference path=".d.ts"/>
+"use strict";
+
+export class PlatformCommandParameter implements ICommandParameter {
+	constructor(private $platformService: IPlatformService) { }
+	mandatory = true;
+	validate(value: string): IFuture<boolean> {
+		return (() => {
+			this.$platformService.validatePlatformInstalled(value);
+			return true;
+		}).future<boolean>()();
+	}
+}
+$injector.register("platformCommandParameter", PlatformCommandParameter);
diff --git a/lib/services/platform-service.ts b/lib/services/platform-service.ts
@@ -21,10 +21,6 @@ export class PlatformService implements IPlatformService {
 
 	public addPlatforms(platforms: string[]): IFuture<void> {
 		return (() => {
-			if(!platforms || platforms.length === 0) {
-				this.$errors.fail("No platform specified. Please specify a platform to add");
-			}
-
 			var platformsDir = this.$projectData.platformsDir;
 			this.$fs.ensureDirectoryExists(platformsDir).wait();
 
@@ -136,7 +132,6 @@ export class PlatformService implements IPlatformService {
 
 	public preparePlatform(platform: string): IFuture<void> {
 		return (() => {
-			this.validatePlatformInstalled(platform);
 			platform = platform.toLowerCase();
 
 			var platformData = this.$platformsData.getPlatformData(platform);
@@ -166,7 +161,6 @@ export class PlatformService implements IPlatformService {
 
 	public buildPlatform(platform: string): IFuture<void> {
 		return (() => {
-			this.validatePlatformInstalled(platform);
 			platform = platform.toLowerCase();
 
 			var platformData = this.$platformsData.getPlatformData(platform);
@@ -177,7 +171,6 @@ export class PlatformService implements IPlatformService {
 
 	public runPlatform(platform: string): IFuture<void> {
 		return (() => {
-			this.validatePlatformInstalled(platform);
 			platform = platform.toLowerCase();
 
 			this.preparePlatform(platform).wait();
@@ -191,10 +184,6 @@ export class PlatformService implements IPlatformService {
 
 	public removePlatforms(platforms: string[]): IFuture<void> {
 		return (() => {
-			if(!platforms || platforms.length === 0) {
-				this.$errors.fail("No platform specified. Please specify a platform to remove");
-			}
-
 			_.each(platforms, platform => {
 				this.validatePlatformInstalled(platform);
 
@@ -207,10 +196,6 @@ export class PlatformService implements IPlatformService {
 
 	public updatePlatforms(platforms: string[]): IFuture<void> {
 		return (() => {
-			if(!platforms || platforms.length === 0) {
-				this.$errors.fail("No platform specified. Please specify a platform to remove");
-			}
-
 			_.each(platforms, platform => {
 				var parts = platform.split("@");
 				platform = parts[0].toLowerCase();
@@ -224,7 +209,6 @@ export class PlatformService implements IPlatformService {
 
 	public deployOnDevice(platform: string): IFuture<void> {
 		return (() => {
-			this.validatePlatformInstalled(platform);
 			platform = platform.toLowerCase();
 
 			var platformData = this.$platformsData.getPlatformData(platform);
@@ -267,7 +251,7 @@ export class PlatformService implements IPlatformService {
 		}).future<void>()();
 	}
 
-	private validatePlatform(platform: string): void {
+	public validatePlatform(platform: string): void {
 		if(!platform) {
 			this.$errors.fail("No platform specified.")
 		}
@@ -283,7 +267,7 @@ export class PlatformService implements IPlatformService {
 		}
 	}
 
-	private validatePlatformInstalled(platform: string): void {
+	public validatePlatformInstalled(platform: string): void {
 		this.validatePlatform(platform);
 
 		if (!this.isPlatformInstalled(platform).wait()) {
diff --git a/test/platform-commands.ts b/test/platform-commands.ts
diff --git a/test/platform-service.ts b/test/platform-service.ts
diff --git a/test/stubs.ts b/test/stubs.ts

Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,7 @@ export class ListPlatformsCommand implements ICommand {`
`24`	`24`	`}`
`25`	`25`	`}).future<void>()();`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+ allowedParameters: ICommandParameter[] = [];`
`27`	`29`	`}`
`28`	`30`	`$injector.registerCommand("platform\|*list", ListPlatformsCommand);`
Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,7 @@ export class PostInstallCommand implements ICommand {`
`21`	`21`	`this.$autoCompletionService.enableAutoCompletion().wait();`
`22`	`22`	`}).future<void>()();`
`23`	`23`	`}`
	`24`	`+`
	`25`	`+ public allowedParameters: ICommandParameter[] = [];`
`24`	`26`	`}`
`25`	`27`	`$injector.registerCommand("dev-post-install", PostInstallCommand);`