Merge pull request #1839 from NativeScript/clean-command

Clean command

Author: enchev

docs/man_pages/project/configuration/platform-clean.md

@@ -0,0 +1,32 @@
+platform clean
+==========
+
+Usage | Synopsis
+------|-------
+<% if((isConsole && isMacOS) || isHtml) { %>General | `$ tns platform clean <Platform>`<% } %>
+<% if(isConsole && (isLinux || isWindows)) { %>General | `$ tns platform clean android`<% } %>
+
+Removes and adds the selected platform to the project currently targets. <% if(isMacOS) { %>You must specify the target platform that you want to remove.<% } %>
+
+<% if(isMacOS) { %>### Attributes
+`<Platform>` is the target mobile platform that you want to clean in your project. You can set the following target platforms.
+* `android` - Removes configuration changes for Android development.
+* `ios` - Removes configuration changes for iOS development.<% } %>
+
+<% if(isHtml) { %>
+### Command Limitations
+
+* You can run `$ tns platform clean ios` only on OS X systems.
+* Clean command will not preserve your current installed platform version but will download and install latest platform version. If you are using clean with custom version of the runtime, specify the version in the command tns clean ios@2.1.0 or tns clean ios --frameworkPath <path-to-tgz>
+
+### Related Commands
+
+Command | Description
+----------|----------
+[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
+[platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
+[platform add](platform-add.html) | Configures the current project to target the selected platform.
+[platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform.
+[platform](platform.html) | Lists all platforms that the project currently targets.
+[prepare](prepare.html) | Copies common and relevant platform-specific content from the app directory to the subdirectory for the selected target platform in the platforms directory.
+<% } %>

lib/bootstrap.ts

@@ -97,6 +97,8 @@ $injector.requireCommand("info", "./commands/info");
 
 $injector.require("androidToolsInfo", "./android-tools-info");
 
+$injector.requireCommand("platform|clean", "./commands/platform-clean");
+
 $injector.requireCommand("livesync", "./commands/livesync");
 $injector.require("usbLiveSyncService", "./services/livesync/livesync-service"); // The name is used in https://github.com/NativeScript/nativescript-dev-typescript
 $injector.require("iosLiveSyncServiceLocator", "./services/livesync/ios-livesync-service");

lib/commands/platform-clean.ts

@@ -0,0 +1,26 @@
+export class CleanCommand implements ICommand {
+	constructor(private $platformService: IPlatformService,
+		private $errors: IErrors) { }
+
+	public execute(args: string[]): IFuture<void> {
+		return (() => {
+			this.$platformService.removePlatforms(args).wait();
+			this.$platformService.addPlatforms(args).wait();
+		}).future<void>()();
+	}
+
+	public canExecute(args: string[]): IFuture<boolean> {
+		return (() => {
+			if(!args || args.length === 0) {
+				this.$errors.fail("No platform specified. Please specify a platform to clean");
+			}
+
+			_.each(args, arg => this.$platformService.validatePlatform(arg));
+
+			return true;
+		}).future<boolean>()();
+	}
+
+	allowedParameters: ICommandParameter[] = [];
+}
+$injector.registerCommand("platform|clean", CleanCommand);

test/platform-commands.ts

@@ -19,6 +19,7 @@ import {MobilePlatformsCapabilities} from "../lib/mobile-platforms-capabilities"
 import {DevicePlatformsConstants} from "../lib/common/mobile/device-platforms-constants";
 import { XmlValidator } from "../lib/xml-validator";
 import * as ChildProcessLib from "../lib/common/child-process";
+import {CleanCommand} from "../lib/commands/platform-clean";
 
 let isCommandExecuted = true;
 
@@ -309,6 +310,143 @@ describe('Platform Service Tests', () => {
 			});
 		});
 
+		describe("#CleanPlatformCommand", () => {
+			it("is not executed when platform is not passed", () => {
+				isCommandExecuted = false;
+				commandsService.executeCommandUnchecked = (commandName: string): IFuture<boolean> => {
+					return (() => {
+						if (commandName !== "help") {
+							isCommandExecuted = true;
+						}
+						return false;
+					}).future<boolean>()();
+				};
+
+				commandsService.tryExecuteCommand("platform|clean", []).wait();
+				assert.isFalse(isCommandExecuted);
+			});
+
+			it("is not executed when platform is not valid", () => {
+				isCommandExecuted = false;
+				commandsService.executeCommandUnchecked = (commandName: string): IFuture<boolean> => {
+					return (() => {
+						if (commandName !== "help") {
+							isCommandExecuted = true;
+						}
+						return false;
+					}).future<boolean>()();
+				};
+
+				commandsService.tryExecuteCommand("platform|clean", ["invalidPlatform"]).wait();
+				assert.isFalse(isCommandExecuted);
+			});
+
+			it("is executed when platform is valid", () => {
+				isCommandExecuted = false;
+				commandsService.executeCommandUnchecked = (commandName: string): IFuture<boolean> => {
+					return (() => {
+						if (commandName !== "help") {
+							isCommandExecuted = true;
+						}
+						return false;
+					}).future<boolean>()();
+				};
+
+				commandsService.tryExecuteCommand("platform|add", ["android"]).wait();
+				commandsService.tryExecuteCommand("platform|clean", ["android"]).wait();
+				assert.isTrue(isCommandExecuted);
+			});
+
+			it("is not executed when platform is not added", () => {
+				isCommandExecuted = false;
+				commandsService.executeCommandUnchecked = (commandName: string): IFuture<boolean> => {
+					return (() => {
+						if (commandName !== "help") {
+							isCommandExecuted = true;
+						}
+						return false;
+					}).future<boolean>()();
+				};
+
+				commandsService.tryExecuteCommand("platform|clean", ["android"]).wait();
+				assert.isFalse(isCommandExecuted);
+			});
+
+			it("is executed when all platforms are valid", () => {
+				isCommandExecuted = false;
+				commandsService.executeCommandUnchecked = (commandName: string): IFuture<boolean> => {
+					return (() => {
+						if (commandName !== "help") {
+							isCommandExecuted = true;
+						}
+						return false;
+					}).future<boolean>()();
+				};
+
+				commandsService.tryExecuteCommand("platform|add", ["android"]).wait();
+				commandsService.tryExecuteCommand("platform|add", ["ios"]).wait();
+				commandsService.tryExecuteCommand("platform|clean", ["android", "ios"]).wait();
+				assert.isTrue(isCommandExecuted);
+			});
+
+			it("is not executed when at least on platform is not added", () => {
+				isCommandExecuted = false;
+				commandsService.executeCommandUnchecked = (commandName: string): IFuture<boolean> => {
+					return (() => {
+						if (commandName !== "help") {
+							isCommandExecuted = true;
+						}
+						return false;
+					}).future<boolean>()();
+				};
+
+				commandsService.tryExecuteCommand("platform|clean", ["android", "ios"]).wait();
+				assert.isFalse(isCommandExecuted);
+			});
+
+			it("is not executed when at least one platform is not valid", () => {
+				isCommandExecuted = false;
+				commandsService.executeCommandUnchecked = (commandName: string): IFuture<boolean> => {
+					return (() => {
+						if (commandName !== "help") {
+							isCommandExecuted = true;
+						}
+						return false;
+					}).future<boolean>()();
+				};
+
+				commandsService.tryExecuteCommand("platform|clean", ["ios", "invalid"]).wait();
+				assert.isFalse(isCommandExecuted);
+			});
+
+			it("will call removePlatform and addPlatform on the platformService passing the provided platforms", () => {
+				let platformActions: { action: string, platforms: string[] }[] = [];
+				testInjector.registerCommand("platform|clean", CleanCommand);
+				let cleanCommand = testInjector.resolveCommand("platform|clean");
+
+				platformService.removePlatforms = (platforms: string[]) => {
+					return (() => {
+						platformActions.push({ action: "removePlatforms", platforms });
+					}).future<void>()();
+				};
+
+				platformService.addPlatforms = (platforms: string[]) => {
+					return (() => {
+						platformActions.push({ action: "addPlatforms", platforms });
+					}).future<void>()();
+				};
+
+				cleanCommand.execute(["ios"]).wait();
+
+				let expectedPlatformActions = [
+					{ action: "removePlatforms", platforms: ["ios"] },
+					{ action: "addPlatforms", platforms: ["ios"] },
+				];
+
+				assert.deepEqual(platformActions, expectedPlatformActions, "Expected `remove ios`, `add ios` calls to the platformService.");
+			});
+		});
+
 		describe("#UpdatePlatformCommand", () => {
 			it("is not executed when platform is not passed", () => {
 				isCommandExecuted = false;