Allow capturing of requested package argument when configure options are placed before package argument

Author: asgrim

src/Command/ArgvInput.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\Pie\Command;
+
+use Throwable;
+
+class ArgvInput extends \Symfony\Component\Console\Input\ArgvInput
+{
+    private Throwable|null $exceptionThrown = null;
+
+    /**
+     * Wrap parent token parsing to collect and ignore exceptions during
+     * parsing. This ensures that errors we meet mid-way through parsing don't
+     * short-circuit processing the rest of the arguments. Without this, whilst
+     * the following example works:
+     *
+     *     pie build asgrim/example-pie-extension --with-hello-name=sup
+     *
+     * This does not:
+     *
+     *     pie build --with-hello-name=sup asgrim/example-pie-extension
+     *
+     * This is because when Symfony tries to parse the `--with-hello-name`, it
+     * hasn't loaded in the configure options for the package yet, and so
+     * throws an exception and does not process the package name argument.
+     *
+     * Note, however, there is still a limitation, as this will not work:
+     *
+     *      pie build --with-hello-name sup asgrim/example-pie-extension
+     */
+    protected function parse(): void
+    {
+        $this->exceptionThrown = null;
+
+        parent::parse();
+
+        if ($this->exceptionThrown !== null) {
+            throw $this->exceptionThrown;
+        }
+    }
+
+    protected function parseToken(string $token, bool $parseOptions): bool
+    {
+        try {
+            return parent::parseToken($token, $parseOptions);
+        } catch (Throwable $caught) {
+            $this->exceptionThrown = $caught;
+
+            // Ignore the error intentionally
+            return $parseOptions;
+        }
+    }
+}

src/Container.php

@@ -13,6 +13,7 @@
 use Php\Pie\Building\Build;
 use Php\Pie\Building\UnixBuild;
 use Php\Pie\Building\WindowsBuild;
+use Php\Pie\Command\ArgvInput;
 use Php\Pie\Command\BuildCommand;
 use Php\Pie\Command\DownloadCommand;
 use Php\Pie\Command\InfoCommand;
@@ -43,7 +44,6 @@
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 use Symfony\Component\Console\Formatter\OutputFormatter;
 use Symfony\Component\Console\Helper\QuestionHelper;
-use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\Console\Output\OutputInterface;

test/unit/Command/ArgvInputTest.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Php\PieUnitTest\Command;
+
+use Php\Pie\Command\ArgvInput;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputDefinition;
+use Throwable;
+
+#[CoversClass(ArgvInput::class)]
+final class ArgvInputTest extends TestCase
+{
+    /** @return array<string, list<list<string>>> */
+    public static function argvWithInvalidInputProvider(): array
+    {
+        return [
+            'simple-option' => [['myapp', '--invalid-option', 'myvalue']],
+            'value-option' => [['myapp', '--invalid-option=foo', 'myvalue']],
+            'short-option' => [['myapp', '-i', 'myvalue']],
+            // explicitly not supported for now; we can't tell which is the argument here
+            // 'split-option' => [['myapp', '--invalid-option', 'foo', 'myvalue']],
+        ];
+    }
+
+    /** @param list<string> $argv */
+    #[DataProvider('argvWithInvalidInputProvider')]
+    public function testInvalidOptionsDoNotCauseArgumentsToBeMissed(array $argv): void
+    {
+        $definition = new InputDefinition();
+        $definition->addArgument(new InputArgument('myarg', InputArgument::OPTIONAL));
+
+        $argvInput = new ArgvInput($argv);
+        try {
+            $argvInput->bind($definition);
+            self::fail('Expected an exception to be thrown because `--invalid-option` is not defined');
+        } catch (Throwable) {
+            // An exception is expected here, because `--invalid-option` was not defined
+            self::addToAssertionCount(1);
+        }
+
+        // But, crucially, we should have captured the following argument
+        self::assertSame('myvalue', $argvInput->getArgument('myarg'));
+    }
+}