refactor: move command parsing to trait

Author: carlalexander

src/Command/ParsesConsoleCommandTrait.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir command-line tool.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Cli\Command;
+
+trait ParsesConsoleCommandTrait
+{
+    /**
+     * Parses a command string into command parts.
+     */
+    protected function parseCommand(string $command): array
+    {
+        return collect(preg_split('/\s+/', trim($command)) ?: [])
+            ->filter(function (string $commandPart): bool {
+                return '' !== $commandPart;
+            })
+            ->values()
+            ->all();
+    }
+
+    /**
+     * Removes the first matching command prefix from a command string.
+     */
+    protected function stripCommandPrefix(string $command, $prefixes): string
+    {
+        $prefix = collect((array) $prefixes)->first(function (string $prefix) use ($command): bool {
+            return str_starts_with($command, sprintf('%s ', $prefix));
+        });
+
+        return is_string($prefix) ? substr($command, strlen(sprintf('%s ', $prefix))) : $command;
+    }
+}

src/Command/WordPress/WpCliCommand.php

@@ -18,6 +18,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Ymir\Cli\Command\AbstractCommand;
 use Ymir\Cli\Command\LocalProjectCommandInterface;
+use Ymir\Cli\Command\ParsesConsoleCommandTrait;
 use Ymir\Cli\Exception\InvalidInputException;
 use Ymir\Cli\Exception\Project\UnsupportedProjectException;
 use Ymir\Cli\Project\Type\AbstractWordPressProjectType;
@@ -26,6 +27,7 @@
 class WpCliCommand extends AbstractCommand implements LocalProjectCommandInterface
 {
     use HandlesWpCliInvocationTrait;
+    use ParsesConsoleCommandTrait;
 
     /**
      * The name of the command.
@@ -67,14 +69,16 @@ protected function perform()
             $command = $this->output->ask('What WP-CLI command would you like to run?');
         }
 
-        if (str_starts_with($command, 'wp ')) {
-            $command = substr($command, 3);
-        }
+        $command = $this->stripCommandPrefix($command, 'wp');
+
+        $commandParts = $this->parseCommand($command);
+        $commandName = $commandParts[0] ?? '';
+        $subCommandName = $commandParts[1] ?? '';
 
-        if (in_array($command, ['shell'])) {
+        if ('shell' === $commandName) {
             throw new InvalidInputException(sprintf('The "wp %s" command isn\'t available remotely', $command));
-        } elseif (in_array($command, ['db import', 'db export'])) {
-            throw new InvalidInputException(sprintf('Please use the "ymir database:%s" command instead of the "wp %s" command', substr($command, 3), $command));
+        } elseif ('db' === $commandName && in_array($subCommandName, ['import', 'export'], true)) {
+            throw new InvalidInputException(sprintf('Please use the "ymir database:%s" command instead of the "wp %s" command', $subCommandName, $command));
         }
 
         $this->output->info(sprintf('Running "<comment>wp %s</comment>" %s "<comment>%s</comment>" environment', $command, $async ? 'asynchronously on' : 'on', $environment->getName()));

tests/Integration/Command/WordPress/WpCliCommandTest.php

@@ -139,6 +139,24 @@ public function testPerformThrowsExceptionIfCommandIsDbImport(): void
         $this->executeCommand(WpCliCommand::NAME, ['wp-command' => ['db', 'import'], '--environment' => 'production']);
     }
 
+    public function testPerformThrowsExceptionIfCommandIsDbImportWithArguments(): void
+    {
+        $this->expectException(InvalidInputException::class);
+        $this->expectExceptionMessage('Please use the "ymir database:import" command instead of the "wp db import ./dump.sql" command');
+
+        $this->setupActiveTeam();
+        $project = $this->setupValidProject(1, 'project', [], 'wordpress', WordPressProjectType::class);
+        $environment = EnvironmentFactory::create(['name' => 'production']);
+
+        $this->apiClient->shouldReceive('getEnvironments')->with(\Mockery::type(Project::class))->andReturn(new ResourceCollection([$environment]));
+
+        $this->bootApplication([new WpCliCommand($this->apiClient, $this->createExecutionContextFactory([
+            Environment::class => function () { return new EnvironmentDefinition(); },
+        ]))]);
+
+        $this->executeCommand(WpCliCommand::NAME, ['wp-command' => ['db', 'import', './dump.sql'], '--environment' => 'production']);
+    }
+
     public function testPerformThrowsExceptionIfCommandIsShell(): void
     {
         $this->expectException(InvalidInputException::class);
@@ -157,6 +175,24 @@ public function testPerformThrowsExceptionIfCommandIsShell(): void
         $this->executeCommand(WpCliCommand::NAME, ['wp-command' => ['shell'], '--environment' => 'production']);
     }
 
+    public function testPerformThrowsExceptionIfCommandIsShellWithArguments(): void
+    {
+        $this->expectException(InvalidInputException::class);
+        $this->expectExceptionMessage('The "wp shell --prompt=ymir" command isn\'t available remotely');
+
+        $this->setupActiveTeam();
+        $project = $this->setupValidProject(1, 'project', [], 'wordpress', WordPressProjectType::class);
+        $environment = EnvironmentFactory::create(['name' => 'production']);
+
+        $this->apiClient->shouldReceive('getEnvironments')->with(\Mockery::type(Project::class))->andReturn(new ResourceCollection([$environment]));
+
+        $this->bootApplication([new WpCliCommand($this->apiClient, $this->createExecutionContextFactory([
+            Environment::class => function () { return new EnvironmentDefinition(); },
+        ]))]);
+
+        $this->executeCommand(WpCliCommand::NAME, ['wp-command' => ['shell', '--prompt=ymir'], '--environment' => 'production']);
+    }
+
     public function testPerformThrowsExceptionIfProjectIsNotWordPress(): void
     {
         $this->expectException(UnsupportedProjectException::class);