refactor: pass object instead of boolean to verifyXcproj method

Author: rosen-vladimirov

lib/declarations.d.ts

@@ -773,17 +773,27 @@ interface IProjectNameService {
 	ensureValidName(projectName: string, validateOptions?: { force: boolean }): Promise<string>;
 }
 
+/**
+ * Describes options that can be passed to xcprojService.verifyXcproj method.
+ */
+interface IVerifyXcprojOptions {
+	/**
+	 * Whether to fail with error message or not
+	 */
+	shouldFail: boolean;
+}
+
 /**
  * Designed for getting information about xcproj.
  */
 interface IXcprojService {
 	/**
 	 * Checks whether the system needs xcproj to execute ios builds successfully.
 	 * In case the system does need xcproj but does not have it, prints an error message.
-	 * @param {boolean} whether to fail with error message or not
+	 * @param {IVerifyXcprojOptions} opts whether to fail with error message or not
 	 * @return {Promise<boolean>} whether an error occurred or not.
 	 */
-	verifyXcproj(shouldFail: boolean): Promise<boolean>;
+	verifyXcproj(opts: IVerifyXcprojOptions): Promise<boolean>;
 	/**
 	 * Collects information about xcproj.
 	 * @return {Promise<XcprojInfo>} collected info about xcproj.
@@ -903,4 +913,4 @@ interface IRuntimeGradleVersions {
 
 interface INetworkConnectivityValidator {
 	validate(): Promise<void>;
-}
+}

lib/services/cocoapods-service.ts

@@ -34,7 +34,7 @@ export class CocoaPodsService implements ICocoaPodsService {
 			this.$errors.failWithoutHelp("CocoaPods or ruby gem 'xcodeproj' is not installed. Run `sudo gem install cocoapods` and try again.");
 		}
 
-		await this.$xcprojService.verifyXcproj(true);
+		await this.$xcprojService.verifyXcproj({ shouldFail: true });
 
 		this.$logger.info("Installing pods...");
 		const podTool = this.$config.USE_POD_SANDBOX ? "sandbox-pod" : "pod";

lib/services/xcproj-service.ts

@@ -12,11 +12,11 @@ class XcprojService implements IXcprojService {
 		private $xcodeSelectService: IXcodeSelectService) {
 	}
 
-	public async verifyXcproj(shouldFail: boolean): Promise<boolean> {
+	public async verifyXcproj(opts: IVerifyXcprojOptions): Promise<boolean> {
 		const xcprojInfo = await this.getXcprojInfo();
 		if (xcprojInfo.shouldUseXcproj && !xcprojInfo.xcprojAvailable) {
 			const errorMessage = `You are using CocoaPods version ${xcprojInfo.cocoapodVer} which does not support Xcode ${xcprojInfo.xcodeVersion.major}.${xcprojInfo.xcodeVersion.minor} yet.${EOL}${EOL}You can update your cocoapods by running $sudo gem install cocoapods from a terminal.${EOL}${EOL}In order for the NativeScript CLI to be able to work correctly with this setup you need to install xcproj command line tool and add it to your PATH. Xcproj can be installed with homebrew by running $ brew install xcproj from the terminal`;
-			if (shouldFail) {
+			if (opts.shouldFail) {
 				this.$errors.failWithoutHelp(errorMessage);
 			} else {
 				this.$logger.warn(errorMessage);

test/cocoapods-service.ts

@@ -697,7 +697,7 @@ end`
 			});
 
 			const xcprojService = testInjector.resolve<IXcprojService>("xcprojService");
-			xcprojService.verifyXcproj = async (shouldFail: boolean): Promise<boolean> => false;
+			xcprojService.verifyXcproj = async (opts: IVerifyXcprojOptions): Promise<boolean> => false;
 			xcprojService.getXcprojInfo = async (): Promise<IXcprojInfo> => (<any>{});
 		});
 
@@ -729,7 +729,7 @@ end`
 		it("fails with correct error when xcprojService.verifyXcproj throws", async () => {
 			const expectedError = new Error("err");
 			const xcprojService = testInjector.resolve<IXcprojService>("xcprojService");
-			xcprojService.verifyXcproj = async (shouldFail: boolean): Promise<boolean> => {
+			xcprojService.verifyXcproj = async (opts: IVerifyXcprojOptions): Promise<boolean> => {
 				throw expectedError;
 			};
 
@@ -756,6 +756,18 @@ end`
 			});
 		});
 
+		it("calls xcprojService.verifyXcproj with correct arguments", async () => {
+			const xcprojService = testInjector.resolve<IXcprojService>("xcprojService");
+			let optsPassedToVerifyXcproj: any = null;
+			xcprojService.verifyXcproj = async (opts: IVerifyXcprojOptions): Promise<boolean> => {
+				optsPassedToVerifyXcproj = opts;
+				return false;
+			};
+
+			await cocoapodsService.executePodInstall(projectRoot, xcodeProjPath);
+			assert.deepEqual(optsPassedToVerifyXcproj, { shouldFail: true });
+		});
+
 		it("calls pod install spawnFromEvent with correct arguments", async () => {
 			const childProcess = testInjector.resolve<IChildProcess>("childProcess");
 			let commandCalled = "";