Updated installer to use --destination option instead of an argument.

Author: AlexSkrypnyk

.vortex/installer/src/Command/InstallCommand.php

@@ -17,7 +17,6 @@
 use DrevOps\VortexInstaller\Utils\Strings;
 use DrevOps\VortexInstaller\Utils\Tui;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -31,7 +30,7 @@
  */
 class InstallCommand extends Command {
 
-  const ARG_DESTINATION = 'destination';
+  const OPTION_DESTINATION = 'destination';
 
   const OPTION_ROOT = 'root';
 
@@ -87,23 +86,22 @@ protected function configure(): void {
     $this->setDescription('Install Vortex from remote or local repository.');
     $this->setHelp(<<<EOF
   Interactively install Vortex from the latest stable release into the current directory:
-  php installer destination
+  php installer --destination=.
 
   Non-interactively install Vortex from the latest stable release into the specified directory:
-  php installer --no-interaction destination
+  php installer --no-interaction --destination=path/to/destination
 
   Install Vortex from the stable branch into the specified directory:
-  php installer --uri=https://github.com/drevops/vortex.git@stable destination
+  php installer --uri=https://github.com/drevops/vortex.git@stable --destination=path/to/destination
 
   Install Vortex from a specific release into the specified directory:
-  php installer --uri=https://github.com/drevops/[email protected] destination
+  php installer --uri=https://github.com/drevops/[email protected] --destination=path/to/destination
 
   Install Vortex from a specific commit into the specified directory:
-  php installer --uri=https://github.com/drevops/vortex.git@abcd123 destination
+  php installer --uri=https://github.com/drevops/vortex.git@abcd123 --destination=path/to/destination
 EOF
     );
-    $this->addArgument(static::ARG_DESTINATION, InputArgument::OPTIONAL, 'Destination directory. Optional. Defaults to the current directory.');
-
+    $this->addOption(static::OPTION_DESTINATION, NULL, InputOption::VALUE_REQUIRED, 'Destination directory. Defaults to the current directory.');
     $this->addOption(static::OPTION_ROOT, NULL, InputOption::VALUE_REQUIRED, 'Path to the root for file path resolution. If not specified, current directory is used.');
     $this->addOption(static::OPTION_NO_INTERACTION, 'n', InputOption::VALUE_NONE, 'Do not ask any interactive question.');
     $this->addOption(static::OPTION_CONFIG, 'c', InputOption::VALUE_REQUIRED, 'A JSON string with options or a path to a JSON file.');
@@ -116,8 +114,7 @@ protected function configure(): void {
    * {@inheritdoc}
    */
   protected function execute(InputInterface $input, OutputInterface $output): int {
-    // @see https://github.com/drevops/vortex/issues/1502
-    if ($input->getOption('help') || $input->getArgument('destination') == 'help') {
+    if ($input->getOption('help')) {
       $output->write($this->getHelp());
 
       return Command::SUCCESS;
@@ -286,7 +283,7 @@ protected function resolveOptions(array $arguments, array $options): void {
     }
 
     // Set destination directory.
-    $dst = !empty($arguments['destination']) && is_scalar($arguments[static::ARG_DESTINATION]) ? strval($arguments[static::ARG_DESTINATION]) : NULL;
+    $dst = !empty($options[static::OPTION_DESTINATION]) && is_scalar($options[static::OPTION_DESTINATION]) ? strval($options[static::OPTION_DESTINATION]) : NULL;
     $dst = $dst ?: Env::get(Config::DST, $this->config->get(Config::DST, $this->config->get(Config::ROOT)));
     $dst = File::realpath($dst);
     $this->config->set(Config::DST, $dst, TRUE);

.vortex/installer/tests/Functional/Command/InstallCommandTest.php

@@ -90,8 +90,7 @@ public function testInstallCommand(
 
     if ($download_should_fail) {
       $mock_downloader = $this->createMock(Downloader::class);
-      $mock_downloader->method('download')
-        ->willThrowException(new \RuntimeException('Failed to download Vortex.'));
+      $mock_downloader->method('download')->willThrowException(new \RuntimeException('Failed to download Vortex.'));
       $command->setDownloader($mock_downloader);
     }
     else {
@@ -112,7 +111,7 @@ public function testInstallCommand(
     $build_command->setRunner($build_runner);
     $this->applicationGet()->add($build_command);
 
-    $command_inputs[InstallCommand::ARG_DESTINATION] = self::$sut;
+    $command_inputs['--' . InstallCommand::OPTION_DESTINATION] = self::$sut;
 
     $this->applicationRun($command_inputs, [], $expect_failure);
 

.vortex/installer/tests/Functional/FunctionalTestCase.php

@@ -85,14 +85,15 @@ protected function tearDown(): void {
   protected function runNonInteractiveInstall(?string $dst = NULL, array $options = [], bool $expect_fail = FALSE): void {
     $dst ??= static::$sut;
 
-    if ($dst !== '' && $dst !== '0') {
-      $args[InstallCommand::ARG_DESTINATION] = $dst;
-    }
-
     $defaults = [
       InstallCommand::OPTION_NO_INTERACTION => TRUE,
       InstallCommand::OPTION_URI => File::dir(static::$root),
     ];
+
+    if ($dst !== '' && $dst !== '0') {
+      $defaults[InstallCommand::OPTION_DESTINATION] = $dst;
+    }
+
     $options += $defaults;
 
     foreach ($options as $option => $value) {
@@ -110,7 +111,7 @@ protected function runInteractiveInstall(array $answers = [], ?string $dst = NUL
     $this->runNonInteractiveInstall($dst, $options + [InstallCommand::OPTION_NO_INTERACTION => FALSE], $expect_fail);
   }
 
-  protected function assertSutContains(string|array $needles): void {
+  protected function assertSutContains(string | array $needles): void {
     $needles = is_array($needles) ? $needles : [$needles];
 
     foreach ($needles as $needle) {
@@ -127,7 +128,7 @@ protected function assertSutContains(string|array $needles): void {
     }
   }
 
-  protected function assertSutNotContains(string|array $needles): void {
+  protected function assertSutNotContains(string | array $needles): void {
     $needles = is_array($needles) ? $needles : [$needles];
 
     foreach ($needles as $needle) {

.vortex/tests/phpunit/Traits/SutTrait.php

@@ -79,7 +79,7 @@ protected function runInstaller(array $arguments = []): void {
 
     $arguments = array_merge([
       '--no-interaction',
-      static::locationsSut(),
+      '--destination'=> static::locationsSut(),
     ], $arguments);
 
     $this->logNote('Run the installer script');