Fix phpstan issues

Author: chapterjason

.github/workflows/ci.yml

@@ -15,10 +15,11 @@ jobs:
             -   uses: shivammathur/setup-php@v2
                 with:
                     php-version: 8.4
-                    tools: composer-normalize, composer-require-checker
+                    tools: composer-normalize, composer-require-checker, composer-unused
             -   uses: ramsey/composer-install@v3
             -   run: composer validate --no-ansi --strict composer.json
             -   run: composer-normalize --dry-run
+            -   run: composer-unused
             -   run: composer-require-checker check
     coding-guidelines:
         name: Coding Guidelines
@@ -99,6 +100,7 @@ jobs:
                     php-version: 8.4
                     tools: infection
             -   uses: ramsey/composer-install@v3
-            -   run: infection --min-msi=78 --min-covered-msi=80 --threads=4
+            -   run: |
+                    infection --min-msi=78 --min-covered-msi=80 --threads=4 "--threads=$(nproc)"
                 env:
                     STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}

.gitignore

@@ -1,6 +1,9 @@
 vendor/
-composer.lock
-.phpunit.result.cache
 var/
 tools/
-coverage/
+coverage/
+
+composer.lock
+
+.php-cs-fixer.cache
+.phpunit.result.cache

composer.json

@@ -22,6 +22,8 @@
     },
     "require-dev": {
         "nyholm/symfony-bundle-test": "^3.0",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan-symfony": "^2.0",
         "phpunit/phpunit": "^9.5",
         "symfony/browser-kit": "^7.1",
         "symfony/monolog-bundle": "^3.10",
@@ -41,6 +43,7 @@
     },
     "config": {
         "allow-plugins": {
+            "phpstan/extension-installer": true,
             "symfony/runtime": true
         }
     }

phpstan-baseline.neon

@@ -1,101 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: '#^Parameter \#1 \$value of method SoureCode\\Bundle\\Timezone\\Manager\\TimezoneManager\:\:setTimezone\(\) expects DateTimeZone\|string, mixed given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/EventListener/TimezoneListener.php
-
-		-
-			message: '#^Method SoureCode\\Bundle\\Timezone\\Manager\\TimezoneManager\:\:__construct\(\) has parameter \$enabledTimezoneNames with no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/Manager/TimezoneManager.php
-
-		-
-			message: '#^Method SoureCode\\Bundle\\Timezone\\Manager\\TimezoneManager\:\:getEnabledTimezoneNames\(\) return type has no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/Manager/TimezoneManager.php
-
-		-
-			message: '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:fixXmlConfig\(\)\.$#'
-			identifier: method.notFound
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method arrayNode\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method children\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method defaultValue\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method end\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 6
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method ifTrue\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 2
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method info\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 2
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method scalarNode\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method scalarPrototype\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method then\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method thenInvalid\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Cannot call method validate\(\) on mixed\.$#'
-			identifier: method.nonObject
-			count: 2
-			path: src/SoureCodeTimezoneBundle.php
-
-		-
-			message: '#^Method SoureCode\\Bundle\\Timezone\\SoureCodeTimezoneBundle\:\:loadExtension\(\) has parameter \$config with no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/SoureCodeTimezoneBundle.php
-
 		-
 			message: '#^Method SoureCode\\Bundle\\Timezone\\Tests\\BundleInitializationTest\:\:createKernel\(\) has parameter \$options with no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue
@@ -119,9 +23,3 @@ parameters:
 			identifier: missingType.return
 			count: 1
 			path: tests/Manager/TimezoneManagerTest.php
-
-		-
-			message: '#^Parameter \#1 \$value of method SoureCode\\Bundle\\Timezone\\Manager\\TimezoneManager\:\:setTimezone\(\) expects DateTimeZone\|string, float\|int\<min, \-1\>\|int\<1, max\>\|string\|true given\.$#'
-			identifier: argument.type
-			count: 1
-			path: tests/app/src/Controller/TestController.php

scripts/ci.sh

@@ -16,9 +16,9 @@ symfony composer validate --no-ansi --strict composer.json
 kyx composer-normalize --dry-run
 kyx composer-require-checker check
 kyx composer-unused
-kyx php-cs-fixer fix --dry-run --show-progress=dots --using-cache=no --verbose
+FORCED_PHP_VERSION=8.3 kyx php-cs-fixer fix --dry-run --show-progress=dots --using-cache=no --verbose
 kyx phpstan analyse --memory-limit=512M --ansi --no-progress --error-format=table
 vendor/bin/phpunit
-kyx infection --threads=4
+kyx infection "-j$(nproc)"
 
 popd >/dev/null

scripts/fix.sh

@@ -13,6 +13,6 @@ fi
 
 symfony composer update
 kyx composer-normalize
-kyx php-cs-fixer fix --show-progress=dots --using-cache=no --verbose
+FORCED_PHP_VERSION=8.3 kyx php-cs-fixer fix --show-progress=dots --using-cache=no --verbose
 
 popd >/dev/null

src/EventListener/TimezoneListener.php

@@ -44,7 +44,9 @@ public function onKernelRequest(RequestEvent $event): void
 
     private function setTimezone(Request $request): void
     {
-        if ($timezone = $request->attributes->get('_timezone')) {
+        $timezone = $request->attributes->getString('_timezone');
+
+        if ('' !== $timezone) {
             $this->timezoneManager->setTimezone($timezone);
         } else {
             $request->attributes->set('_timezone', $this->timezoneManager->getTimezone()->getName());

src/Manager/TimezoneManager.php

@@ -13,11 +13,14 @@ class TimezoneManager
     private \DateTimeZone $timezone;
 
     public function __construct(
+        /**
+         * @var list<string> $enabledTimezoneNames
+         */
         private array $enabledTimezoneNames = [],
         private readonly ?Environment $twig = null,
     ) {
         if (empty($this->enabledTimezoneNames)) {
-            $this->enabledTimezoneNames = Timezones::getIds();
+            $this->enabledTimezoneNames = array_values(Timezones::getIds());
         }
 
         $this->timezone = new \DateTimeZone('Etc/UTC');
@@ -63,6 +66,9 @@ public function getTimezone(): \DateTimeZone
         return $this->timezone;
     }
 
+    /**
+     * @return list<string>
+     */
     public function getEnabledTimezoneNames(): array
     {
         return $this->enabledTimezoneNames;

src/SoureCodeTimezoneBundle.php

@@ -4,6 +4,7 @@
 
 use SoureCode\Bundle\Timezone\EventListener\TimezoneListener;
 use SoureCode\Bundle\Timezone\Manager\TimezoneManager;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -21,31 +22,35 @@ public function configure(DefinitionConfigurator $definition): void
     {
         $timezones = Timezones::getIds();
 
+        /**
+         * @var ArrayNodeDefinition $rootNode
+         */
+        $rootNode = $definition->rootNode();
+        $children = $rootNode->fixXmlConfig('timezone')->children();
+
         // @formatter:off
-        $definition->rootNode()
-            ->fixXmlConfig('timezone')
-            ->children()
-                ->scalarNode('default_timezone')
-                    ->defaultValue('Etc/UTC')
-                    ->info('The default timezone.')
-                    ->validate()
-                        ->ifTrue(fn ($v) => !\in_array($v, $timezones, true))
-                        ->thenInvalid('The timezone "%s" is not valid.')
-                    ->end()
-                ->end()
-                ->arrayNode('enabled_timezones')
-                    ->scalarPrototype()->end()
-                    ->info('List of enabled timezones. If empty, all timezones are enabled.')
-                    ->validate()
-                        ->ifTrue(fn (array $values) => \count(array_diff($values, $timezones)) > 0)
-                        ->then(fn (array $values) => throw new \InvalidArgumentException(\sprintf('The timezones "%s" are not valid.', implode('", "', array_diff($values, $timezones)))))
-                    ->end()
-                ->end()
-            ->end()
+        $children
+            ->scalarNode('default_timezone')
+                ->defaultValue('Etc/UTC')
+                ->info('The default timezone.')
+                ->validate()
+                    ->ifTrue(fn ($v) => !\in_array($v, $timezones, true))
+                    ->thenInvalid('The timezone "%s" is not valid.');
+
+        $children
+            ->arrayNode('enabled_timezones')
+                ->scalarPrototype()->end()
+                ->info('List of enabled timezones. If empty, all timezones are enabled.')
+                ->validate()
+                    ->ifTrue(fn (array $values) => \count(array_diff($values, $timezones)) > 0)
+                    ->then(fn (array $values) => throw new \InvalidArgumentException(\sprintf('The timezones "%s" are not valid.', implode('", "', array_diff($values, $timezones)))))
         ;
         // @formatter:on
     }
 
+    /**
+     * @param array{default_timezone: string, enabled_timezones: list<string>} $config
+     */
     public function loadExtension(array $config, ContainerConfigurator $container, ContainerBuilder $builder): void
     {
         $parameters = $container->parameters();