Remove @var without type at the beginning in PhpdocNoIncorrectVarAnnotationFixer (#21)

* Remove @var without type at the beginning in PhpdocNoIncorrectVarAnnotationFixer

* Travis fix

* Travis fix

Author: kubawerlos

.travis.yml

@@ -67,7 +67,7 @@ jobs:
                 - cp tests/Fixer/* tmp/tests/Fixer/CustomFixers
                 - rm tmp/tests/Fixer/CustomFixers/AbstractFixerTestCase.php
                 - sed -i -- 's/namespace Tests\\Fixer;/namespace PhpCsFixer\\Tests\\Fixer\\CustomFixers;use PhpCsFixer\\Tests\\Test\\AbstractFixerTestCase;/g' tmp/tests/Fixer/CustomFixers/*
-                - sed -i -- 's/@covers \\PhpCsFixerCustomFixers\\Fixer/@covers \\PhpCsFixer\\Fixer\CustomFixers/g' tmp/tests/Fixer/CustomFixers/*
+                - sed -i -- 's/PhpCsFixerCustomFixers\\Fixer/PhpCsFixer\\Fixer\\CustomFixers/g' tmp/tests/Fixer/CustomFixers/*
                 # prepare for testing
                 - cd tmp
                 - php php-cs-fixer fix src/Fixer/CustomFixers

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [Unreleased]
 - Add PhpdocVarAnnotationCorrectOrderFixer
+- Remove @var without type at the beginning in PhpdocNoIncorrectVarAnnotationFixer
 
 ## v1.2.0 - 2018-06-03
 - Add PhpdocNoIncorrectVarAnnotationFixer

src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php

@@ -39,10 +39,13 @@ public function fix(\SplFileInfo $file, Tokens $tokens) : void
                 continue;
             }
 
+            // remove ones not having type at the beginning
+            $this->removeVarAnnotationNotMatchingPattern($tokens, $index, '/@var\s+[\\\\a-zA-Z_\x7f-\xff]/');
+
             $nextIndex = $tokens->getNextMeaningfulToken($index);
 
             if ($nextIndex === null) {
-                $this->removeVarAnnotation($tokens, $index);
+                $this->removeVarAnnotationNotMatchingPattern($tokens, $index, null);
                 continue;
             }
 
@@ -60,37 +63,32 @@ public function fix(\SplFileInfo $file, Tokens $tokens) : void
                 continue;
             }
 
-            $this->removeVarAnnotation($tokens, $index);
+            $this->removeVarAnnotationNotMatchingPattern($tokens, $index, null);
         }
     }
 
     public function getPriority() : int
     {
-        // should be run before NoEmptyCommentFixer, NoEmptyPhpdocFixer, NoExtraBlankLinesFixer, NoTrailingWhitespaceFixer, NoUnusedImportsFixer and NoWhitespaceInBlankLineFixer
+        // must be run before NoEmptyCommentFixer, NoEmptyPhpdocFixer, NoExtraBlankLinesFixer, NoTrailingWhitespaceFixer, NoUnusedImportsFixer and NoWhitespaceInBlankLineFixer
+        // must be after PhpdocVarAnnotationCorrectOrderFixer
         return 6;
     }
 
-    private function removeVarAnnotation(Tokens $tokens, int $index, array $allowedVariables = []) : void
+    private function removeVarAnnotation(Tokens $tokens, int $index, array $allowedVariables) : void
     {
-        $doc = new DocBlock($tokens[$index]->getContent());
-
-        foreach ($doc->getAnnotationsOfType(['var']) as $annotation) {
-            $allowedVariablesQuoted = \array_map(
-                static function (string $variable) : string {
-                    return \preg_quote($variable, '/') . '\b';
-                },
-                $allowedVariables
-            );
-            if ($allowedVariables === [] || \preg_match(\sprintf('/%s/i', \implode('|', $allowedVariablesQuoted)), $annotation->getContent()) !== 1) {
-                $annotation->remove();
-            }
-        }
-
-        if ($doc->getContent() === '') {
-            $tokens->clearTokenAndMergeSurroundingWhitespace($index);
-        } else {
-            $tokens[$index] = new Token([$tokens[$index]->getId(), $doc->getContent()]);
-        }
+        $this->removeVarAnnotationNotMatchingPattern(
+            $tokens,
+            $index,
+            '/' . \implode(
+                '|',
+                \array_map(
+                    static function (string $variable) : string {
+                        return \preg_quote($variable, '/') . '\b';
+                    },
+                    $allowedVariables
+                )
+            ) . '/i'
+        );
     }
 
     private function removeVarAnnotationForControl(Tokens $tokens, int $commentIndex, int $controlIndex) : void
@@ -110,4 +108,21 @@ private function removeVarAnnotationForControl(Tokens $tokens, int $commentIndex
 
         $this->removeVarAnnotation($tokens, $commentIndex, $variables);
     }
+
+    private function removeVarAnnotationNotMatchingPattern(Tokens $tokens, int $index, ?string $pattern) : void
+    {
+        $doc = new DocBlock($tokens[$index]->getContent());
+
+        foreach ($doc->getAnnotationsOfType(['var']) as $annotation) {
+            if ($pattern === null || \preg_match($pattern, $annotation->getContent()) !== 1) {
+                $annotation->remove();
+            }
+        }
+
+        if ($doc->getContent() === '') {
+            $tokens->clearTokenAndMergeSurroundingWhitespace($index);
+        } else {
+            $tokens[$index] = new Token([$tokens[$index]->getId(), $doc->getContent()]);
+        }
+    }
 }

src/Fixer/PhpdocVarAnnotationCorrectOrderFixer.php

@@ -54,6 +54,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens) : void
 
     public function getPriority() : int
     {
-        return 0;
+        // must be before PhpdocNoIncorrectVarAnnotationFixer
+        return 7;
     }
 }

tests/Fixer/PhpdocNoIncorrectVarAnnotationFixerTest.php

@@ -10,6 +10,7 @@
 use PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer;
 use PhpCsFixer\Fixer\Whitespace\NoTrailingWhitespaceFixer;
 use PhpCsFixer\Fixer\Whitespace\NoWhitespaceInBlankLineFixer;
+use PhpCsFixerCustomFixers\Fixer\PhpdocVarAnnotationCorrectOrderFixer;
 
 /**
  * @internal
@@ -26,6 +27,7 @@ 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());
     }
 
     /**
@@ -48,6 +50,13 @@ public function provideFixCases() : \Iterator
 ',
         ];
 
+        yield [
+            '<?php
+/** @var \Foo $foo */
+$foo = new Foo();
+',
+        ];
+
         yield [
             '<?php
 
@@ -59,6 +68,16 @@ public function provideFixCases() : \Iterator
 ',
         ];
 
+        yield [
+            '<?php
+$bar = new Logger();
+',
+            '<?php
+/** @var $bar */
+$bar = new Logger();
+',
+        ];
+
         yield [
             '<?php
 /**
@@ -143,6 +162,47 @@ class Foo
      */
     private $d;
 }
+',
+        ];
+
+        yield [
+            '<?php
+class Foo
+{
+    
+    static $a;
+
+    /*
+     */
+    public $b;
+
+    
+    protected $c;
+
+    /**
+     */
+    private $d;
+}
+',
+            '<?php
+class Foo
+{
+    /* @var */
+    static $a;
+
+    /*
+     * @var
+     */
+    public $b;
+
+    /** @var */
+    protected $c;
+
+    /**
+     * @var
+     */
+    private $d;
+}
 ',
         ];
     }

tests/Fixer/PhpdocVarAnnotationCorrectOrderFixerTest.php

@@ -4,6 +4,8 @@
 
 namespace Tests\Fixer;
 
+use PhpCsFixerCustomFixers\Fixer\PhpdocNoIncorrectVarAnnotationFixer;
+
 /**
  * @internal
  *
@@ -13,7 +15,7 @@ final class PhpdocVarAnnotationCorrectOrderFixerTest extends AbstractFixerTestCa
 {
     public function testPriority() : void
     {
-        static::assertSame(0, $this->fixer->getPriority());
+        static::assertGreaterThan((new PhpdocNoIncorrectVarAnnotationFixer())->getPriority(), $this->fixer->getPriority());
     }
 
     /**