🐛 Fix for doc comment string with space

Vincent Langlet · Vincent Langlet · commit 1ab9e6d9049b · 2017-07-01T16:10:24.000+02:00
diff --git a/Symfony3Custom/Sniffs/Namespaces/UnusedUseSniff.php b/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),
diff --git a/Symfony3Custom/Tests/Namespaces/UnusedUseUnitTest.inc b/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;
     }
 }
diff --git a/Symfony3Custom/Tests/Namespaces/UnusedUseUnitTest.inc.fixed b/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;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ use Truc;`
`10`	`10`	`use Machin;`
`11`	`11`	`use Machine;`
`12`	`12`	`use Unused;`
	`13`	`+use Client;`
`13`	`14`
`14`	`15`	`class Container`
`15`	`16`	`{`
`@@ -18,12 +19,14 @@ class Container`
`18`	`19`	`* @Route("/{id}")`
`19`	`20`	`* @ORM\Column(type="integer")`
`20`	`21`	`*`
`21`		`- * @param Toto`
`22`		`- * @var Truc`
	`22`	`+ * @param Toto $toto`
	`23`	`+ * @var Truc $truc`
`23`	`24`	`* @return Machin\|Machine`
`24`	`25`	`*/`
`25`	`26`	`function test (Bar $bar)`
`26`	`27`	`{`
	`28`	`+ /** @var Client $client */`
	`29`	`+`
`27`	`30`	`return;`
`28`	`31`	`}`
`29`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ use ORM;`
`9`	`9`	`use Truc;`
`10`	`10`	`use Machin;`
`11`	`11`	`use Machine;`
	`12`	`+use Client;`
`12`	`13`
`13`	`14`	`class Container`
`14`	`15`	`{`
`@@ -17,12 +18,14 @@ class Container`
`17`	`18`	`* @Route("/{id}")`
`18`	`19`	`* @ORM\Column(type="integer")`
`19`	`20`	`*`
`20`		`- * @param Toto`
`21`		`- * @var Truc`
	`21`	`+ * @param Toto $toto`
	`22`	`+ * @var Truc $truc`
`22`	`23`	`* @return Machin\|Machine`
`23`	`24`	`*/`
`24`	`25`	`function test (Bar $bar)`
`25`	`26`	`{`
	`27`	`+ /** @var Client $client */`
	`28`	`+`
`26`	`29`	`return;`
`27`	`30`	`}`
`28`	`31`	`}`