PHP 8 & Symfony 6 compatibility (#85)

Author: jdecool

.coke

@@ -11,12 +11,17 @@ jobs:
           - 7.2
           - 7.3
           - 7.4
+          - 8.0
+          - 8.1
         symfony-version:
-          - 4.4.0
-          - ^5.0
+          - 4.4.*
+          - 5.3.*
+          - 5.4.*
         include:
           - php-version: 7.1
-            symfony-version: 4.4.0
+            symfony-version: 4.4.*
+          - php-version: 8.1
+            symfony-version: 6.0.*
 
     steps:
       - uses: actions/checkout@v2
@@ -33,6 +38,6 @@ jobs:
       - name: Install dependencies
         run: composer update --prefer-dist --no-interaction
       - name: Code style check
-        run: bin/coke
+        run: bin/php-cs-fixer fix --dry-run --using-cache=no --verbose
       - name: Unit tests
         run: bin/atoum

.github/workflows/tests.yml

@@ -4,4 +4,5 @@ app/logs/*
 build/
 vendor/
 bin/
+.php-cs-fixer.cache
 composer.lock

.gitignore

@@ -0,0 +1,13 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(
+        [
+            __DIR__.'/src',
+        ]
+    );
+
+$config = new M6Web\CS\Config\BedrockStreaming();
+$config->setFinder($finder);
+
+return $config;

.php-cs-fixer.dist.php

@@ -17,22 +17,21 @@
         "sort-packages": true
     },
     "require": {
-        "php": "^7.1.3",
-        "symfony/config": "^4.4 || ^5.0",
-        "symfony/dependency-injection": "^4.4 || ^5.0",
+        "php": "^7.1.3 || ^8.0",
+        "symfony/config": "^4.4 || ^5.0 || ^6.0",
+        "symfony/dependency-injection": "^4.4 || ^5.0 || ^6.0",
         "symfony/event-dispatcher-contracts": "^1.1 || ^2.1",
-        "symfony/http-kernel": "^4.4 || ^5.0",
-        "symfony/property-access": "^4.4 || ^5.0",
-        "symfony/validator": "^4.4 || ^5.0",
-        "symfony/yaml": "^4.4 || ^5.0",
+        "symfony/http-kernel": "^4.4 || ^5.0 || ^6.0",
+        "symfony/property-access": "^4.4 || ^5.0 || ^6.0",
+        "symfony/validator": "^4.4 || ^5.0 || ^6.0",
+        "symfony/yaml": "^4.4 || ^5.0 || ^6.0",
         "m6web/statsd": "^1.3"
     },
     "require-dev": {
-        "atoum/atoum": "^2.8 || ^3.0",
-        "m6web/coke": "~1.2",
-        "m6web/symfony2-coding-standard": "~1.2",
-        "symfony/console": "^4.4 || ^5.0",
-        "symfony/http-foundation": "^4.4 || ^5.0"
+        "atoum/atoum": "^3.4 || ^4.0",
+        "m6web/php-cs-fixer-config": "^2.0",
+        "symfony/console": "^4.4 || ^5.0 || ^6.0",
+        "symfony/http-foundation": "^4.4 || ^5.0 || ^6.0"
     },
     "autoload": {
         "psr-4": {

composer.json

@@ -8,15 +8,12 @@
 
 /**
  * Class that extends base statsd client, to handle auto-increment from event dispatcher notifications
- *
  */
 class Client extends BaseClient
 {
     protected $listenedEvents = [];
 
-    /**
-     * @var PropertyAccessInterface
-     */
+    /** @var PropertyAccessInterface */
     protected $propertyAccessor;
 
     protected $toSendLimit;
@@ -58,7 +55,6 @@ public function setToSendLimit($toSendLimit)
 
     /**
      * set the property accessor used in replaceConfigPlaceholder
-     * @param PropertyAccess\PropertyAccessorInterface $propertyAccessor
      *
      * @return $this
      */
@@ -76,6 +72,7 @@ public function setPropertyAccessor(PropertyAccess\PropertyAccessorInterface $pr
      * @param string         $name  the event name
      *
      * @throws Exception
+     *
      * @return void
      */
     public function handleEvent($event, $name = null)
@@ -89,17 +86,16 @@ public function handleEvent($event, $name = null)
             return;
         }
 
-        $config        = $this->listenedEvents[$name];
+        $config = $this->listenedEvents[$name];
         $immediateSend = false;
-        $tags          = $this->mergeTags($event, $config);
+        $tags = $this->mergeTags($event, $config);
 
         // replace placeholders in tags
-        $tags = array_map(function($tag) use ($event, $name) {
+        $tags = array_map(function ($tag) use ($event, $name) {
             return $this->replaceConfigPlaceholder($event, $name, $tag);
         }, $tags);
 
         foreach ($config as $conf => $confValue) {
-
             // increment
             if ('increment' === $conf) {
                 $this->increment($this->replaceConfigPlaceholder($event, $name, $confValue), 1, $tags);
@@ -123,7 +119,7 @@ public function handleEvent($event, $name = null)
             } elseif ('tags' === $conf) {
                 // nothing
             } else {
-                throw new Exception("configuration : ".$conf." not handled by the StatsdBundle or its value is in a wrong format.");
+                throw new Exception('configuration : '.$conf.' not handled by the StatsdBundle or its value is in a wrong format.');
             }
         }
 
@@ -143,25 +139,26 @@ public function handleEvent($event, $name = null)
      * @param string $method
      *
      * @return mixed
+     *
      * @throws Exception
      */
     private function getEventValue($event, $method)
     {
         if (!method_exists($event, $method)) {
-            throw new Exception("The event class ".get_class($event)." must have a ".$method." method in order to mesure value");
+            throw new Exception('The event class '.get_class($event).' must have a '.$method.' method in order to mesure value');
         }
 
-        return call_user_func(array($event,$method));
+        return call_user_func([$event, $method]);
     }
 
     /**
      * Factorisation of the timing method
      * find the value timed
      *
-     * @param object $event Event
+     * @param object $event        Event
      * @param string $timingMethod Callable method in the event
-     * @param string $node Node
-     * @param array  $tags Tags key => value for influxDb
+     * @param string $node         Node
+     * @param array  $tags         Tags key => value for influxDb
      *
      * @throws Exception
      */
@@ -176,9 +173,9 @@ private function addTiming($event, $timingMethod, $node, $tags = [])
     /**
      * Replaces a string with a method name
      *
-     * @param EventInterface $event An event
+     * @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 string         $string    The node in which the replacing will happen
      *
      * @return string
      */

src/Client/Client.php

@@ -2,9 +2,9 @@
 
 namespace M6Web\Bundle\StatsdBundle\DataCollector;
 
-use Symfony\Component\HttpKernel\DataCollector\DataCollector;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
 /**
@@ -44,8 +44,8 @@ public function onKernelResponse($event)
         if (HttpKernelInterface::MASTER_REQUEST == $event->getRequestType()) {
             foreach ($this->statsdClients as $clientName => $client) {
                 $clientInfo = [
-                    'name'       => $clientName,
-                    'operations' => []
+                    'name' => $clientName,
+                    'operations' => [],
                 ];
                 foreach ($client->getToSend() as $operation) {
                     if ($operation) {
@@ -54,10 +54,10 @@ public function onKernelResponse($event)
 
                         $clientInfo['operations'][] = [
                             'server' => $operation['server'],
-                            'node'   => $message->getNode(),
-                            'value'  => $message->getValue(),
+                            'node' => $message->getNode(),
+                            'value' => $message->getValue(),
                             'sample' => $message->getSampleRate(),
-                            'unit'   => $message->getUnit()
+                            'unit' => $message->getUnit(),
                         ];
                     }
                 }
@@ -101,7 +101,7 @@ public function getClients()
     /**
      * Return the number of statsd operations
      *
-     * @return integer the number of operations
+     * @return int the number of operations
      */
     public function getOperations()
     {

src/DataCollector/StatsdDataCollector.php

@@ -2,14 +2,14 @@
 
 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\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\DependencyInjection\Loader;
-use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
  * This is the class that loads and manages your bundle configuration
@@ -24,9 +24,9 @@ class M6WebStatsdExtension extends Extension
     public function load(array $configs, ContainerBuilder $container)
     {
         $configuration = new Configuration();
-        $config        = $this->processConfiguration($configuration, $configs);
-        $servers       = isset($config['servers']) ? $config['servers'] : [];
-        $clients       = isset($config['clients']) ? $config['clients'] : [];
+        $config = $this->processConfiguration($configuration, $configs);
+        $servers = isset($config['servers']) ? $config['servers'] : [];
+        $clients = isset($config['clients']) ? $config['clients'] : [];
 
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yml');
@@ -49,15 +49,15 @@ public function load(array $configs, ContainerBuilder $container)
                 'data_collector',
                 [
                     'template' => '@M6WebStatsd/Collector/statsd.html.twig',
-                    'id' => 'statsd'
+                    'id' => 'statsd',
                 ]
             );
 
             $definition->addTag(
                 'kernel.event_listener',
                 [
                     'event' => 'kernel.response',
-                    'method' => 'onKernelResponse'
+                    'method' => 'onKernelResponse',
                 ]
             );
 
@@ -98,15 +98,16 @@ public function load(array $configs, ContainerBuilder $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 boolean            $baseEvents Register base events
+     * @param bool               $baseEvents Register base events
      *
      * @throws InvalidConfigurationException
+     *
      * @return string the service name
      */
     protected function loadClient($container, $alias, array $config, array $servers, $baseEvents)
     {
-        $usedServers    = [];
-        $events         = $config['events'];
+        $usedServers = [];
+        $events = $config['events'];
         $matchedServers = [];
 
         if ($config['servers'][0] == 'all') {
@@ -115,7 +116,6 @@ protected function loadClient($container, $alias, array $config, array $servers,
         } else {
             // Use only declared servers
             foreach ($config['servers'] as $serverAlias) {
-
                 // Named server
                 if (array_key_exists($serverAlias, $servers)) {
                     $matchedServers[] = $serverAlias;
@@ -127,7 +127,7 @@ protected function loadClient($container, $alias, array $config, array $servers,
                 foreach (array_keys($servers) as $key) {
                     if (fnmatch($serverAlias, $key)) {
                         $matchedServers[] = $key;
-                        $found            = true;
+                        $found = true;
                     }
                 }
 
@@ -146,12 +146,12 @@ protected function loadClient($container, $alias, array $config, array $servers,
         foreach ($matchedServers as $serverAlias) {
             $usedServers[] = [
                 'address' => $servers[$serverAlias]['address'],
-                'port'    => $servers[$serverAlias]['port']
+                'port' => $servers[$serverAlias]['port'],
             ];
         }
 
         // Add the statsd client configured
-        $serviceId  = ($alias == 'default') ? 'm6_statsd' : 'm6_statsd.'.$alias;
+        $serviceId = ($alias == 'default') ? 'm6_statsd' : 'm6_statsd.'.$alias;
         $definition = new Definition('M6Web\Bundle\StatsdBundle\Client\Client');
         $definition->setPublic(true);
         $definition->addArgument($usedServers);
@@ -176,26 +176,26 @@ protected function loadClient($container, $alias, array $config, array $servers,
         $definition->addArgument(new Reference($serviceId));
         $definition->addArgument(new Reference('event_dispatcher'));
         $definition->addTag('kernel.event_listener', [
-            'event'    => 'kernel.terminate',
-            'method'   => 'onKernelTerminate',
-            'priority' => -100
+            'event' => 'kernel.terminate',
+            'method' => 'onKernelTerminate',
+            'priority' => -100,
         ]);
         $definition->addTag('kernel.event_listener', [
-            'event'    => 'console.terminate',
-            'method'   => 'onConsoleTerminate',
-            'priority' => -100
+            'event' => 'console.terminate',
+            'method' => 'onConsoleTerminate',
+            'priority' => -100,
         ]);
 
         if ($baseEvents) {
             $definition->addTag('kernel.event_listener', [
                 'event' => 'kernel.terminate',
                 'method' => 'dispatchBaseEvents',
-                'priority' => 0
+                'priority' => 0,
             ]);
             $definition->addTag('kernel.event_listener', [
                 'event' => 'kernel.exception',
                 'method' => 'onKernelException',
-                'priority' => 0
+                'priority' => 0,
             ]);
         }
         $container->setDefinition($serviceListenerId, $definition);
@@ -208,10 +208,8 @@ protected function loadClient($container, $alias, array $config, array $servers,
      *
      * trick allowing bypassing the Bundle::getContainerExtension check on getAlias
      * not very clean, to investigate
-     *
-     * @return string
      */
-    public function getAlias()
+    public function getAlias(): string
     {
         return 'm6_statsd';
     }