chore: replace stylecy with php-cs-fixer (#626)

usu · web-flow · commit 3f6fe795a0de · 2024-05-04T09:59:25.000+02:00
diff --git a/.gitattributes b/.gitattributes
@@ -1,7 +1,6 @@
 .gitattributes export-ignore
 .gitignore export-ignore
 .scrutinizer.yml export-ignore
-.styleci.yml export-ignore
 .travis.yml export-ignore
 phpunit.xml.dist export-ignore
 Resources/doc export-ignore
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -37,3 +37,16 @@ jobs:
         uses: docker://oskarstark/phpstan-ga
         with:
           args: analyze --no-progress -c phpstan.tests.neon.dist
+
+  php-cs-fixer:
+    name: PHP-CS-Fixer
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: PHP-CS-Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --dry-run --diff
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ vendor/
 composer.lock
 phpunit.xml
 Resources/doc/_build
+.php-cs-fixer.cache
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,18 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.'/src')
+    ->in(__DIR__.'/tests')
+    ->name('*.php')
+;
+
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        'single_line_throw' => false,
+    ])
+    ->setFinder($finder)
+;
diff --git a/.styleci.yml b/.styleci.yml
diff --git a/composer.json b/composer.json
@@ -59,7 +59,8 @@
         "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-symfony": "^1.3",
         "phpstan/extension-installer": "^1.3",
-        "jean-beru/fos-http-cache-cloudfront": "^1.1"
+        "jean-beru/fos-http-cache-cloudfront": "^1.1",
+        "friendsofphp/php-cs-fixer": "^3.54"
     },
     "suggest": {
         "jean-beru/fos-http-cache-cloudfront": "To use CloudFront proxy",
@@ -90,4 +91,4 @@
             "phpstan/extension-installer": true
         }
     }
-}
+}
diff --git a/src/DependencyInjection/Compiler/HashGeneratorPass.php b/src/DependencyInjection/Compiler/HashGeneratorPass.php
@@ -23,9 +23,6 @@ final class HashGeneratorPass implements CompilerPassInterface
 {
     public const TAG_NAME = 'fos_http_cache.user_context_provider';
 
-    /**
-     * {@inheritdoc}
-     */
     public function process(ContainerBuilder $container): void
     {
         if (!$container->has('fos_http_cache.user_context.hash_generator')) {
diff --git a/src/DependencyInjection/Compiler/LoggerPass.php b/src/DependencyInjection/Compiler/LoggerPass.php
@@ -19,9 +19,6 @@
  */
 final class LoggerPass implements CompilerPassInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function process(ContainerBuilder $container): void
     {
         if (!$container->has('logger') || !$container->has('fos_http_cache.event_listener.log')) {
diff --git a/src/DependencyInjection/Compiler/SessionListenerPass.php b/src/DependencyInjection/Compiler/SessionListenerPass.php
@@ -22,9 +22,6 @@
  */
 final class SessionListenerPass implements CompilerPassInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function process(ContainerBuilder $container): void
     {
         if ($container->has('session_listener')) {
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -48,9 +48,6 @@ public function __construct($debug)
         $this->debug = $debug;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('fos_http_cache');
diff --git a/src/EventListener/AttributesListener.php b/src/EventListener/AttributesListener.php
@@ -59,9 +59,6 @@ public function onKernelRequest(RequestEvent $event): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/EventListener/CacheControlListener.php b/src/EventListener/CacheControlListener.php
@@ -64,9 +64,6 @@ public function __construct(string|false $debugHeader = false)
         $this->debugHeader = $debugHeader;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/EventListener/FlashMessageListener.php b/src/EventListener/FlashMessageListener.php
@@ -39,9 +39,6 @@ public function __construct(array $options = [])
         $this->options = $resolver->resolve($options);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/EventListener/InvalidationListener.php b/src/EventListener/InvalidationListener.php
@@ -47,7 +47,7 @@ public function __construct(
         CacheManager $cacheManager,
         UrlGeneratorInterface $urlGenerator,
         RuleMatcherInterface $mustInvalidateRule,
-        ExpressionLanguage $expressionLanguage = null
+        ?ExpressionLanguage $expressionLanguage = null
     ) {
         $this->cacheManager = $cacheManager;
         $this->urlGenerator = $urlGenerator;
@@ -109,9 +109,6 @@ public function onConsoleTerminate(ConsoleEvent $event): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/EventListener/SwitchUserListener.php b/src/EventListener/SwitchUserListener.php
@@ -25,9 +25,6 @@ public function __construct(UserContextInvalidator $invalidator)
         $this->invalidator = $invalidator;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/EventListener/TagListener.php b/src/EventListener/TagListener.php
@@ -43,7 +43,7 @@ public function __construct(
         SymfonyResponseTagger $tagHandler,
         RuleMatcherInterface $cacheableRule,
         RuleMatcherInterface $mustInvalidateRule,
-        ExpressionLanguage $expressionLanguage = null
+        ?ExpressionLanguage $expressionLanguage = null
     ) {
         $this->cacheManager = $cacheManager;
         $this->symfonyResponseTagger = $tagHandler;
@@ -94,9 +94,6 @@ public function onKernelResponse(ResponseEvent $event): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/EventListener/UserContextListener.php b/src/EventListener/UserContextListener.php
@@ -64,8 +64,8 @@ final class UserContextListener implements EventSubscriberInterface
     public function __construct(
         RequestMatcherInterface $requestMatcher,
         HashGenerator $hashGenerator,
-        RequestMatcherInterface $anonymousRequestMatcher = null,
-        ResponseTagger $responseTagger = null,
+        ?RequestMatcherInterface $anonymousRequestMatcher = null,
+        ?ResponseTagger $responseTagger = null,
         array $options = [],
         bool $hasSessionListener = true
     ) {
@@ -220,9 +220,6 @@ public function onKernelResponse(ResponseEvent $event): void
         $response->setVary($vary, true);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [
diff --git a/src/FOSHttpCacheBundle.php b/src/FOSHttpCacheBundle.php
@@ -20,9 +20,6 @@
 
 final class FOSHttpCacheBundle extends Bundle
 {
-    /**
-     * {@inheritdoc}
-     */
     public function build(ContainerBuilder $container): void
     {
         $container->addCompilerPass(new LoggerPass());
diff --git a/src/Http/ResponseMatcher/ExpressionResponseMatcher.php b/src/Http/ResponseMatcher/ExpressionResponseMatcher.php
@@ -19,7 +19,7 @@ final class ExpressionResponseMatcher implements ResponseMatcherInterface
     private ?ExpressionLanguage $expressionLanguage;
     private string $expression;
 
-    public function __construct(string $expression, ExpressionLanguage $expressionLanguage = null)
+    public function __construct(string $expression, ?ExpressionLanguage $expressionLanguage = null)
     {
         $this->expression = $expression;
         $this->expressionLanguage = $expressionLanguage;
diff --git a/src/Http/RuleMatcher.php b/src/Http/RuleMatcher.php
@@ -29,10 +29,6 @@ final class RuleMatcher implements RuleMatcherInterface
 
     private ?ResponseMatcherInterface $responseMatcher;
 
-    /**
-     * @param RequestMatcherInterface  $requestMatcher|null  Request matcher
-     * @param ResponseMatcherInterface $responseMatcher|null Response matcher
-     */
     public function __construct(
         ?RequestMatcherInterface $requestMatcher = null,
         ?ResponseMatcherInterface $responseMatcher = null
@@ -41,9 +37,6 @@ public function __construct(
         $this->responseMatcher = $responseMatcher;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function matches(Request $request, Response $response)
     {
         if ($this->requestMatcher && !$this->requestMatcher->matches($request)) {
diff --git a/src/Twig/CacheTagExtension.php b/src/Twig/CacheTagExtension.php
@@ -30,9 +30,6 @@ public function __construct(ResponseTagger $responseTagger)
         $this->responseTagger = $responseTagger;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getFunctions(): array
     {
         return [
diff --git a/src/UserContext/RequestMatcher.php b/src/UserContext/RequestMatcher.php
@@ -26,9 +26,6 @@ public function __construct(?string $accept = 'application/vnd.fos.user-context-
         $this->method = $method;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function matches(Request $request): bool
     {
         if (null !== $this->accept && $this->accept != $request->headers->get('accept', null)) {
diff --git a/src/UserContext/RoleProvider.php b/src/UserContext/RoleProvider.php
@@ -35,8 +35,6 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws InvalidConfigurationException when called without a security context being set
      */
     public function updateUserContext(UserContext $context): void
diff --git a/tests/Functional/Fixtures/app/AppKernel.php b/tests/Functional/Fixtures/app/AppKernel.php
@@ -46,11 +46,11 @@ protected function build(ContainerBuilder $container): void
     public function registerBundles(): iterable
     {
         return [
-            new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
-            new \Symfony\Bundle\MonologBundle\MonologBundle(),
-            new \Symfony\Bundle\SecurityBundle\SecurityBundle(),
-            new \Symfony\Bundle\TwigBundle\TwigBundle(),
-            new \FOS\HttpCacheBundle\FOSHttpCacheBundle(),
+            new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
+            new Symfony\Bundle\MonologBundle\MonologBundle(),
+            new Symfony\Bundle\SecurityBundle\SecurityBundle(),
+            new Symfony\Bundle\TwigBundle\TwigBundle(),
+            new FOS\HttpCacheBundle\FOSHttpCacheBundle(),
         ];
     }
 
diff --git a/tests/Unit/DependencyInjection/ConfigurationTest.php b/tests/Unit/DependencyInjection/ConfigurationTest.php
@@ -402,10 +402,10 @@ public function testSupportsFastly(): void
         $formats = array_map(static function (string $path) {
             return __DIR__.'/../../Resources/Fixtures/'.$path;
         }, [
-               'config/fastly.yml',
-               'config/fastly.xml',
-               'config/fastly.php',
-           ]);
+            'config/fastly.yml',
+            'config/fastly.xml',
+            'config/fastly.php',
+        ]);
 
         foreach ($formats as $format) {
             $this->assertProcessedConfigurationEquals($expectedConfiguration, [$format]);
diff --git a/tests/Unit/DependencyInjection/FOSHttpCacheExtensionTest.php b/tests/Unit/DependencyInjection/FOSHttpCacheExtensionTest.php
@@ -222,15 +222,15 @@ public function testConfigLoadFastly(): void
     {
         $container = $this->createContainer();
         $this->extension->load([
-                                   [
-                                       'proxy_client' => [
-                                           'fastly' => [
-                                               'service_identifier' => 'test',
-                                               'authentication_token' => 'test',
-                                           ],
-                                       ],
-                                   ],
-                               ], $container);
+            [
+                'proxy_client' => [
+                    'fastly' => [
+                        'service_identifier' => 'test',
+                        'authentication_token' => 'test',
+                    ],
+                ],
+            ],
+        ], $container);
 
         $this->assertFalse($container->hasDefinition('fos_http_cache.proxy_client.varnish'));
         $this->assertTrue($container->hasDefinition('fos_http_cache.proxy_client.fastly'));
@@ -292,20 +292,20 @@ public function testConfigTagNotSupported(): void
         $this->expectExceptionMessage('You can not enable cache tagging with the nginx client');
 
         $config = [
-                'proxy_client' => [
-                    'nginx' => [
-                        'http' => [
-                            'base_url' => 'my_hostname',
-                            'servers' => [
-                                '127.0.0.1',
-                            ],
+            'proxy_client' => [
+                'nginx' => [
+                    'http' => [
+                        'base_url' => 'my_hostname',
+                        'servers' => [
+                            '127.0.0.1',
                         ],
                     ],
                 ],
-                'tags' => [
-                    'enabled' => true,
-                ],
-            ];
+            ],
+            'tags' => [
+                'enabled' => true,
+            ],
+        ];
 
         $container = $this->createContainer();
         $this->extension->load([$config], $container);
diff --git a/tests/Unit/EventListener/InvalidationListenerTest.php b/tests/Unit/EventListener/InvalidationListenerTest.php
@@ -186,7 +186,7 @@ public function testOnConsoleTerminate()
         $this->listener->onConsoleTerminate($event);
     }
 
-    protected function getEvent(Request $request, Response $response = null): TerminateEvent
+    protected function getEvent(Request $request, ?Response $response = null): TerminateEvent
     {
         return new TerminateEvent(
             \Mockery::mock(HttpKernelInterface::class),
diff --git a/tests/Unit/EventListener/TagListenerTest.php b/tests/Unit/EventListener/TagListenerTest.php
@@ -185,7 +185,7 @@ public function testOnKernelResponsePost(): void
         $this->listener->onKernelResponse($event);
     }
 
-    private function getEvent(Request $request, Response $response = null): ResponseEvent
+    private function getEvent(Request $request, ?Response $response = null): ResponseEvent
     {
         return new ResponseEvent(
             \Mockery::mock(HttpKernelInterface::class),
diff --git a/tests/Unit/EventListener/UserContextListenerTest.php b/tests/Unit/EventListener/UserContextListenerTest.php
@@ -543,7 +543,7 @@ protected function getKernelRequestEvent(Request $request, $type = HttpKernelInt
         );
     }
 
-    protected function getKernelResponseEvent(Request $request, Response $response = null, $type = HttpKernelInterface::MAIN_REQUEST): ResponseEvent
+    protected function getKernelResponseEvent(Request $request, ?Response $response = null, $type = HttpKernelInterface::MAIN_REQUEST): ResponseEvent
     {
         return new ResponseEvent(
             \Mockery::mock(HttpKernelInterface::class),

Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,6 @@ final class HashGeneratorPass implements CompilerPassInterface`
`23`	`23`	`{`
`24`	`24`	`public const TAG_NAME = 'fos_http_cache.user_context_provider';`
`25`	`25`
`26`		`- /**`
`27`		`- * {@inheritdoc}`
`28`		`- */`
`29`	`26`	`public function process(ContainerBuilder $container): void`
`30`	`27`	`{`
`31`	`28`	`if (!$container->has('fos_http_cache.user_context.hash_generator')) {`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,6 @@`
`19`	`19`	`*/`
`20`	`20`	`final class LoggerPass implements CompilerPassInterface`
`21`	`21`	`{`
`22`		`- /**`
`23`		`- * {@inheritdoc}`
`24`		`- */`
`25`	`22`	`public function process(ContainerBuilder $container): void`
`26`	`23`	`{`
`27`	`24`	`if (!$container->has('logger') \|\| !$container->has('fos_http_cache.event_listener.log')) {`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,6 @@`
`22`	`22`	`*/`
`23`	`23`	`final class SessionListenerPass implements CompilerPassInterface`
`24`	`24`	`{`
`25`		`- /**`
`26`		`- * {@inheritdoc}`
`27`		`- */`
`28`	`25`	`public function process(ContainerBuilder $container): void`
`29`	`26`	`{`
`30`	`27`	`if ($container->has('session_listener')) {`
Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,6 @@ public function __construct($debug)`
`48`	`48`	`$this->debug = $debug;`
`49`	`49`	`}`
`50`	`50`
`51`		`- /**`
`52`		`- * {@inheritdoc}`
`53`		`- */`
`54`	`51`	`public function getConfigTreeBuilder(): TreeBuilder`
`55`	`52`	`{`
`56`	`53`	`$treeBuilder = new TreeBuilder('fos_http_cache');`