add php stan (#86)

* fix: use phpstan + fix M6WebStatsdBundle for Symfony 6

Co-authored-by: Michael Garifullin <michael.garifullin@smartbox.com>

Author: bullder

.github/workflows/tests.yml

@@ -39,5 +39,7 @@ jobs:
         run: composer update --prefer-dist --no-interaction
       - name: Code style check
         run: bin/php-cs-fixer fix --dry-run --using-cache=no --verbose
+      - name: Static analysis
+        run: bin/phpstan analyse
       - name: Unit tests
         run: bin/atoum

composer.json

@@ -30,6 +30,7 @@
     "require-dev": {
         "atoum/atoum": "^3.4 || ^4.0",
         "m6web/php-cs-fixer-config": "^2.0",
+        "phpstan/phpstan": "^1.3",
         "symfony/console": "^4.4 || ^5.0 || ^6.0",
         "symfony/http-foundation": "^4.4 || ^5.0 || ^6.0"
     },

phpstan.neon

@@ -0,0 +1,7 @@
+parameters:
+    level: 5
+    paths:
+        - src
+    excludePaths:
+        - src/Tests
+    treatPhpDocTypesAsCertain: false

src/Client/Client.php

@@ -1,10 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace M6Web\Bundle\StatsdBundle\Client;
 
 use M6Web\Bundle\StatsdBundle\Statsd\MonitorableEventInterface;
 use M6Web\Component\Statsd\Client as BaseClient;
-use Symfony\Component\PropertyAccess;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Contracts\EventDispatcher\Event;
 
 /**
  * Class that extends base statsd client, to handle auto-increment from event dispatcher notifications
@@ -14,7 +17,7 @@ class Client extends BaseClient
     /** @var array */
     protected $listenedEvents = [];
 
-    /** @var PropertyAccess\PropertyAccessorInterface */
+    /** @var PropertyAccessorInterface */
     protected $propertyAccessor;
 
     /** @var int|null */
@@ -60,7 +63,7 @@ public function setToSendLimit($toSendLimit)
      *
      * @return $this
      */
-    public function setPropertyAccessor(PropertyAccess\PropertyAccessorInterface $propertyAccessor)
+    public function setPropertyAccessor(PropertyAccessorInterface $propertyAccessor)
     {
         $this->propertyAccessor = $propertyAccessor;
 
@@ -70,20 +73,15 @@ public function setPropertyAccessor(PropertyAccess\PropertyAccessorInterface $pr
     /**
      * Handle an event
      *
-     * @param EventInterface $event an event
-     * @param string         $name  the event name
+     * @param Event  $event an event
+     * @param string $name  the event name
      *
      * @throws Exception
      *
      * @return void
      */
     public function handleEvent($event, $name = null)
     {
-        // this is used to stay compatible with Symfony 2.3
-        if (is_null($name)) {
-            $name = $event->getName();
-        }
-
         if (!isset($this->listenedEvents[$name])) {
             return;
         }
@@ -125,7 +123,7 @@ public function handleEvent($event, $name = null)
             }
         }
 
-        if (null !== $this->toSendLimit && $this->getToSend()->count() >= $this->toSendLimit) {
+        if (null !== $this->toSendLimit && count($this->getToSend()) >= $this->toSendLimit) {
             $immediateSend = true;
         }
 
@@ -175,9 +173,9 @@ private function addTiming($event, $timingMethod, $node, $tags = [])
     /**
      * Replaces a string with a method name
      *
-     * @param EventInterface $event     An event
-     * @param string         $eventName The name of the event
-     * @param string         $string    The node in which the replacing will happen
+     * @param Event  $event     An event
+     * @param string $eventName The name of the event
+     * @param string $string    The node in which the replacing will happen
      *
      * @return string
      */

src/Client/Exception.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace M6Web\Bundle\StatsdBundle\Client;
 
 /**

src/DataCollector/StatsdDataCollector.php

@@ -1,11 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace M6Web\Bundle\StatsdBundle\DataCollector;
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Contracts\EventDispatcher\Event;
 
 /**
  * Handle datacollector for statsd
@@ -37,11 +41,11 @@ public function reset()
     /**
      * Kernel event
      *
-     * @param EventInterface $event The received event
+     * @param Event $event The received event
      */
     public function onKernelResponse($event)
     {
-        if (HttpKernelInterface::MASTER_REQUEST == $event->getRequestType()) {
+        if ($event instanceof KernelEvent && HttpKernelInterface::MASTER_REQUEST == $event->getRequestType()) {
             foreach ($this->statsdClients as $clientName => $client) {
                 $clientInfo = [
                     'name' => $clientName,

src/DependencyInjection/Configuration.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace M6Web\Bundle\StatsdBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;

src/DependencyInjection/M6WebStatsdExtension.php

@@ -1,11 +1,12 @@
 <?php
 
+declare(strict_types=1);
+
 namespace M6Web\Bundle\StatsdBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader;
 use Symfony\Component\DependencyInjection\Reference;
@@ -94,11 +95,11 @@ public function load(array $configs, ContainerBuilder $container)
     /**
      * Load a client configuration as a service in the container. A client can use multiple servers
      *
-     * @param ContainerInterface $container  The container
-     * @param string             $alias      Alias of the client
-     * @param array              $config     Base config of the client
-     * @param array              $servers    List of available servers as describe in the config file
-     * @param bool               $baseEvents Register base events
+     * @param ContainerBuilder $container  The container
+     * @param string           $alias      Alias of the client
+     * @param array            $config     Base config of the client
+     * @param array            $servers    List of available servers as describe in the config file
+     * @param bool             $baseEvents Register base events
      *
      * @throws InvalidConfigurationException
      *

src/Event/ConsoleCommandEvent.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace M6Web\Bundle\StatsdBundle\Event;
 
 use Symfony\Component\Console\Event\ConsoleCommandEvent as BaseEvent;

src/Event/ConsoleErrorEvent.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace M6Web\Bundle\StatsdBundle\Event;
 
 use Symfony\Component\Console\Event\ConsoleErrorEvent as BaseEvent;