Add phpstan to project

.github/workflows/ci.yml

@@ -85,3 +85,6 @@ jobs:
 
       - name: "Run code-style check"
         run: composer phpcs
+
+      - name: "Run PHPStan check"
+        run: composer phpstan

Cache/Redis.php

@@ -132,13 +132,13 @@ public function mSetNx($v)
         return $result;
     }
 
-    public function expire($key, $expire)
+    public function expire($key, $expire, $mode = null)
     {
         if ($this->stopwatch) {
             $e = $this->getStopwatchEvent('expire');
         }
 
-        $result = parent::expire($key, $expire);
+        $result = parent::expire($key, $expire, $mode);
 
         if ($this->stopwatch) {
             $e->stop();
@@ -192,13 +192,13 @@ public function sMembers($key)
         return $result;
     }
 
-    public function sAdd($tag, $id)
+    public function sAdd($tag, $id, ...$other_values)
     {
         if ($this->stopwatch) {
             $e = $this->getStopwatchEvent('sAdd');
         }
 
-        $result = parent::sAdd($tag, $id);
+        $result = parent::sAdd($tag, $id, ...$other_values);
 
         if ($this->stopwatch) {
             $e->stop();

DependencyInjection/Configuration.php

@@ -20,9 +20,11 @@ public function getConfigTreeBuilder(): TreeBuilder
         $treeBuilder = new TreeBuilder('intaro_pinba');
         if (\method_exists($treeBuilder, 'getRootNode')) {
             $rootNode = $treeBuilder->getRootNode();
-        } else {
+        } elseif (\method_exists($treeBuilder, 'root')) {
             // BC layer for symfony/config 4.1 and older
             $rootNode = $treeBuilder->root('intaro_pinba');
+        } else {
+            throw new \RuntimeException('Unsupported symfony/config version');
         }
 
         $rootNode

EventListener/ScriptNameConfigureListener.php

@@ -25,9 +25,9 @@ public function onRequest(KernelEvent $event): void
         pinba_script_name_set($event->getRequest()->getRequestUri());
     }
 
-    private static function bcEvent($event)
+    private static function bcEvent($event): bool
     {
-        $eventClass = \Symfony\Component\HttpKernel\Event\GetResponseEvent::class;
+        $eventClass = 'Symfony\Component\HttpKernel\Event\GetResponseEvent';
 
         return class_exists($eventClass) && !$event instanceof $eventClass;
     }

IntaroPinbaBundle.php

@@ -11,8 +11,6 @@ class IntaroPinbaBundle extends Bundle
 {
     public function build(ContainerBuilder $container)
     {
-        if(Kernel::MAJOR_VERSION >= 3) {
-            $container->addCompilerPass(new TwigPass());
-        }
+        $container->addCompilerPass(new TwigPass());
     }
 }

Makefile

@@ -13,7 +13,10 @@ vendor: composer.json
 phpcs: $(PHP_CONSOLE_DEPS)
 	@$(PHP) vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --using-cache=no -v
 
+phpstan: $(PHP_CONSOLE_DEPS)
+	@$(PHP) vendor/bin/phpstan analyse
+
 phpunit: $(PHP_CONSOLE_DEPS)
 	@$(PHP) vendor/bin/phpunit --color=always
 
-check: phpcs phpunit
+check: phpcs phpstan phpunit

README.md

@@ -82,7 +82,7 @@ Install vendors:
 make vendor
 ```
 
-Run php-cs-fixer and phpunit:
+Run php-cs-fixer, phpstan and phpunit:
 ```shell
 make check
 ```

Stopwatch/Stopwatch.php

@@ -43,9 +43,7 @@ public function start(array $tags)
             $tags = array_merge($this->initTags, $tags);
             if (isset($tags['group']) && !isset($tags['category']) && false !== strpos($tags['group'], '::')) {
                 $v = explode('::', $tags['group']);
-                if (count($v) > 0) {
-                    $tags['category'] = $v[0];
-                }
+                $tags['category'] = $v[0];
             }
         }
 

Twig/TimedTwigEngine.php

@@ -37,6 +37,7 @@ class TimedTwigEngine extends TwigEngine
      */
     public function __construct(\Twig\Environment $environment, TemplateNameParserInterface $parser, FileLocatorInterface $locator, Stopwatch $stopwatch)
     {
+        /* @phpstan-ignore-next-line */
         parent::__construct($environment, $parser, $locator);
 
         $this->stopwatch = $stopwatch;
@@ -53,6 +54,7 @@ public function render($name, array $parameters = [])
             'twig_template' => (string) $name,
         ]);
 
+        /* @phpstan-ignore-next-line */
         $ret = parent::render($name, $parameters);
 
         $e->stop();

composer.json

@@ -13,6 +13,7 @@
         "symfony/yaml": "^4.0|^5.0|^6.0"
     },
     "require-dev": {
+        "doctrine/dbal": "^2|^3|^4",
         "nyholm/symfony-bundle-test": "^2.0",
         "phpunit/phpunit": "^8.5|^9.5",
         "symfony/phpunit-bridge": "^5.0|^6.0",
@@ -27,14 +28,16 @@
         "symfony/routing": "^4.4|^5.0|^6.0",
         "symfony/finder": "^4.4|^5.0|^6.0",
         "symfony/filesystem": "^4.4|^5.0|^6.0",
+        "symfony/templating": "^4.4|^5.0|^6.0",
         "symfony/translation-contracts": "^1.1|^2.0",
         "symfony/var-exporter": "^4.4|^5.0|^6.0",
         "symfony/var-dumper": "^4.4|^5.0|^6.0",
         "psr/log": "~1.0|^2|^3",
         "friendsofphp/php-cs-fixer": "3.4",
         "twig/twig": "^v2.14 || ^3.0",
         "symfony/twig-bundle": "^4.4|^5.0|^6.0",
-        "symfony/twig-bridge": "^4.4|^5.0|^6.0"
+        "symfony/twig-bridge": "^4.4|^5.0|^6.0",
+        "phpstan/phpstan": "^1.10"
     },
     "autoload": {
         "psr-4": {
@@ -51,7 +54,6 @@
         "phpcs": [
             "vendor/bin/php-cs-fixer fix --dry-run --config=.php-cs-fixer.dist.php --using-cache=no --show-progress=none -v"
         ],
-        "docker-clean": "docker image rm $(docker image ls -qf reference=pinba-bundle-test)",
-        "docker": "docker build . -t pinba-bundle-test && docker image prune -f >/dev/null && docker run --rm pinba-bundle-test"
+        "phpstan": "vendor/bin/phpstan analyse --no-progress"
     }
 }

meta/phpstan/stub.php

@@ -0,0 +1,26 @@
+<?php
+
+if (!function_exists('pinba_get_info')) {
+    function pinba_get_info(): array
+    {
+        return [];
+    }
+}
+
+if (!function_exists('pinba_timer_start')) {
+    function pinba_timer_start(array $tags)
+    {
+    }
+}
+
+if (!function_exists('pinba_timer_stop')) {
+    function pinba_timer_stop($timer)
+    {
+    }
+}
+
+if (!function_exists('pinba_timer_add')) {
+    function pinba_timer_add(array $tags, int $value)
+    {
+    }
+}

phpstan.neon.dist

@@ -0,0 +1,13 @@
+parameters:
+    level: 5
+    paths:
+        - .
+    excludePaths:
+        - vendor/
+    bootstrapFiles:
+        - meta/phpstan/stub.php
+    ignoreErrors:
+        # TODO remove after symfony >= 5.x
+        -
+            message: '#Access to an undefined static property Intaro\\PinbaBundle\\Tests\\BundleInitializationTest\:\:\$container#'
+            reportUnmatched: false

tests/BundleInitializationTest.php

@@ -10,6 +10,7 @@
 use Nyholm\BundleTest\TestKernel;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Bundle\TwigBundle\TwigBundle;
+use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelInterface;
 
 class BundleInitializationTest extends KernelTestCase
@@ -21,6 +22,7 @@ protected static function getKernelClass(): string
 
     protected static function createKernel(array $options = []): KernelInterface
     {
+        /** @var TestKernel $kernel */
         $kernel = parent::createKernel($options);
         $kernel->addTestBundle(IntaroPinbaBundle::class);
         $kernel->addTestBundle(FixtureBundle::class);
@@ -33,9 +35,9 @@ protected static function createKernel(array $options = []): KernelInterface
     public function testInitBundle(): void
     {
         self::bootKernel();
-        $symfony = self::getSymfonyVersion();
+        $symfonyVersion = self::getSymfonyVersion();
 
-        if (version_compare($symfony, '5.0.0') >= 0) {
+        if ($symfonyVersion >= 5) {
             $container = self::getContainer();
         } else {
             $container = self::$container;
@@ -50,9 +52,9 @@ public function testInitBundle(): void
     public function testTwigRenderStopwatch(): void
     {
         self::bootKernel();
-        $symfony = self::getSymfonyVersion();
+        $symfonyVersion = self::getSymfonyVersion();
 
-        if (version_compare($symfony, '5.0.0') >= 0) {
+        if ($symfonyVersion >= 5) {
             $container = self::getContainer();
         } else {
             $container = self::$container;
@@ -62,10 +64,11 @@ public function testTwigRenderStopwatch(): void
         $this->assertInstanceOf(TimedTwigEnvironment::class, $service);
     }
 
-    private static function getSymfonyVersion()
+    private static function getSymfonyVersion(): int
     {
+        /** @var Kernel $kernel */
         $kernel = self::bootKernel();
 
-        return $kernel::VERSION;
+        return $kernel::MAJOR_VERSION;
     }
 }