Setup PHP-CS-Fixer + GHA workflow (Case 130695) (#3)

* Setup PHP-CS-Fixer + GHA workflow (Case 130695)

* Fix CS with PHP-CS-Fixer 2.19.0

Co-authored-by: mpdude <[email protected]>

Author: mpdude

.github/workflows/fix-cs-php.yml

@@ -0,0 +1,29 @@
+# Update this by running
+# curl https://gist.githubusercontent.com/mpdude/ca93a185bcbf56eb7e341632ad4f8263/raw/fix-cs-php.yml > .github/workflows/fix-cs-php.yml
+
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+
+name: Coding Standards
+
+jobs:
+    open-pr-for-cs-violations:
+        name: PHP-CS-Fixer
+        runs-on: ubuntu-20.04
+        if: github.actor != 'dependabot[bot]'
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v2
+                with:
+                    ref: ${{ github.head_ref }}
+
+            -   name: Run PHP-CS-Fixer
+                uses: docker://oskarstark/php-cs-fixer-ga:2.19.0
+
+            -   name: Commit and push back changes
+                uses: stefanzweifel/git-auto-commit-action@v4
+                with:
+                    commit_message: "Fix CS with PHP-CS-Fixer 2.19.0"

.gitignore

@@ -1 +1,2 @@
 vendor/
+.php_cs.cache

.php_cs.dist

@@ -0,0 +1,25 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@Symfony' => true,
+        'array_syntax' => array('syntax' => 'short'),
+        'no_unreachable_default_argument_value' => false,
+        'braces' => array('allow_single_line_closure' => true),
+        'heredoc_to_nowdoc' => false,
+        'phpdoc_annotation_without_dot' => false,
+        'php_unit_test_annotation' => ['style' => 'annotation'],
+        'php_unit_method_casing' => false,
+        'global_namespace_import' => ['import_classes' => true, 'import_constants' => false, 'import_functions' => false],
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__)
+            ->notPath('conf/')
+            ->notPath('tmp/')
+            ->notPath('node_modules/')
+            ->notPath('var/cache')
+            ->notPath('vendor/')
+    )
+;

DependencyInjection/WebfactoryHttpCacheExtension.php

@@ -14,7 +14,7 @@ class WebfactoryHttpCacheExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container)
     {
-        $locator = new FileLocator(__DIR__ . '/../NotModified');
+        $locator = new FileLocator(__DIR__.'/../NotModified');
         $yamlLoader = new XmlFileLoader($container, $locator);
         $yamlLoader->load('services.xml');
     }

NotModified/Annotation/ReplaceWithNotModifiedResponse.php

@@ -9,6 +9,8 @@
 
 namespace Webfactory\HttpCacheBundle\NotModified\Annotation;
 
+use DateTime;
+use RuntimeException;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Webfactory\HttpCacheBundle\NotModified\LastModifiedDeterminator;
@@ -31,57 +33,50 @@ final class ReplaceWithNotModifiedResponse
     /** @var ContainerInterface */
     private $container;
 
-    /** @var \DateTime|null */
+    /** @var DateTime|null */
     private $lastModified;
 
-    /**
-     * @param array $parameters
-     */
     public function __construct(array $parameters)
     {
         $this->parameters = $parameters;
     }
 
     /**
-     * @param Request $request
-     * @return \DateTime|null
+     * @return DateTime|null
      */
     public function determineLastModified(Request $request)
     {
         $this->initialiseLastModifiedDeterminators();
 
         foreach ($this->lastModifiedDeterminators as $lastModifiedDeterminator) {
             $lastModifiedOfCurrentDeterminator = $lastModifiedDeterminator->getLastModified($request);
-            if ($this->lastModified === null || $this->lastModified < $lastModifiedOfCurrentDeterminator) {
+            if (null === $this->lastModified || $this->lastModified < $lastModifiedOfCurrentDeterminator) {
                 $this->lastModified = $lastModifiedOfCurrentDeterminator;
             }
         }
 
         return $this->lastModified;
     }
 
-    /**
-     * @param ContainerInterface $container
-     */
     public function setContainer(ContainerInterface $container)
     {
         $this->container = $container;
     }
 
     private function initialiseLastModifiedDeterminators()
     {
-        if (count($this->parameters['value']) === 0) {
-            throw new \RuntimeException('The annotation ' . get_class($this) . ' has to be parametrised with LastModifiedDeterminators.');
+        if (0 === count($this->parameters['value'])) {
+            throw new RuntimeException('The annotation '.get_class($this).' has to be parametrised with LastModifiedDeterminators.');
         }
 
         foreach ($this->parameters['value'] as $lastModifiedDeterminatorDescription) {
             $lastModifiedDeterminator = null;
 
             if (is_string($lastModifiedDeterminatorDescription)) {
-                if ($lastModifiedDeterminatorDescription[0] === '@') {
+                if ('@' === $lastModifiedDeterminatorDescription[0]) {
                     $lastModifiedDeterminator = $this->container->get(substr($lastModifiedDeterminatorDescription, 1));
                 } else {
-                    $lastModifiedDeterminator = new $lastModifiedDeterminatorDescription;
+                    $lastModifiedDeterminator = new $lastModifiedDeterminatorDescription();
                 }
             }
 
@@ -92,9 +87,7 @@ private function initialiseLastModifiedDeterminators()
             }
 
             if (!($lastModifiedDeterminator instanceof LastModifiedDeterminator)) {
-                throw new \RuntimeException(
-                    'The class "' . get_class($lastModifiedDeterminator) . '" does not implement ' . LastModifiedDeterminator::class . '.'
-                );
+                throw new RuntimeException('The class "'.get_class($lastModifiedDeterminator).'" does not implement '.LastModifiedDeterminator::class.'.');
             }
 
             $this->lastModifiedDeterminators[] = $lastModifiedDeterminator;

NotModified/EventListener.php

@@ -10,6 +10,8 @@
 namespace Webfactory\HttpCacheBundle\NotModified;
 
 use Doctrine\Common\Annotations\Reader;
+use ReflectionMethod;
+use SplObjectStorage;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
@@ -33,7 +35,7 @@ final class EventListener
      * Maps (master and sub) requests to their corresponding last modified date. This date is determined by the
      * ReplaceWithNotModifiedResponse annotation of the corresponding controller's action.
      *
-     * @var \SplObjectStorage
+     * @var SplObjectStorage
      */
     private $lastModified;
 
@@ -42,15 +44,11 @@ final class EventListener
      */
     private $debug;
 
-    /**
-     * @param Reader $reader
-     * @param ContainerInterface $container
-     */
     public function __construct(Reader $reader, ContainerInterface $container, bool $debug = false)
     {
         $this->reader = $reader;
         $this->container = $container;
-        $this->lastModified = new \SplObjectStorage();
+        $this->lastModified = new SplObjectStorage();
         $this->debug = $debug;
     }
 
@@ -59,8 +57,6 @@ public function __construct(Reader $reader, ContainerInterface $container, bool
      * If it determines that the underlying resources for the response were not modified after the "If-Modified-Since"
      * header in the request, replace the determined controller action with a minimal action that just returns an
      * "empty" response with a 304 Not Modified HTTP status code.
-     *
-     * @param FilterControllerEvent $event
      */
     public function onKernelController(FilterControllerEvent $event)
     {
@@ -97,8 +93,6 @@ public function onKernelController(FilterControllerEvent $event)
     /**
      * If a last modified date was determined for the current (master or sub) request, set it to the response so the
      * client can use it for the "If-Modified-Since" header in subsequent requests.
-     *
-     * @param FilterResponseEvent $event
      */
     public function onKernelResponse(FilterResponseEvent $event)
     {
@@ -112,6 +106,7 @@ public function onKernelResponse(FilterResponseEvent $event)
 
     /**
      * @param $controllerCallable callable PHP callback pointing to the method to reflect on.
+     *
      * @return ReplaceWithNotModifiedResponse|null The annotation, if found. Null otherwise.
      */
     private function findAnnotation(callable $controllerCallable)
@@ -121,10 +116,11 @@ private function findAnnotation(callable $controllerCallable)
         }
 
         [$class, $methodName] = $controllerCallable;
-        $method = new \ReflectionMethod($class, $methodName);
+        $method = new ReflectionMethod($class, $methodName);
 
         /** @var ReplaceWithNotModifiedResponse|null $annotation */
         $annotation = $this->reader->getMethodAnnotation($method, ReplaceWithNotModifiedResponse::class);
+
         return $annotation;
     }
 }

NotModified/LastModifiedDeterminator.php

@@ -9,6 +9,7 @@
 
 namespace Webfactory\HttpCacheBundle\NotModified;
 
+use DateTime;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
@@ -21,8 +22,7 @@
 interface LastModifiedDeterminator
 {
     /**
-     * @param Request $request
-     * @return \DateTime|null
+     * @return DateTime|null
      */
     public function getLastModified(Request $request);
 }

Tests/NotModified/Annotation/ReplaceWithNotModifiedResponseTest.php

@@ -9,6 +9,10 @@
 
 namespace Webfactory\HttpCacheBundle\Tests\NotModified\Annotation;
 
+use DateTime;
+use PHPUnit_Framework_MockObject_MockObject;
+use PHPUnit_Framework_TestCase;
+use RuntimeException;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Webfactory\HttpCacheBundle\NotModified\Annotation\ReplaceWithNotModifiedResponse;
@@ -17,14 +21,14 @@
 /**
  * Tests for the ReplaceWithNotModifiedResponse annotation.
  */
-final class ReplaceWithNotModifiedResponseTest extends \PHPUnit_Framework_TestCase
+final class ReplaceWithNotModifiedResponseTest extends PHPUnit_Framework_TestCase
 {
     /**
      * @test
      */
     public function lastModifiedDescriptionsCannotBeEmpty()
     {
-        $this->setExpectedException(\RuntimeException::class);
+        $this->setExpectedException(RuntimeException::class);
         $annotation = new ReplaceWithNotModifiedResponse(['value' => []]);
         $annotation->determineLastModified(new Request());
     }
@@ -44,7 +48,7 @@ public function stringAsSimpleLastModifiedDescription()
      */
     public function serviceNameAsLastModifiedDescription()
     {
-        /** @var ContainerInterface|\PHPUnit_Framework_MockObject_MockObject $container */
+        /** @var ContainerInterface|PHPUnit_Framework_MockObject_MockObject $container */
         $container = $this->getMock(ContainerInterface::class);
         $container->expects($this->once())
             ->method('get')
@@ -64,7 +68,7 @@ public function serviceNameAsLastModifiedDescription()
     public function arrayAslastModifiedDeterminatorDescriptionWithConstructorArguments()
     {
         $this->setExpectedException(null);
-        $annotation = new ReplaceWithNotModifiedResponse(['value' => [[MyLastModifedDeterminator::class => new \DateTime('2000-01-01')]]]);
+        $annotation = new ReplaceWithNotModifiedResponse(['value' => [[MyLastModifedDeterminator::class => new DateTime('2000-01-01')]]]);
         $annotation->determineLastModified(new Request());
     }
 
@@ -73,7 +77,7 @@ public function arrayAslastModifiedDeterminatorDescriptionWithConstructorArgumen
      */
     public function lastModifiedDeterminatorsHaveToImplementInterface()
     {
-        $this->setExpectedException(\RuntimeException::class);
+        $this->setExpectedException(RuntimeException::class);
         $annotation = new ReplaceWithNotModifiedResponse(['value' => [FakeLastModifiedDeterminatorWithoutInterface::class]]);
         $annotation->determineLastModified(new Request());
     }
@@ -85,7 +89,7 @@ public function determineLastModifiedDeterminesLastModifiedOfOneDeterminator()
     {
         $annotation = new ReplaceWithNotModifiedResponse(['value' => [MyLastModifedDeterminator::class]]);
         $this->assertEquals(
-            new \DateTime(),
+            new DateTime(),
             $annotation->determineLastModified(new Request()),
             '',
             $allowedDeltaInSeconds = 3
@@ -98,28 +102,26 @@ public function determineLastModifiedDeterminesLastModifiedOfOneDeterminator()
     public function determineLastModifiedDeterminesLastModifiedOfMultipleDeterminators()
     {
         $annotation = new ReplaceWithNotModifiedResponse(['value' => [
-            [MyLastModifedDeterminator::class => new \DateTime('2001-01-01')],
-            [MyLastModifedDeterminator::class => new \DateTime('2003-01-01')],
-            [MyLastModifedDeterminator::class => new \DateTime('2002-01-01')],
+            [MyLastModifedDeterminator::class => new DateTime('2001-01-01')],
+            [MyLastModifedDeterminator::class => new DateTime('2003-01-01')],
+            [MyLastModifedDeterminator::class => new DateTime('2002-01-01')],
         ]]);
-        $this->assertEquals(new \DateTime('2003-01-01'), $annotation->determineLastModified(new Request()));
+        $this->assertEquals(new DateTime('2003-01-01'), $annotation->determineLastModified(new Request()));
     }
 }
 
-
-
 final class FakeLastModifiedDeterminatorWithoutInterface
 {
 }
 
 final class MyLastModifedDeterminator implements LastModifiedDeterminator
 {
-    /** @var \DateTime */
+    /** @var DateTime */
     private $lastModified;
 
-    public function __construct(\DateTime $lastModified = null)
+    public function __construct(DateTime $lastModified = null)
     {
-        $this->lastModified = $lastModified ?: new \DateTime();
+        $this->lastModified = $lastModified ?: new DateTime();
     }
 
     public function getLastModified(Request $request)