🐛 Fix for doc comment string with space

Author: Vincent Langlet

Symfony3Custom/Sniffs/Namespaces/UnusedUseSniff.php

@@ -32,7 +32,6 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
-        //T_DOC_COMMENT_STRING;PHPCS_T_DOC_COMMENT_TAG;
 
         // Only check use statements in the global scope.
         if (empty($tokens[$stackPtr]['conditions']) === false) {
@@ -127,7 +126,7 @@ public function process(File $phpcsFile, $stackPtr)
             }
 
             $classUsed = $phpcsFile->findNext(
-                [T_STRING, T_DOC_COMMENT_STRING, T_RETURN_TYPE],
+                [T_STRING, T_RETURN_TYPE],
                 ($classUsed + 1)
             );
         }
@@ -144,10 +143,20 @@ public function process(File $phpcsFile, $stackPtr)
 
             // Check for @param Truc or @return Machin
             if ('T_DOC_COMMENT_STRING' === $token['type']) {
-                // Handle @return Machin|Machine
-                if (preg_match('/^'.$lowerClassName.'\|/i', $token['content']) === 1
-                || preg_match('/\|'.$lowerClassName.'\|/i', $token['content']) === 1
-                || preg_match('/\|'.$lowerClassName.'$/i', $token['content']) === 1) {
+                if (trim(strtolower($token['content'])) === $lowerClassName
+                    // Handle @return Machin|Machine|AnotherMachin
+                    || preg_match('/^'.$lowerClassName.'\|/i', trim($token['content'])) === 1
+                    || preg_match('/\|'.$lowerClassName.'\|/i', trim($token['content'])) === 1
+                    || preg_match('/\|'.$lowerClassName.'$/i', trim($token['content'])) === 1
+                    // Handle @var Machin $machin
+                    || preg_match('/^'.$lowerClassName.' /i', trim($token['content'])) === 1
+                    // Handle @var $machin Machin
+                    || preg_match('/ '.$lowerClassName.' /i', trim($token['content'])) === 1
+                    || preg_match('/ '.$lowerClassName.'$/i', trim($token['content'])) === 1
+                    // Handle @var Machin|Machine $machin
+                    || preg_match('/\|'.$lowerClassName.' /i', trim($token['content'])) === 1
+                    // Handle @var $machin Machin|Machine
+                    || preg_match('/ '.$lowerClassName.'\|/i', trim($token['content'])) === 1) {
                     $beforeUsage = $phpcsFile->findPrevious(
                         Tokens::$emptyTokens,
                         ($classUsed - 1),

Symfony3Custom/Tests/Namespaces/UnusedUseUnitTest.inc

@@ -10,6 +10,7 @@ use Truc;
 use Machin;
 use Machine;
 use Unused;
+use Client;
 
 class Container
 {
@@ -18,12 +19,14 @@ class Container
      * @Route("/{id}")
      * @ORM\Column(type="integer")
      *
-     * @param Toto
-     * @var Truc
+     * @param Toto $toto
+     * @var Truc $truc
      * @return Machin|Machine
      */
     function test (Bar $bar)
     {
+        /** @var Client $client */
+
         return;
     }
 }

Symfony3Custom/Tests/Namespaces/UnusedUseUnitTest.inc.fixed

@@ -9,6 +9,7 @@ use ORM;
 use Truc;
 use Machin;
 use Machine;
+use Client;
 
 class Container
 {
@@ -17,12 +18,14 @@ class Container
      * @Route("/{id}")
      * @ORM\Column(type="integer")
      *
-     * @param Toto
-     * @var Truc
+     * @param Toto $toto
+     * @var Truc $truc
      * @return Machin|Machine
      */
     function test (Bar $bar)
     {
+        /** @var Client $client */
+
         return;
     }
 }