Add PhpdocVarAnnotationCorrectOrderFixer

Author: kubawerlos

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## [Unreleased]
+- Add PhpdocVarAnnotationCorrectOrderFixer
+
 ## v1.2.0 - 2018-06-03
 - Add PhpdocNoIncorrectVarAnnotationFixer
 

README.md

@@ -109,6 +109,15 @@ In your PHP CS Fixer configuration register fixers and use them:
 
 ```
 
+- **PhpdocVarAnnotationCorrectOrderFixer** - in `@var` type and variable must be in correct order.
+```diff
+ <?php
+-/** @var $foo int */
++/** @var int $foo */
+ $foo = 2 + 2;
+
+```
+
 
 ## Contributing
 Request a feature or report a bug by creating [issue](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/issues).

src/Fixer/PhpdocVarAnnotationCorrectOrderFixer.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+
+final class PhpdocVarAnnotationCorrectOrderFixer extends AbstractFixer
+{
+    public function getDefinition() : FixerDefinition
+    {
+        return new FixerDefinition(
+            'In `@var` type and variable must be in correct order.',
+            [new CodeSample('<?php
+/** @var $foo int */
+$foo = 2 + 2;
+')]
+        );
+    }
+
+    public function isCandidate(Tokens $tokens) : bool
+    {
+        return $tokens->isAnyTokenKindsFound([T_COMMENT, T_DOC_COMMENT]);
+    }
+
+    public function fix(\SplFileInfo $file, Tokens $tokens) : void
+    {
+        foreach ($tokens as $index => $token) {
+            if (!$token->isGivenKind([T_COMMENT, T_DOC_COMMENT])) {
+                continue;
+            }
+
+            if (\stripos($token->getContent(), '@var') === false) {
+                continue;
+            }
+
+            $newContent = \preg_replace(
+                '/(@var\s*)(\$\S+)(\s+)(\S+)\b/i',
+                '$1$4$3$2',
+                $token->getContent()
+            );
+
+            if ($newContent === $token->getContent()) {
+                continue;
+            }
+
+            $tokens[$index] = new Token([$token->getId(), $newContent]);
+        }
+    }
+
+    public function getPriority() : int
+    {
+        return 0;
+    }
+}

tests/Fixer/PhpdocVarAnnotationCorrectOrderFixerTest.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Tests\Fixer;
+
+/**
+ * @internal
+ *
+ * @covers \PhpCsFixerCustomFixers\Fixer\PhpdocVarAnnotationCorrectOrderFixer
+ */
+final class PhpdocVarAnnotationCorrectOrderFixerTest extends AbstractFixerTestCase
+{
+    public function testPriority() : void
+    {
+        static::assertSame(0, $this->fixer->getPriority());
+    }
+
+    /**
+     * @param string      $expected
+     * @param string|null $input
+     *
+     * @dataProvider provideFixCases
+     */
+    public function testFix(string $expected, string $input = null) : void
+    {
+        $this->doTest($expected, $input);
+    }
+
+    public function provideFixCases() : \Iterator
+    {
+        yield [
+            '<?php
+/** @param $foo Foo */
+',
+        ];
+
+        yield [
+            '<?php
+/** @var Foo $foo */
+',
+        ];
+
+        yield [
+            '<?php
+/**
+ * @var Foo $foo
+ * @var Bar $bar
+ */
+',
+            '<?php
+/**
+ * @var $foo Foo
+ * @var $bar Bar
+ */
+',
+        ];
+
+        yield [
+            '<?php
+/** @var Foo $foo */
+',
+            '<?php
+/** @var $foo Foo */
+',
+        ];
+
+        yield [
+            '<?php
+/**@var Foo $foo*/
+',
+            '<?php
+/**@var $foo Foo*/
+',
+        ];
+
+        yield [
+            '<?php
+/** @Var Foo $foo */
+',
+            '<?php
+/** @Var $foo Foo */
+',
+        ];
+
+        yield [
+            '<?php
+/** @var Foo|Bar|mixed|int $someWeirdLongNAME__123 */
+',
+            '<?php
+/** @var $someWeirdLongNAME__123 Foo|Bar|mixed|int */
+',
+        ];
+    }
+}