Merge pull request #79 from kubawerlos/upgrades

Deprecate PhpdocVarAnnotationCorrectOrderFixer

Author: kubawerlos

.travis.yml

@@ -29,6 +29,7 @@ jobs:
         - php: '7.2'
           env: COMPOSER_FLAGS="--prefer-lowest"
         - php: '7.2'
+        - php: '7.3'
           install: composer require --dev php-coveralls/php-coveralls
           script: composer phpunit -- --coverage-clover=build/logs/clover.xml
           after_success: vendor/bin/php-coveralls

CHANGELOG.md

@@ -1,7 +1,9 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
 ## [Unreleased]
+- Update PHP CS Fixer to v2.14
 - OperatorLinebreakFixer - respect no whitespace around operator
+- Deprecate PhpdocVarAnnotationCorrectOrderFixer
 
 ## v1.12.0 - *2018-12-02*
 - Add NoCommentedOutCodeFixer

README.md

@@ -296,8 +296,8 @@ In your PHP CS Fixer configuration register fixers and use them:
  }
 ```
 
-- **PhpdocVarAnnotationCorrectOrderFixer** - `@var` annotation must have type and name in the correct order.  
-  *To be deprecated after [this](https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/3881) is merged and released.*
+- **PhpdocVarAnnotationCorrectOrderFixer** - `@var` and `@type` annotations must have type and name in the correct order.  
+  DEPRECATED: use `phpdoc_var_annotation_correct_order` instead.
 ```diff
  <?php
 -/** @var $foo int */

composer.json

@@ -17,7 +17,7 @@
         "php": "^7.1",
         "ext-json": "*",
         "ext-tokenizer": "*",
-        "friendsofphp/php-cs-fixer": "^2.13"
+        "friendsofphp/php-cs-fixer": "^2.14"
     },
     "require-dev": {
         "johnkary/phpunit-speedtrap": "^3.0",

src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php

@@ -77,7 +77,6 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     public function getPriority(): int
     {
         // must be run before NoEmptyCommentFixer, NoEmptyPhpdocFixer, NoExtraBlankLinesFixer, NoTrailingWhitespaceFixer, NoUnusedImportsFixer and NoWhitespaceInBlankLineFixer
-        // must be after PhpdocVarAnnotationCorrectOrderFixer
         return 6;
     }
 

src/Fixer/PhpdocVarAnnotationCorrectOrderFixer.php

@@ -4,68 +4,53 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
-use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
-use PhpCsFixer\Preg;
-use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 
-final class PhpdocVarAnnotationCorrectOrderFixer extends AbstractFixer implements DeprecatingFixerInterface
+/**
+ * @deprecated use "phpdoc_var_annotation_correct_order" instead
+ */
+final class PhpdocVarAnnotationCorrectOrderFixer extends AbstractFixer implements DeprecatedFixerInterface
 {
+    /** @var \PhpCsFixer\Fixer\Phpdoc\PhpdocVarAnnotationCorrectOrderFixer */
+    private $fixer;
+
+    public function __construct()
+    {
+        $this->fixer = new \PhpCsFixer\Fixer\Phpdoc\PhpdocVarAnnotationCorrectOrderFixer();
+    }
+
     public function getDefinition(): FixerDefinition
     {
-        return new FixerDefinition(
-            '`@var` annotation must have type and name in the correct order.',
-            [new CodeSample('<?php
-/** @var $foo int */
-$foo = 2 + 2;
-')]
-        );
+        return $this->fixer->getDefinition();
     }
 
     public function isCandidate(Tokens $tokens): bool
     {
-        return $tokens->isTokenKindFound(T_DOC_COMMENT);
+        return $this->fixer->isCandidate($tokens);
     }
 
     public function isRisky(): bool
     {
-        return false;
+        return $this->fixer->isRisky();
     }
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
-        foreach ($tokens as $index => $token) {
-            if (!$token->isGivenKind(T_DOC_COMMENT)) {
-                continue;
-            }
-
-            if (\stripos($token->getContent(), '@var') === false) {
-                continue;
-            }
-
-            $newContent = Preg::replace(
-                '/(@var\s*)(\$[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)(\s+)([^\$](?:[^<\s]|<[^>]*>)*)(\s|\*)/i',
-                '$1$4$3$2$5',
-                $token->getContent()
-            );
-
-            if ($newContent === $token->getContent()) {
-                continue;
-            }
-
-            $tokens[$index] = new Token([$token->getId(), $newContent]);
-        }
+        $this->fixer->fix($file, $tokens);
     }
 
     public function getPriority(): int
     {
-        // must be before PhpdocNoIncorrectVarAnnotationFixer
-        return 7;
+        return $this->fixer->getPriority();
     }
 
-    public function getPullRequestId(): int
+    /**
+     * @return string[]
+     */
+    public function getSuccessorsNames(): array
     {
-        return 3881;
+        return [$this->fixer->getName()];
     }
 }

tests/Fixer/PhpdocNoIncorrectVarAnnotationFixerTest.php

@@ -10,7 +10,6 @@
 use PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer;
 use PhpCsFixer\Fixer\Whitespace\NoTrailingWhitespaceFixer;
 use PhpCsFixer\Fixer\Whitespace\NoWhitespaceInBlankLineFixer;
-use PhpCsFixerCustomFixers\Fixer\PhpdocVarAnnotationCorrectOrderFixer;
 
 /**
  * @internal
@@ -27,7 +26,6 @@ public function testPriority(): void
         static::assertGreaterThan((new NoTrailingWhitespaceFixer())->getPriority(), $this->fixer->getPriority());
         static::assertGreaterThan((new NoUnusedImportsFixer())->getPriority(), $this->fixer->getPriority());
         static::assertGreaterThan((new NoWhitespaceInBlankLineFixer())->getPriority(), $this->fixer->getPriority());
-        static::assertLessThan((new PhpdocVarAnnotationCorrectOrderFixer())->getPriority(), $this->fixer->getPriority());
     }
 
     public function testIsRisky(): void

tests/Fixer/PhpdocVarAnnotationCorrectOrderFixerTest.php

@@ -4,8 +4,6 @@
 
 namespace Tests\Fixer;
 
-use PhpCsFixerCustomFixers\Fixer\PhpdocNoIncorrectVarAnnotationFixer;
-
 /**
  * @internal
  *
@@ -15,17 +13,17 @@ final class PhpdocVarAnnotationCorrectOrderFixerTest extends AbstractFixerTestCa
 {
     public function testPriority(): void
     {
-        static::assertGreaterThan((new PhpdocNoIncorrectVarAnnotationFixer())->getPriority(), $this->fixer->getPriority());
+        static::assertSame(0, $this->fixer->getPriority());
     }
 
     public function testIsRisky(): void
     {
         static::assertFalse($this->fixer->isRisky());
     }
 
-    public function testDeprecatingPullRequest(): void
+    public function testSuccessorName(): void
     {
-        static::assertSame(3881, $this->fixer->getPullRequestId());
+        static::assertContains('phpdoc_var_annotation_correct_order', $this->fixer->getSuccessorsNames());
     }
 
     /**