Upgrade PHPStan 2

Author: hlecorche

composer.json

@@ -34,9 +34,10 @@
     "require-dev": {
         "dg/bypass-finals": "^1.6",
         "friendsofphp/php-cs-fixer": "^3.0",
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-deprecation-rules": "^2.0",
         "phpstan/extension-installer": "^1.3",
-        "phpstan/phpstan": "^1.10",
-        "phpstan/phpstan-symfony": "^1.3",
+        "phpstan/phpstan-symfony": "^2.0",
         "phpunit/phpunit": "^10"
     },
     "config": {

phpstan-baseline.neon

@@ -3,3 +3,7 @@ parameters:
         -
             message: '#no value type specified in iterable type array#'
             path: tests/
+
+        # @legacy SF <= 7.4
+        -
+            message: '#Call to function method_exists\(\) with Symfony\\Component\\Console\\Application and .addCommand. will always evaluate to false#'

src/Command/DeployRsyncCommand.php

@@ -13,6 +13,7 @@
 
 namespace Ecommit\DeployRsyncBundle\Command;
 
+use Ecommit\DeployRsyncBundle\DependencyInjection\Configuration;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\RuntimeException;
@@ -24,15 +25,19 @@
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Process\Process;
 
+/**
+ * @phpstan-import-type Environments from Configuration
+ * @phpstan-import-type RsyncConfig from Configuration
+ */
 #[AsCommand(name: 'ecommit:deploy-rsync', description: 'Deploy the application with RSYNC and SSH')]
 final class DeployRsyncCommand extends Command
 {
     public const TARGET_FILE_REGEX = '/^file:\/\/(?<path>.+)$/';
     public const TARGET_SSH_REGEX = '/^ssh:\/\/(?<username>.+)@(?<hostname>[^:]+)(:(?<port>\d+)){0,1}:(?<path>.+)$/';
 
     /**
-     * @param array<string, array{target: string, rsync_options?: string[], ignore_file?: string}> $environments
-     * @param array{rsync_path: string, rsync_options: string[], ignore_file: ?string}             $rsyncConfig
+     * @param Environments $environments
+     * @param RsyncConfig  $rsyncConfig
      */
     public function __construct(protected array $environments, protected array $rsyncConfig, protected string $projetDir)
     {

src/DependencyInjection/Configuration.php

@@ -17,6 +17,14 @@
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
+/**
+ * @phpstan-type ProcessedConfiguration array{
+ *     environments: Environments,
+ *     rsync: RsyncConfig,
+ * }
+ * @phpstan-type Environments array<string, array{target: string, rsync_options?: string[], ignore_file?: string}>
+ * @phpstan-type RsyncConfig array{rsync_path: string, rsync_options: string[], ignore_file: ?string}
+ */
 class Configuration implements ConfigurationInterface
 {
     public function getConfigTreeBuilder(): TreeBuilder
@@ -31,26 +39,43 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->normalizeKeys(false)
                     ->arrayPrototype()
                         ->children()
-                            ->scalarNode('target')->isRequired()
+                            ->scalarNode('target')->isRequired() // @legacy SF < 7.2 (string node introduced in Symfony 7.2)
                                 ->validate()
                                     ->ifTrue(fn (mixed $value) => !\is_string($value) || (!preg_match(DeployRsyncCommand::TARGET_FILE_REGEX, $value) && !preg_match(DeployRsyncCommand::TARGET_SSH_REGEX, $value)))
                                     ->thenInvalid('Invalid target')
                                 ->end()
                             ->end()
-                            ->arrayNode('rsync_options')->prototype('scalar')->end()->end()
-                            ->scalarNode('ignore_file')->end()
+                            ->arrayNode('rsync_options')->prototype('scalar')->end()->end()  // @legacy SF < 7.2 (string node introduced in Symfony 7.2)
+                            ->scalarNode('ignore_file') // @legacy SF < 7.2 (string node introduced in Symfony 7.2)
+                                ->validate()
+                                    ->ifTrue(fn (mixed $value) => !\is_string($value) && null !== $value)
+                                    ->thenInvalid('Invalid ignore file')
+                                ->end()
+                            ->end()
                         ->end()
                     ->end()
                 ->end()
                 ->arrayNode('rsync')
                     ->addDefaultsIfNotSet()
                     ->children()
-                        ->scalarNode('rsync_path')->defaultValue('rsync')->end()
+                        ->scalarNode('rsync_path') // @legacy SF < 7.2 (string node introduced in Symfony 7.2)
+                            ->defaultValue('rsync')
+                            ->validate()
+                                ->ifTrue(fn (mixed $value) => !\is_string($value))
+                                ->thenInvalid('Invalid ignore file')
+                            ->end()
+                        ->end()
                         ->arrayNode('rsync_options')
-                            ->prototype('scalar')->end()
+                            ->prototype('scalar')->end() // @legacy SF < 7.2 (string node introduced in Symfony 7.2)
                             ->defaultValue(['-azC', '--force', '--delete', '--progress'])
                         ->end()
-                        ->scalarNode('ignore_file')->defaultNull()->end()
+                        ->scalarNode('ignore_file')  // @legacy SF < 7.2 (string node introduced in Symfony 7.2)
+                            ->defaultNull()
+                            ->validate()
+                                ->ifTrue(fn (mixed $value) => !\is_string($value) && null !== $value)
+                                ->thenInvalid('Invalid ignore file')
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()

src/DependencyInjection/EcommitDeployRsyncExtension.php

@@ -18,11 +18,15 @@
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 
+/**
+ * @phpstan-import-type ProcessedConfiguration from Configuration
+ */
 class EcommitDeployRsyncExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
+        /** @var ProcessedConfiguration $config */
         $config = $this->processConfiguration($configuration, $configs);
 
         $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../config'));

tests/Command/DeployRsyncCommandTest.php

@@ -14,12 +14,16 @@
 namespace Ecommit\DeployRsyncBundle\Tests\Command;
 
 use Ecommit\DeployRsyncBundle\Command\DeployRsyncCommand;
+use Ecommit\DeployRsyncBundle\DependencyInjection\Configuration;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Console\Tester\CommandTester;
 use Symfony\Component\Process\Process;
 
+/**
+ * @phpstan-import-type ProcessedConfiguration from Configuration
+ */
 class DeployRsyncCommandTest extends TestCase
 {
     /**
@@ -437,7 +441,7 @@ protected function createCommandTester(array $config, array $expectedCommand, bo
             ->getMock();
 
         if (\count($expectedCommand) > 0) {
-            $command->expects($this->once())->method('createProcess')->with($expectedCommand)->willReturnCallback(function ($command) use ($isSuccessful) {
+            $command->expects($this->once())->method('createProcess')->with($expectedCommand)->willReturnCallback(function ($command) use ($isSuccessful) { // @phpstan-ignore-line
                 $process = $this->getMockBuilder(Process::class)
                     ->setConstructorArgs([$command])
                     ->onlyMethods(['start', 'getIterator', 'isSuccessful'])
@@ -454,7 +458,7 @@ protected function createCommandTester(array $config, array $expectedCommand, bo
                 return $process;
             });
         } else {
-            $command->expects($this->never())->method('createProcess');
+            $command->expects($this->never())->method('createProcess'); // @phpstan-ignore-line
         }
 
         $command->setName('ecommit:deploy-rsync');
@@ -469,6 +473,9 @@ protected function createCommandTester(array $config, array $expectedCommand, bo
         return new CommandTester($application->find('ecommit:deploy-rsync'));
     }
 
+    /**
+     * @return ProcessedConfiguration
+     */
     protected function getDefaultConfig(): array
     {
         return [
@@ -486,7 +493,7 @@ protected function getDefaultConfig(): array
             'rsync' => [
                 'rsync_path' => 'rsync',
                 'rsync_options' => ['-azC', '--force', '--delete', '--progress'],
-                'ignore_file' => realpath(__DIR__.'/../ignore_file.txt'),
+                'ignore_file' => (string) realpath(__DIR__.'/../ignore_file.txt'),
             ],
         ];
     }