Allow Symfony 5 components

Author: l-vo

.composer-require-checker.json

@@ -1,6 +1,8 @@
 {
     "symbol-whitelist" : [
+        "Symfony\\Contracts\\EventDispatcher\\Event",
         "Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface",
+        "Symfony\\Component\\EventDispatcher\\Event",
         "PhpCsFixer\\Tests\\Test\\Constraint\\SameStringsConstraint",
         "PhpCsFixer\\Tests\\Test\\IsIdenticalConstraint",
         "PHPUnit\\Framework\\Constraint\\IsIdentical",

.travis.yml

@@ -88,6 +88,7 @@ jobs:
             <<: *STANDARD_TEST_JOB
             stage: Test
             php: 7.2
+            env: SYMFONY_DEPRECATIONS_HELPER=disabled PHP_CS_FIXER_TEST_USE_LEGACY_TOKENIZER=1 SYMFONY_VERSION="^5.0"
 
         -
             <<: *STANDARD_TEST_JOB

composer.json

@@ -21,15 +21,15 @@
         "composer/xdebug-handler": "^1.2",
         "doctrine/annotations": "^1.2",
         "php-cs-fixer/diff": "^1.3",
-        "symfony/console": "^3.4.17 || ^4.1.6",
-        "symfony/event-dispatcher": "^3.0 || ^4.0",
-        "symfony/filesystem": "^3.0 || ^4.0",
-        "symfony/finder": "^3.0 || ^4.0",
-        "symfony/options-resolver": "^3.0 || ^4.0",
+        "symfony/console": "^3.4.17 || ^4.1.6 || ^5.0",
+        "symfony/event-dispatcher": "^3.0 || ^4.0 || ^5.0",
+        "symfony/filesystem": "^3.0 || ^4.0 || ^5.0",
+        "symfony/finder": "^3.0 || ^4.0 || ^5.0",
+        "symfony/options-resolver": "^3.0 || ^4.0 || ^5.0",
         "symfony/polyfill-php70": "^1.0",
         "symfony/polyfill-php72": "^1.4",
-        "symfony/process": "^3.0 || ^4.0",
-        "symfony/stopwatch": "^3.0 || ^4.0"
+        "symfony/process": "^3.0 || ^4.0 || ^5.0",
+        "symfony/stopwatch": "^3.0 || ^4.0 || ^5.0"
     },
     "require-dev": {
         "johnkary/phpunit-speedtrap": "^1.1 || ^2.0 || ^3.0",
@@ -42,8 +42,8 @@
         "php-cs-fixer/phpunit-constraint-xmlmatchesxsd": "^1.1",
         "phpunit/phpunit": "^5.7.27 || ^6.5.14 || ^7.1",
         "phpunitgoodpractices/traits": "^1.8",
-        "symfony/phpunit-bridge": "^4.3",
-        "symfony/yaml": "^3.0 || ^4.0"
+        "symfony/phpunit-bridge": "^4.3 || ^5.0",
+        "symfony/yaml": "^3.0 || ^4.0 || ^5.0"
     },
     "suggest": {
         "ext-mbstring": "For handling non-UTF8 characters in cache signature.",

phpstan.neon

@@ -13,3 +13,4 @@ parameters:
         - '/^Return typehint of method PhpCsFixer\\Tests\\Test\\.+::createIsIdenticalStringConstraint\(\) has invalid type PHPUnit_Framework_Constraint_IsIdentical\.$/'
         ## cannot analyse out of PHP 7.4
         - '/^Constant T_FN not found\.$/'
+        - '/^Class (Symfony\\Contracts\\EventDispatcher\\Event|Symfony\\Component\\EventDispatcher\\Event) not found.$/'

src/Console/ConfigurationResolver.php

@@ -302,11 +302,15 @@ public function getDirectory()
     {
         if (null === $this->directory) {
             $path = $this->getCacheFile();
-            $filesystem = new Filesystem();
+            if (null === $path) {
+                $absolutePath = $this->cwd;
+            } else {
+                $filesystem = new Filesystem();
 
-            $absolutePath = $filesystem->isAbsolutePath($path)
-                ? $path
-                : $this->cwd.\DIRECTORY_SEPARATOR.$path;
+                $absolutePath = $filesystem->isAbsolutePath($path)
+                    ? $path
+                    : $this->cwd.\DIRECTORY_SEPARATOR.$path;
+            }
 
             $this->directory = new Directory(\dirname($absolutePath));
         }

src/Event/Event.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\Event;
+
+// Since PHP-CS-FIXER is PHP 5.6 compliant we can't always use Symfony Contracts (currently needs PHP ^7.1.3)
+// This conditionnal inheritance will be useless when PHP-CS-FIXER no longer supports PHP versions
+// inferior to Symfony/Contracts PHP minimal version
+if (class_exists(\Symfony\Contracts\EventDispatcher\Event::class)) {
+    class Event extends \Symfony\Contracts\EventDispatcher\Event
+    {
+    }
+} else {
+    class Event extends \Symfony\Component\EventDispatcher\Event
+    {
+    }
+}

src/FixerFileProcessedEvent.php

@@ -12,7 +12,7 @@
 
 namespace PhpCsFixer;
 
-use Symfony\Component\EventDispatcher\Event;
+use PhpCsFixer\Event\Event;
 
 /**
  * Event that is fired when file was processed by Fixer.

src/Runner/FileFilterIterator.php

@@ -13,9 +13,9 @@
 namespace PhpCsFixer\Runner;
 
 use PhpCsFixer\Cache\CacheManagerInterface;
+use PhpCsFixer\Event\Event;
 use PhpCsFixer\FileReader;
 use PhpCsFixer\FixerFileProcessedEvent;
-use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**

src/Runner/Runner.php

@@ -19,14 +19,14 @@
 use PhpCsFixer\Differ\DifferInterface;
 use PhpCsFixer\Error\Error;
 use PhpCsFixer\Error\ErrorsManager;
+use PhpCsFixer\Event\Event;
 use PhpCsFixer\FileReader;
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\FixerFileProcessedEvent;
 use PhpCsFixer\Linter\LinterInterface;
 use PhpCsFixer\Linter\LintingException;
 use PhpCsFixer\Linter\LintingResultInterface;
 use PhpCsFixer\Tokenizer\Tokens;
-use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Filesystem\Exception\IOException;
 

tests/AutoReview/ProjectCodeTest.php

@@ -114,6 +114,7 @@ function (\ReflectionClass $interface) {
         // @TODO: 3.0 should be removed
         $exceptionMethodsPerClass = [
             \PhpCsFixer\Config::class => ['create'],
+            \PhpCsFixer\Event\Event::class => ['stopPropagation'],
             \PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer::class => ['fixSpace'],
         ];
 

tests/Console/ConfigurationResolverTest.php

@@ -1142,6 +1142,47 @@ public function provideDeprecatedFixerConfiguredCases()
         ];
     }
 
+    public function provideGetDirectoryCases()
+    {
+        return [
+            [null, '/my/path/my/file', 'path/my/file'],
+            ['/my/path2/dir/.php_cs.cache', '/my/path2/dir/dir2/file', 'dir2/file'],
+            ['dir/.php_cs.cache', '/my/path/dir/dir3/file', 'dir3/file'],
+        ];
+    }
+
+    /**
+     * @dataProvider provideGetDirectoryCases
+     *
+     * @param null|string $cacheFile
+     * @param string      $file
+     * @param string      $expectedPathRelativeToFile
+     */
+    public function testGetDirectory($cacheFile, $file, $expectedPathRelativeToFile)
+    {
+        if (null !== $cacheFile) {
+            $cacheFile = $this->normalizePath($cacheFile);
+        }
+        $file = $this->normalizePath($file);
+        $expectedPathRelativeToFile = $this->normalizePath($expectedPathRelativeToFile);
+
+        $config = new Config();
+        if (null === $cacheFile) {
+            $config->setUsingCache(false);
+        } else {
+            $config->setCacheFile($cacheFile);
+        }
+
+        $resolver = new ConfigurationResolver($config, [], $this->normalizePath('/my/path'), new ToolInfo());
+        $directory = $resolver->getDirectory();
+        static::assertSame($expectedPathRelativeToFile, $directory->getRelativePathTo($file));
+    }
+
+    private function normalizePath($path)
+    {
+        return str_replace('/', \DIRECTORY_SEPARATOR, $path);
+    }
+
     private static function assertSameRules(array $expected, array $actual, $message = '')
     {
         ksort($expected);

tests/Event/EventTest.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\Tests\Event;
+
+use PhpCsFixer\Event\Event;
+use PhpCsFixer\Tests\TestCase;
+
+/**
+ * @internal
+ * @covers \PhpCsFixer\Event\Event
+ */
+final class EventTest extends TestCase
+{
+    public function testInheritance()
+    {
+        $event = new Event();
+        if (class_exists(\Symfony\Contracts\EventDispatcher\Event::class)) {
+            static::assertInstanceOf(\Symfony\Contracts\EventDispatcher\Event::class, $event);
+        } else {
+            static::assertInstanceOf(\Symfony\Component\EventDispatcher\Event::class, $event);
+        }
+    }
+}