Add symplify/easy-coding-standard

Author: adrienbrault

Makefile

@@ -33,5 +33,13 @@ yamllint: ## Lints yaml files
 phpstan: ## Static analysis
 	$(EXEC_PHP) phpstan
 
+.PHONY: cs
+cs: ## Coding standards check
+	$(EXEC_PHP) ecs check
+
+.PHONY: cs
+cs-fix: ## Coding standards fix
+	$(EXEC_PHP) ecs check --fix
+
 .PHONY: all
-all: phpstan yamllint ## Runs all test/lint targets
+all: phpstan yamllint cs ## Runs all test/lint targets

composer.json

@@ -24,7 +24,8 @@
     "phpstan/phpstan": "^0.12.85",
     "phpstan/phpstan-deprecation-rules": "^0.12.6",
     "phpstan/phpstan-strict-rules": "^0.12.9",
-    "phpunit/phpunit": "^9.5"
+    "phpunit/phpunit": "^9.5",
+    "symplify/easy-coding-standard": "^9.3"
   },
   "config": {
     "preferred-install": "dist",

docker-compose.yml

@@ -9,3 +9,5 @@ services:
         volumes:
             - '.:/usr/src/app'
         command: 'tail -f /dev/null'
+        environment:
+            PHP_EXTENSIONS: 'intl pdo_sqlite'

ecs.php

@@ -0,0 +1,44 @@
+<?php
+
+use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
+use PhpCsFixer\Fixer\ControlStructure\YodaStyleFixer;
+use PhpCsFixer\Fixer\Operator\NotOperatorWithSuccessorSpaceFixer;
+use PhpCsFixer\Fixer\Whitespace\MethodChainingIndentationFixer;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symplify\CodingStandard\Fixer\Spacing\MethodChainingNewlineFixer;
+use Symplify\EasyCodingStandard\ValueObject\Option;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+    $services->set(ArraySyntaxFixer::class)
+        ->call('configure', [[
+            'syntax' => 'short',
+        ]]);
+
+    $containerConfigurator->import(SetList::PSR_12);
+    $containerConfigurator->import(SetList::PHP_CS_FIXER);
+    $containerConfigurator->import(SetList::PHP_CS_FIXER_RISKY);
+    $containerConfigurator->import(SetList::SYMPLIFY);
+    $containerConfigurator->import(SetList::SYMFONY);
+    $containerConfigurator->import(SetList::SYMFONY_RISKY);
+    $containerConfigurator->import(SetList::COMMON);
+    $containerConfigurator->import(SetList::CLEAN_CODE);
+
+    $parameters = $containerConfigurator->parameters();
+    $parameters->set(Option::PATHS, [__DIR__ . '/src', __DIR__ . '/tests']);
+    $parameters->set(Option::SKIP, [
+        MethodChainingIndentationFixer::class => [
+            __DIR__ . '/src/DependencyInjection/Configuration.php',
+        ],
+        MethodChainingNewlineFixer::class => [
+            __DIR__ . '/src/DependencyInjection/Configuration.php',
+        ],
+        YodaStyleFixer::class => [
+            __DIR__,
+        ],
+        NotOperatorWithSuccessorSpaceFixer::class => [
+            __DIR__,
+        ],
+    ]);
+};

phpstan.neon

@@ -15,3 +15,4 @@ parameters:
 includes:
     - vendor/phpstan/phpstan-deprecation-rules/rules.neon
     - vendor/phpstan/phpstan-strict-rules/rules.neon
+    - vendor/phpstan/phpstan/conf/bleedingEdge.neon

src/Behat/Listener/ProfilerToolbarListener.php

@@ -2,45 +2,34 @@
 
 namespace Sourceability\ConsoleToolbarBundle\Behat\Listener;
 
+use function array_filter;
 use Behat\Behat\EventDispatcher\Event\ScenarioTested;
 use Behat\Behat\EventDispatcher\Event\StepTested;
+use function max;
 use Sourceability\ConsoleToolbarBundle\Console\ProfilerToolbarRenderer;
 use Sourceability\ConsoleToolbarBundle\Profiler\RecentProfileLoader;
+use function sprintf;
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\HttpKernel\Profiler\Profile;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\RequestContext;
 use Symfony\Component\Routing\Router;
-use function array_filter;
-use function count;
-use function in_array;
-use function max;
-use function sprintf;
 use function time;
 
 class ProfilerToolbarListener implements EventSubscriberInterface
 {
-    /**
-     * {@inheritdoc}
-     */
-    public static function getSubscribedEvents()
-    {
-        return [
-            ScenarioTested::BEFORE => ['beforeScenario', 10],
-            StepTested::BEFORE => ['beforeAfterStep', 10],
-            StepTested::AFTER => ['beforeAfterStep', 10],
-            ScenarioTested::AFTER => ['afterScenario', 10],
-        ];
-    }
-
     private RecentProfileLoader $recentProfileLoader;
+
     private ProfilerToolbarRenderer $profilerToolbarRenderer;
+
     private Router $router;
+
     private RequestContext $originalRouterContext;
 
     private ?int $beforeScenarioTimestamp = null;
+
     private ?int $lastProfileTimestamp = null;
 
     /**
@@ -50,20 +39,36 @@ public static function getSubscribedEvents()
 
     public function __construct(KernelInterface $kernel)
     {
-        $recentProfileLoader = $kernel->getContainer()->get('sourceability.console_toolbar.profiler.recent_profile_loader');
-        $profilerToolbarRenderer = $kernel->getContainer()->get('sourceability.console_toolbar.console.profiler_toolbar_renderer');
-        $router = $kernel->getContainer()->get('router');
-
-        assert($recentProfileLoader instanceof RecentProfileLoader);
-        assert($profilerToolbarRenderer instanceof ProfilerToolbarRenderer);
-        assert($router instanceof Router);
+        $recentProfileLoader = $kernel->getContainer()
+            ->get('sourceability.console_toolbar.profiler.recent_profile_loader')
+        ;
+        $profilerToolbarRenderer = $kernel->getContainer()
+            ->get('sourceability.console_toolbar.console.profiler_toolbar_renderer')
+        ;
+        $router = $kernel->getContainer()
+            ->get('router')
+        ;
+
+        \assert($recentProfileLoader instanceof RecentProfileLoader);
+        \assert($profilerToolbarRenderer instanceof ProfilerToolbarRenderer);
+        \assert($router instanceof Router);
 
         $this->recentProfileLoader = $recentProfileLoader;
         $this->profilerToolbarRenderer = $profilerToolbarRenderer;
         $this->router = $router;
         $this->originalRouterContext = clone $this->router->getContext(); // clone is important here, we're making a copy
     }
 
+    public static function getSubscribedEvents()
+    {
+        return [
+            ScenarioTested::BEFORE => ['beforeScenario', 10],
+            StepTested::BEFORE => ['beforeAfterStep', 10],
+            StepTested::AFTER => ['beforeAfterStep', 10],
+            ScenarioTested::AFTER => ['afterScenario', 10],
+        ];
+    }
+
     public function beforeScenario(ScenarioTested $event): void
     {
         $this->beforeScenarioTimestamp = time();
@@ -77,18 +82,15 @@ public function beforeAfterStep(StepTested $event): void
 
         $profiles = array_filter(
             $profiles,
-            fn (Profile $newProfile) => !in_array($newProfile->getToken(), $this->profileTokensShown, true)
+            fn (Profile $newProfile) => !\in_array($newProfile->getToken(), $this->profileTokensShown, true)
         );
 
-        if (count($profiles) > 0) {
+        if (\count($profiles) > 0) {
             $this->profilerToolbarRenderer->render(new ConsoleOutput(), $profiles);
         }
 
         foreach ($profiles as $profile) {
-            $this->lastProfileTimestamp = max(
-                $this->lastProfileTimestamp ?? 0,
-                $profile->getTime()
-            );
+            $this->lastProfileTimestamp = max($this->lastProfileTimestamp ?? 0, $profile->getTime());
             $this->profileTokensShown[] = $profile->getToken();
         }
     }
@@ -110,19 +112,16 @@ public function afterScenario(ScenarioTested $event): void
                 [
                     'start' => $from,
                     'end' => $to,
-                    'limit' => 100, // required otherwise list has no items
+                    'limit' => 100,
+                    // required otherwise list has no items
                 ],
                 UrlGeneratorInterface::ABSOLUTE_URL
             );
         });
 
         $output = new ConsoleOutput();
         $output->writeln(
-            sprintf(
-                '%d profiles collected, <href=%s>Open profile list</>',
-                $profileCount,
-                $profilerUrl
-            )
+            sprintf('%d profiles collected, <href=%s>Open profile list</>', $profileCount, $profilerUrl)
         );
     }
 

src/Behat/SymfonyProfilerExtension.php

@@ -14,43 +14,26 @@
 
 class SymfonyProfilerExtension implements ExtensionInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function process(ContainerBuilder $container): void
     {
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getConfigKey()
     {
         return 'sourceability_instrumentation';
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function initialize(ExtensionManager $extensionManager): void
     {
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function configure(ArrayNodeDefinition $builder): void
     {
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function load(ContainerBuilder $container, array $config): void
     {
-        $definition = new Definition(ProfilerToolbarListener::class, [
-            new Reference(SymfonyExtension::KERNEL_ID),
-        ]);
+        $definition = new Definition(ProfilerToolbarListener::class, [new Reference(SymfonyExtension::KERNEL_ID)]);
         $definition->addTag(EventDispatcherExtension::SUBSCRIBER_TAG);
         $container->setDefinition(ProfilerToolbarListener::class, $definition);
     }