Upgrade to FidryConsole 0.5.0 (#674)

Author: theofidry

bin/php-scoper

@@ -57,8 +57,4 @@ if (false === class_exists(IsolatedFinder::class)) {
     class_alias(Finder::class, IsolatedFinder::class);
 }
 
-ApplicationRunner::runApplication(
-    Application::create(),
-    null,
-    null,
-);
+ApplicationRunner::runApplication(Application::create());

composer.json

@@ -22,7 +22,7 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "composer/package-versions-deprecated": "^1.8",
-        "fidry/console": "^0.4.0",
+        "fidry/console": "^0.5.0",
         "jetbrains/phpstorm-stubs": "^v2021.1",
         "nikic/php-parser": "^4.12",
         "symfony/console": "^5.2 || ^6.0",

composer.lock

@@ -48,7 +48,7 @@ public static function createOption(): InputOption
 
     public static function changeWorkingDirectory(IO $io): void
     {
-        $workingDir = $io->getNullableStringOption(self::WORKING_DIR_OPT);
+        $workingDir = $io->getOption(self::WORKING_DIR_OPT)->asNullableString();
 
         if (null === $workingDir) {
             return;

src/Console/Command/ChangeableDirectory.php

@@ -106,7 +106,7 @@ public function execute(IO $io): int
 
     private function retrieveConfig(IO $io): ?string
     {
-        $configFile = $io->getNullableStringOption(self::CONFIG_FILE_OPT);
+        $configFile = $io->getOption(self::CONFIG_FILE_OPT)->asNullableNonEmptyString();
 
         $configFile = (null === $configFile)
             ? $this->makeAbsolutePath(self::CONFIG_FILE_DEFAULT)

src/Console/Command/InitCommand.php

@@ -117,8 +117,9 @@ public function execute(IO $io): int
         // working directory
         $cwd = getcwd();
 
-        $symbol = $io->getStringArgument(self::SYMBOL_ARG);
-        $symbolType = self::getSymbolType($io);
+        $symbol = $io->getArgument(self::SYMBOL_ARG)->asString();
+        /** @var SymbolType::*_TYPE $symbolType */
+        $symbolType = $io->getArgument(self::SYMBOL_TYPE_ARG)->asStringChoice(SymbolType::ALL);
         $config = $this->retrieveConfig($io, $cwd);
 
         $enrichedReflector = $this->enrichedReflectorFactory->create(
@@ -136,27 +137,6 @@ public function execute(IO $io): int
         return ExitCode::SUCCESS;
     }
 
-    /**
-     * @return SymbolType::*_TYPE
-     */
-    private static function getSymbolType(IO $io): string
-    {
-        // TODO: use options when available https://github.com/theofidry/console/issues/18
-        $type = $io->getStringArgument(self::SYMBOL_TYPE_ARG);
-
-        if (!in_array($type, SymbolType::ALL, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'Expected symbol type to be one of "%s". Got "%s"',
-                    implode('", "', SymbolType::ALL),
-                    $type,
-                ),
-            );
-        }
-
-        return $type;
-    }
-
     private function retrieveConfig(IO $io, string $cwd): Configuration
     {
         $configLoader = new ConfigLoader(
@@ -166,7 +146,7 @@ private function retrieveConfig(IO $io, string $cwd): Configuration
         );
 
         $configFilePath = $this->getConfigFilePath($io, $cwd);
-        $noConfig = $io->getBooleanOption(self::NO_CONFIG_OPT);
+        $noConfig = $io->getOption(self::NO_CONFIG_OPT)->asBoolean();
 
         if (null === $configFilePath) {
             // Unlike when scoping, we do not want a config file to be created

src/Console/Command/InspectSymbolCommand.php

@@ -4,7 +4,7 @@
 
 namespace Humbug\PhpScoper\Console;
 
-use Fidry\Console\DisplayNormalizer as FidryDisplayNormalizer;
+use Fidry\Console\Test\OutputAssertions;
 use Symfony\Component\Console\Tester\ApplicationTester;
 
 /**
@@ -21,36 +21,20 @@ public function getAppTester(): ApplicationTester
     }
 
     /**
-     * @param null|callable(string):string $extraNormalization
+     * @param callable(string):string $extraNormalizers
      */
     private function assertExpectedOutput(
         string $expectedOutput,
         int $expectedStatusCode,
-        ?callable $extraNormalization = null
+        callable ...$extraNormalizers
     ): void
     {
-        $appTester = $this->getAppTester();
-
-        $actual = $this->getNormalizeDisplay(
-            $appTester->getDisplay(true),
-            $extraNormalization,
+        OutputAssertions::assertSameOutput(
+            $expectedOutput,
+            $expectedStatusCode,
+            $this->getAppTester(),
+            [DisplayNormalizer::class, 'normalize'],
+            ...$extraNormalizers,
         );
-
-        self::assertSame($expectedOutput, $actual);
-        self::assertSame($expectedStatusCode, $appTester->getStatusCode());
-    }
-
-    private function getNormalizeDisplay(
-        string $display,
-        ?callable $extraNormalization = null
-    ): string
-    {
-        $extraNormalization = $extraNormalization ?? static fn (string $display) => $display;
-
-        $display = DisplayNormalizer::normalizeDirectorySeparators($display);
-        $display = DisplayNormalizer::normalizeProgressBar($display);
-        $display = FidryDisplayNormalizer::removeTrailingSpaces($display);
-
-        return $extraNormalization($display);
     }
 }

tests/Console/AppTesterAbilities.php

@@ -14,13 +14,12 @@
 
 namespace Humbug\PhpScoper\Console\Command;
 
-use Fidry\Console\Application\SymfonyApplication;
+use Fidry\Console\Test\AppTester;
 use Humbug\PhpScoper\Console\Application;
 use Humbug\PhpScoper\Console\AppTesterAbilities;
 use Humbug\PhpScoper\Console\AppTesterTestCase;
 use Humbug\PhpScoper\Container;
 use Humbug\PhpScoper\FileSystemTestCase;
-use Symfony\Component\Console\Tester\ApplicationTester;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 use function array_reduce;
@@ -41,9 +40,7 @@
  */
 class AddPrefixCommandIntegrationTest extends FileSystemTestCase implements AppTesterTestCase
 {
-    use AppTesterAbilities {
-        getNormalizeDisplay as getBaseNormalizeDisplay;
-    }
+    use AppTesterAbilities;
 
     private const FIXTURE_PATH = __DIR__.'/../../../fixtures/set002/original';
 
@@ -59,9 +56,7 @@ protected function setUp(): void
             false,
         );
 
-        $this->appTester = new ApplicationTester(
-            new SymfonyApplication($application),
-        );
+        $this->appTester = AppTester::fromConsoleApp($application);
 
         file_put_contents('scoper.inc.php', '<?php return [];');
     }
@@ -164,6 +159,7 @@ public function test_scope_in_normal_mode(): void
         $this->assertExpectedOutput(
             $expected,
             0,
+            $this->createDisplayNormalizer(),
             $extraNormalization,
         );
     }
@@ -210,7 +206,11 @@ public function test_scope_in_verbose_mode(): void
 
 EOF;
 
-        $this->assertExpectedOutput($expected, 0);
+        $this->assertExpectedOutput(
+            $expected,
+            0,
+            $this->createDisplayNormalizer(),
+        );
     }
 
     public function test_scope_in_very_verbose_mode(): void
@@ -291,17 +291,24 @@ public function test_scope_in_very_verbose_mode(): void
         $this->assertExpectedOutput(
             $expected,
             0,
+            $this->createDisplayNormalizer(),
             $extraDisplayNormalization,
         );
     }
 
-    private function getNormalizeDisplay(string $display, ?callable $extraNormalization = null): string
+    /**
+     * @return callable(string):string
+     */
+    private function createDisplayNormalizer(): callable
+    {
+        return fn ($display) => $this->getNormalizeDisplay($display);
+    }
+
+    private function getNormalizeDisplay(string $display): string
     {
         $display = str_replace(realpath(self::FIXTURE_PATH), '/path/to', $display);
         $display = str_replace($this->tmp, '/path/to', $display);
 
-        $display = $this->getBaseNormalizeDisplay($display, $extraNormalization);
-
         return preg_replace(
             '/\/\/ Memory usage: \d+\.\d{2}MB \(peak: \d+\.\d{2}MB\), time: \d+\.\d{2}s/',
             '// Memory usage: 5.00MB (peak: 10.00MB), time: 0.00s',

tests/Console/Command/AddPrefixCommandIntegrationTest.php

@@ -22,6 +22,13 @@
 
 final class DisplayNormalizer
 {
+    public static function normalize(string $display): string
+    {
+        return self::normalizeDirectorySeparators(
+            self::normalizeProgressBar($display),
+        );
+    }
+
     public static function normalizeDirectorySeparators(string $display): string
     {
         if ('\\' === DIRECTORY_SEPARATOR && preg_match_all('/\/path\/to(.*\\\\)+/', $display, $match)) {