Add a method to get the input raw arguments (#160)

Author: theofidry

phpstan-tests.neon.dist

@@ -38,7 +38,7 @@ parameters:
         - path: tests/Process/SymfonyProcessLauncherTest.php
           message: '#DummyProcess#'
 
-        - path: tests/Input/RawOptionsInputTest.php
+        - path: tests/Input/RawInputTest.php
           message: '#FakeInput#'
 
         - path: tests/ParallelExecutorFactoryTest.php

src/Input/InputOptionsSerializer.php

@@ -49,7 +49,7 @@ public static function serialize(
         array $excludedOptionNames
     ): array {
         $filteredOptions = array_diff_key(
-            RawOptionsInput::getRawOptions($input),
+            RawInput::getRawOptions($input),
             array_fill_keys($excludedOptionNames, ''),
         );
 

src/Input/RawOptionsInput.php renamed to src/Input/RawInput.php

@@ -21,7 +21,7 @@
 /**
  * @internal
  */
-final class RawOptionsInput extends Input
+final class RawInput extends Input
 {
     /**
      * @codeCoverageIgnore
@@ -31,6 +31,18 @@ private function __construct(?InputDefinition $definition)
         parent::__construct($definition);
     }
 
+    /**
+     * Returns all the given arguments NOT merged with the default values.
+     *
+     * @return array<string|bool|int|float|null|array<string|bool|int|float|null>>
+     */
+    public static function getRawArguments(InputInterface $input): array
+    {
+        return $input instanceof Input
+            ? $input->arguments
+            : [];
+    }
+
     /**
      * Returns all the given options NOT merged with the default values.
      *

tests/Input/RawOptionsInputTest.php renamed to tests/Input/RawInputTest.php

@@ -15,26 +15,129 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Webmozarts\Console\Parallelization\SymfonyVersion;
 
 /**
- * @covers \Webmozarts\Console\Parallelization\Input\RawOptionsInput
+ * @covers \Webmozarts\Console\Parallelization\Input\RawInput
  *
  * @internal
  */
-final class RawOptionsInputTest extends TestCase
+final class RawInputTest extends TestCase
 {
+    /**
+     * @dataProvider inputArgumentProvider
+     */
+    public function test_it_can_get_an_input_arguments(
+        InputInterface $input,
+        array $expected
+    ): void {
+        $actual = RawInput::getRawArguments($input);
+
+        self::assertSame($expected, $actual);
+    }
+
+    public static function inputArgumentProvider(): iterable
+    {
+        $isSymfony4 = SymfonyVersion::isSymfony4();
+
+        yield 'input with no arguments' => [
+            new ArrayInput([], null),
+            [],
+        ];
+
+        yield 'input with arguments default arguments' => [
+            new ArrayInput(
+                [],
+                new InputDefinition([
+                    new InputArgument(
+                        'arg1',
+                        InputArgument::OPTIONAL,
+                    ),
+                    new InputArgument(
+                        'arg2',
+                        InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                    ),
+                ]),
+            ),
+            [],
+        ];
+
+        yield 'input with minimum arguments' => [
+            new ArrayInput(
+                [
+                    'arg1' => 'value1',
+                    'arg2' => null,
+                    'arg3' => null,
+                ],
+                new InputDefinition([
+                    new InputArgument(
+                        'arg1',
+                        InputArgument::REQUIRED,
+                    ),
+                    new InputArgument(
+                        'arg2',
+                        InputArgument::OPTIONAL,
+                    ),
+                    new InputArgument(
+                        'arg3',
+                        InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                    ),
+                ]),
+            ),
+            [
+                'arg1' => 'value1',
+                'arg2' => null,
+                'arg3' => null,
+            ],
+        ];
+
+        yield 'input with all arguments' => [
+            new ArrayInput(
+                [
+                    'arg1' => 'value1',
+                    'arg2' => 'value2',
+                    'arg3' => 'value3 value4',
+                ],
+                new InputDefinition([
+                    new InputArgument(
+                        'arg1',
+                        InputArgument::REQUIRED,
+                    ),
+                    new InputArgument(
+                        'arg2',
+                        InputArgument::OPTIONAL,
+                    ),
+                    new InputArgument(
+                        'arg3',
+                        InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                    ),
+                ]),
+            ),
+            [
+                'arg1' => 'value1',
+                'arg2' => 'value2',
+                'arg3' => 'value3 value4',
+            ],
+        ];
+
+        yield 'non standard input' => [
+            new FakeInput(),
+            [],
+        ];
+    }
+
     /**
      * @dataProvider inputOptionProvider
      */
     public function test_it_can_get_an_input_options(
         InputInterface $input,
         array $expected
     ): void {
-        $actual = RawOptionsInput::getRawOptions($input);
+        $actual = RawInput::getRawOptions($input);
 
         self::assertSame($expected, $actual);
     }