Drop PHP 7.4 support, Fix Doctrine Entities by Attributes (#17)

Slamdunk · web-flow · commit 85e22636c870 · 2022-05-31T10:46:56.000+02:00
diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml
@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.0"
 
     steps:
       - name: "Checkout"
@@ -62,8 +62,8 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
           - "8.0"
+          - "8.1"
 
     steps:
       - name: "Checkout"
@@ -72,7 +72,7 @@ jobs:
       - name: "Install PHP"
         uses: "shivammathur/setup-php@v2"
         with:
-          coverage: "xdebug"
+          coverage: "pcov"
           php-version: "${{ matrix.php-version }}"
           ini-values: zend.assertions=1
 
@@ -95,6 +95,7 @@ jobs:
         run: "vendor/bin/phpunit --coverage-clover=coverage.xml"
 
       - name: "Send code coverage report to Codecov.io"
+        if: ${{ matrix.php-version == '8.1' }}
         uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -109,7 +110,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.0"
 
     steps:
       - name: "Checkout"
@@ -146,7 +147,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.0"
 
     steps:
       - name: "Checkout"
diff --git a/composer.json b/composer.json
@@ -10,24 +10,18 @@
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "~8.0.0 || ~8.1.0",
         "ext-mbstring": "*",
         "ext-tokenizer": "*",
-        "friendsofphp/php-cs-fixer": "^3.1.0"
+        "friendsofphp/php-cs-fixer": "^3.8.0"
     },
     "require-dev": {
         "malukenho/mcbumpface": "^1.1.5",
-        "phpstan/phpstan": "^0.12.99",
-        "phpstan/phpstan-phpunit": "^0.12.22",
-        "phpunit/phpunit": "^9.5.9",
+        "phpstan/phpstan": "^1.7.6",
+        "phpstan/phpstan-phpunit": "^1.1.1",
+        "phpunit/phpunit": "^9.5.20",
         "slam/php-debug-r": "^1.7.0",
-        "slam/phpstan-extensions": "^5.1.0",
-        "thecodingmachine/phpstan-strict-rules": "^0.12.1"
-    },
-    "extra": {
-        "mc-bumpface": {
-            "stripVersionPrefixes": true
-        }
+        "slam/phpstan-extensions": "^6.0.0"
     },
     "autoload": {
         "psr-4": {
@@ -38,5 +32,15 @@
         "psr-4": {
             "SlamCsFixer\\Tests\\": "tests/"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "malukenho/mcbumpface": true
+        }
+    },
+    "extra": {
+        "mc-bumpface": {
+            "stripVersionPrefixes": true
+        }
     }
 }
diff --git a/lib/Config.php b/lib/Config.php
@@ -11,8 +11,8 @@ final class Config extends PhpCsFixerConfig
 {
     public const RULES = [
         '@DoctrineAnnotation'                               => true,
-        '@PHP80Migration'                                   => true,
         '@PHP80Migration:risky'                             => true,
+        '@PHP81Migration'                                   => true,
         '@PHPUnit84Migration:risky'                         => true,
         '@PhpCsFixer'                                       => true,
         '@PhpCsFixer:risky'                                 => true,
@@ -29,6 +29,8 @@ final class Config extends PhpCsFixerConfig
         'combine_consecutive_unsets'                        => false,
         'comment_to_phpdoc'                                 => false,
         'concat_space'                                      => ['spacing' => 'one'],
+        'control_structure_continuation_position'           => true,
+        'date_time_create_from_format_call'                 => true,
         'date_time_immutable'                               => false,
         'declare_parentheses'                               => true,
         'error_suppression'                                 => false,
diff --git a/lib/FinalInternalClassFixer.php b/lib/FinalInternalClassFixer.php
@@ -7,6 +7,7 @@
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\CT;
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 use SplFileInfo;
@@ -47,8 +48,7 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
             }
 
             // ignore class if it's a Doctrine Entity
-            $docToken = $tokens[$tokens->getPrevNonWhitespace($classIndex)];
-            if ($docToken->isGivenKind(\T_DOC_COMMENT) && false !== \mb_strpos($docToken->getContent(), '@ORM\Entity')) {
+            if (self::isDoctrineEntity($tokens, $classIndex)) {
                 continue;
             }
 
@@ -61,4 +61,31 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
             );
         }
     }
+
+    private static function isDoctrineEntity(Tokens $tokens, int $classIndex): bool
+    {
+        $docToken = $tokens[$tokens->getPrevNonWhitespace($classIndex)];
+        if ($docToken->isGivenKind(\T_DOC_COMMENT) && false !== \mb_strpos($docToken->getContent(), '@ORM\Entity')) {
+            return true;
+        }
+
+        while ($classIndex > 0 && $tokens[$tokens->getPrevNonWhitespace($classIndex)]->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
+            $attributeOpenIndex = $tokens->getPrevTokenOfKind($classIndex, [[\T_ATTRIBUTE]]);
+            \assert(null !== $attributeOpenIndex);
+            $content = '';
+            for ($index = $attributeOpenIndex; $index < $classIndex; ++$index) {
+                $content .= $tokens[$index]->getContent();
+            }
+            if (false !== \mb_strpos($content, '#[ORM\Entity]')) {
+                return true;
+            }
+            if (false !== \mb_strpos($content, '#[\Doctrine\ORM\Mapping\Entity')) {
+                return true;
+            }
+
+            $classIndex = $attributeOpenIndex - 1;
+        }
+
+        return false;
+    }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,9 +1,9 @@
 includes:
-    - phar://phpstan.phar/conf/config.level5.neon
     - vendor/phpstan/phpstan-phpunit/extension.neon
     - vendor/slam/phpstan-extensions/conf/slam-rules.neon
 
 parameters:
+    level: 5
     paths:
         - lib/
         - tests/
diff --git a/tests/AbstractFixerTestCase.php b/tests/AbstractFixerTestCase.php
@@ -103,7 +103,7 @@ final protected function doTest($expected, $input = null, ?SplFileInfo $file = n
 
             Tokens::clearCache();
             $expectedTokens = Tokens::fromCode($expected);
-            static::assertTokens($expectedTokens, $tokens);
+            self::assertTokens($expectedTokens, $tokens);
         }
 
         static::assertNull($this->lintSource($expected));
diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -19,8 +19,6 @@
  */
 final class ConfigTest extends TestCase
 {
-    private ?array $setDefinitions;
-
     public function testConfig(): void
     {
         $config = new Config();
@@ -32,6 +30,7 @@ public function testConfig(): void
     public function testAllRulesAreSpecifiedAndDifferentFromRuleSets(): void
     {
         $config      = new Config();
+
         /** @var array<string, mixed> $configRules */
         $configRules           = $config->getRules();
         $ruleSet               = new RuleSet($configRules);
diff --git a/tests/FinalInternalClassFixerTest.php b/tests/FinalInternalClassFixerTest.php
@@ -42,6 +42,15 @@ public function provideCases(): array
             [
                 "<?php\n/**\n * @ORM\\Entity\n */\nclass MyEntity {}",
             ],
+            [
+                "<?php\n#[ORM\\Entity]\nclass MyEntity {}",
+            ],
+            [
+                "<?php\n#[ORM\\Entity]\n#[CustomAttribute]\nclass MyEntity {}",
+            ],
+            [
+                "<?php\n#[\\Doctrine\\ORM\\Mapping\\Entity(repositoryClass: \\MyClass::class)]\nclass MyEntity {}",
+            ],
             [
                 '<?php abstract class MyAbstract {}',
             ],
diff --git a/tests/PhpFileOnlyProxyFixerTest.php b/tests/PhpFileOnlyProxyFixerTest.php
@@ -84,10 +84,10 @@ public function testGetDefinitionIsProxied(): void
 
         $proxy = new PhpFileOnlyProxyFixer($fixer);
 
-        $fixerDefinition = $this->createMock(FixerDefinitionInterface::class);
-        $fixerDefinition->expects(self::once())->method('getSummary')->willReturn($summary = \uniqid('summary'));
-        $fixerDefinition->expects(self::once())->method('getCodeSamples')->willReturn($codeSamples = []);
-        $fixerDefinition->expects(self::once())->method('getDescription')->willReturn($description = \uniqid('description'));
+        $fixerDefinition                                                                                     = $this->createMock(FixerDefinitionInterface::class);
+        $fixerDefinition->expects(self::once())->method('getSummary')->willReturn($summary                   = \uniqid('summary'));
+        $fixerDefinition->expects(self::once())->method('getCodeSamples')->willReturn($codeSamples           = []);
+        $fixerDefinition->expects(self::once())->method('getDescription')->willReturn($description           = \uniqid('description'));
         $fixerDefinition->expects(self::once())->method('getRiskyDescription')->willReturn($riskyDescription = \uniqid('riskyDescription'));
 
         $fixer

Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ final protected function doTest($expected, $input = null, ?SplFileInfo $file = n`
`103`	`103`
`104`	`104`	`Tokens::clearCache();`
`105`	`105`	`$expectedTokens = Tokens::fromCode($expected);`
`106`		`- static::assertTokens($expectedTokens, $tokens);`
	`106`	`+ self::assertTokens($expectedTokens, $tokens);`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`static::assertNull($this->lintSource($expected));`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,6 @@`
`19`	`19`	`*/`
`20`	`20`	`final class ConfigTest extends TestCase`
`21`	`21`	`{`
`22`		`- private ?array $setDefinitions;`
`23`		`-`
`24`	`22`	`public function testConfig(): void`
`25`	`23`	`{`
`26`	`24`	`$config = new Config();`
`@@ -32,6 +30,7 @@ public function testConfig(): void`
`32`	`30`	`public function testAllRulesAreSpecifiedAndDifferentFromRuleSets(): void`
`33`	`31`	`{`
`34`	`32`	`$config = new Config();`
	`33`	`+`
`35`	`34`	`/** @var array<string, mixed> $configRules */`
`36`	`35`	`$configRules = $config->getRules();`
`37`	`36`	`$ruleSet = new RuleSet($configRules);`