Merge pull request #227 from greg0ire/address-latest-phpstan

Address issues with more recent PHPStan versions
swarrot · Dec 12, 2023 · 81fb4cf · 81fb4cf
2 parents 8ce754f + d446354
commit 81fb4cf
Show file tree

Hide file tree

Showing 26 changed files with 41 additions and 165 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -14,8 +14,17 @@ jobs:
   phpstan:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
-      - name: Run PHPStan
-        uses: docker://odolbeau/swarrot-phpqa:latest
+      - name: "Checkout code"
+        uses: "actions/checkout@master"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
         with:
-          args: phpstan analyze
+          coverage: "none"
+          php-version: "8.3"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v2"
+
+      - name: "Run a static analysis with phpstan/phpstan"
+        run: "vendor/bin/phpstan analyse"
diff --git a/.github/workflows/unit.yml b/.github/workflows/unit.yml
@@ -41,7 +41,9 @@ jobs:
               run: docker restart ${{ job.services.rabbitmq.id }}
 
             - name: Install Symfony Flex
-              run: composer global require --no-progress --no-scripts --no-plugins symfony/flex
+              run: |
+                composer global config --no-plugins allow-plugins.symfony/flex true
+                composer global require --no-progress --no-scripts symfony/flex
 
             - name: Install the dependencies
               env:

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 vendor/
 bin/phpunit
+.phpunit.result.cache
 composer.lock
 bin/doctrine-dbal
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -13,6 +13,9 @@
     ->setRules([
         '@Symfony' => true,
         'array_syntax' => ['syntax' => 'short'],
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true, # PHPStan will complain about missing types otherwise
+        ],
     ])
     ->setFinder($finder)
 ;

diff --git a/Broker/AmqpLibFactory.php b/Broker/AmqpLibFactory.php
@@ -23,9 +23,6 @@ class AmqpLibFactory implements FactoryInterface
     /** @var array */
     protected $messagePublishers = [];
 
-    /**
-     * {@inheritdoc}
-     */
     public function addConnection(string $name, array $connection): void
     {
         if (!empty($connection['url'])) {
@@ -36,9 +33,6 @@ public function addConnection(string $name, array $connection): void
         $this->connections[$name] = $connection;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getMessageProvider(string $name, string $connection): MessageProviderInterface
     {
         if (!isset($this->messageProviders[$connection][$name])) {
@@ -54,9 +48,6 @@ public function getMessageProvider(string $name, string $connection): MessagePro
         return $this->messageProviders[$connection][$name];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getMessagePublisher(string $name, string $connection): MessagePublisherInterface
     {
         if (!isset($this->messagePublishers[$connection][$name])) {

diff --git a/Broker/BlackholePublisher.php b/Broker/BlackholePublisher.php
@@ -6,9 +6,6 @@
 
 class BlackholePublisher extends Publisher
 {
-    /**
-     * {@inheritdoc}
-     */
     public function publish(string $messageType, Message $message, array $overridenConfig = []): void
     {
     }

diff --git a/Broker/PeclFactory.php b/Broker/PeclFactory.php
@@ -40,9 +40,6 @@ public function __construct(LoggerInterface $logger = null, bool $publisherConfi
         $this->timeout = $timeout;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function addConnection(string $name, array $connection): void
     {
         if (!empty($connection['url'])) {
@@ -53,9 +50,6 @@ public function addConnection(string $name, array $connection): void
         $this->connections[$name] = $connection;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getMessageProvider(string $name, string $connection): MessageProviderInterface
     {
         if (!isset($this->messageProviders[$connection][$name])) {
@@ -71,9 +65,6 @@ public function getMessageProvider(string $name, string $connection): MessagePro
         return $this->messageProviders[$connection][$name];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getMessagePublisher(string $name, string $connection): MessagePublisherInterface
     {
         if (!isset($this->messagePublishers[$connection][$name])) {

diff --git a/Command/SwarrotCommand.php b/Command/SwarrotCommand.php
@@ -58,9 +58,6 @@ public function __construct(
         parent::__construct();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function configure(): void
     {
         $defaultPollInterval = isset($this->extras['poll_interval']) ? $this->extras['poll_interval'] : 500000;
@@ -98,9 +95,6 @@ protected function configure(): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $options = $this->getOptions($input);

diff --git a/DataCollector/SwarrotDataCollector.php b/DataCollector/SwarrotDataCollector.php
@@ -11,8 +11,6 @@
 class SwarrotDataCollector extends DataCollector
 {
     /**
-     * {@inheritdoc}
-     *
      * @param \Throwable|\Exception $exception
      */
     public function collect(Request $request, Response $response, \Throwable $exception = null): void
@@ -43,9 +41,6 @@ public function getNbMessages(): int
         return count($this->data);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return 'swarrot';

diff --git a/DependencyInjection/Compiler/ProviderCompilerPass.php b/DependencyInjection/Compiler/ProviderCompilerPass.php
@@ -8,9 +8,6 @@
 
 class ProviderCompilerPass implements CompilerPassInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function process(ContainerBuilder $container): void
     {
         if ($container->has('swarrot.factory.default') || !$container->hasParameter('swarrot.provider_config')) {
@@ -28,14 +25,18 @@ public function process(ContainerBuilder $container): void
             }
         }
 
-        list($provider, $connections) = $container->getParameter('swarrot.provider_config');
+        /** @var array{string, array<string, mixed>} $providerConfig */
+        $providerConfig = $container->getParameter('swarrot.provider_config');
+        list($provider, $connections) = $providerConfig;
 
         if (!isset($providersIds[$provider])) {
             throw new \InvalidArgumentException(sprintf('Invalid provider "%s"', $provider));
         }
 
         $id = $providersIds[$provider];
         $definition = $container->getDefinition($id);
+
+        /** @var class-string $className */
         $className = $container->getParameterBag()->resolveValue($definition->getClass());
 
         $reflection = new \ReflectionClass($className);

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -26,9 +26,6 @@ public function __construct(bool $debug)
         $this->debug = $debug;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('swarrot');

diff --git a/DependencyInjection/SwarrotExtension.php b/DependencyInjection/SwarrotExtension.php
@@ -14,9 +14,6 @@
  */
 class SwarrotExtension extends Extension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);
@@ -66,9 +63,6 @@ public function load(array $configs, ContainerBuilder $container): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getConfiguration(array $configs, ContainerBuilder $container): Configuration
     {
         return new Configuration((bool) $container->getParameter('kernel.debug'));

diff --git a/Processor/Ack/AckProcessorConfigurator.php b/Processor/Ack/AckProcessorConfigurator.php
@@ -29,9 +29,6 @@ public function __construct(string $processorClass, FactoryInterface $factory, L
         $this->logger = $logger;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getProcessorArguments(array $options): array
     {
         return [
@@ -41,9 +38,6 @@ public function getProcessorArguments(array $options): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getCommandOptions(): array
     {
         return [
@@ -52,9 +46,6 @@ public function getCommandOptions(): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function resolveOptions(InputInterface $input): array
     {
         $this->enabled = !$input->getOption('no-ack');

diff --git a/Processor/Doctrine/ConnectionProcessorConfigurator.php b/Processor/Doctrine/ConnectionProcessorConfigurator.php
@@ -2,6 +2,7 @@
 
 namespace Swarrot\SwarrotBundle\Processor\Doctrine;
 
+use Doctrine\DBAL\Connection;
 use Swarrot\SwarrotBundle\Processor\ProcessorConfiguratorEnableAware;
 use Swarrot\SwarrotBundle\Processor\ProcessorConfiguratorExtrasAware;
 use Swarrot\SwarrotBundle\Processor\ProcessorConfiguratorInterface;
@@ -14,21 +15,19 @@ class ConnectionProcessorConfigurator implements ProcessorConfiguratorInterface
 
     /** @var string */
     private $processorClass;
-    /** @var mixed */
+
+    /** @var list<Connection> */
     private $connections;
 
     /**
-     * @param mixed $connections
+     * @param list<Connection> $connections
      */
     public function __construct(string $processorClass, $connections)
     {
         $this->processorClass = $processorClass;
         $this->connections = $connections;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getProcessorArguments(array $options): array
     {
         return [
@@ -37,17 +36,11 @@ public function getProcessorArguments(array $options): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getCommandOptions(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function resolveOptions(InputInterface $input): array
     {
         return $this->getExtras();

diff --git a/Processor/Doctrine/ObjectManagerProcessorConfigurator.php b/Processor/Doctrine/ObjectManagerProcessorConfigurator.php
@@ -16,7 +16,7 @@ class ObjectManagerProcessorConfigurator implements ProcessorConfiguratorInterfa
 
     /** @var string */
     private $processorClass;
-    /** @var mixed */
+
     private $managerRegistry;
 
     public function __construct(string $processorClass, ManagerRegistry $managerRegistry)
@@ -25,9 +25,6 @@ public function __construct(string $processorClass, ManagerRegistry $managerRegi
         $this->managerRegistry = $managerRegistry;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getProcessorArguments(array $options): array
     {
         return [
@@ -36,19 +33,13 @@ public function getProcessorArguments(array $options): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getCommandOptions(): array
     {
         return [
             ['no-reset', null, InputOption::VALUE_NONE, 'Deactivate object manager reset after processing.'],
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function resolveOptions(InputInterface $input): array
     {
         $this->enabled = !$input->getOption('no-reset');

diff --git a/Processor/ExceptionCatcher/ExceptionCatcherProcessorConfigurator.php b/Processor/ExceptionCatcher/ExceptionCatcherProcessorConfigurator.php
@@ -25,9 +25,6 @@ public function __construct(string $processorClass, LoggerInterface $logger)
         $this->logger = $logger;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getProcessorArguments(array $options): array
     {
         return [
@@ -36,19 +33,13 @@ public function getProcessorArguments(array $options): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getCommandOptions(): array
     {
         return [
             ['no-catch', 'C', InputOption::VALUE_NONE, 'Deactivate exception catching.'],
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function resolveOptions(InputInterface $input): array
     {
         $this->enabled = !$input->getOption('no-catch');

diff --git a/Processor/Insomniac/InsomniacProcessorConfigurator.php b/Processor/Insomniac/InsomniacProcessorConfigurator.php
@@ -21,9 +21,6 @@ public function __construct(LoggerInterface $logger)
         $this->logger = $logger;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getProcessorArguments(array $options): array
     {
         return [
@@ -32,17 +29,11 @@ public function getProcessorArguments(array $options): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getCommandOptions(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function resolveOptions(InputInterface $input): array
     {
         return $this->getExtras();