🐛 Fix DocCommentGroupSameType for @route, @Assert, etc

Author: Vincent Langlet

Symfony3Custom/Sniffs/Commenting/DocCommentGroupSameTypeSniff.php

@@ -31,6 +31,7 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
         $previousType = '';
         foreach ($tokens[$stackPtr]['comment_tags'] as $commentTag) {
             $currentType = $tokens[$commentTag]['content'];
+            $commentTagLine = $tokens[$commentTag]['line'];
 
             $previousString = $phpcsFile->findPrevious(
                 T_DOC_COMMENT_STRING,
@@ -40,10 +41,15 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
             if (false !== $previousString) {
                 $previousStringLine = $tokens[$previousString]['line'];
-                $commentTagLine = $tokens[$commentTag]['line'];
+
+                if (isset($previousTagLine)) {
+                    $previousLine = max($previousStringLine, $previousTagLine);
+                } else {
+                    $previousLine = $previousStringLine;
+                }
 
                 if ($previousType === $currentType) {
-                    if ($previousStringLine !== $commentTagLine - 1) {
+                    if ($previousLine !== $commentTagLine - 1) {
                         $fix = $phpcsFile->addFixableError(
                             'Expected no empty lines '
                             . 'between annotations of the same type',
@@ -56,14 +62,14 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                             $this->removeLines(
                                 $phpcsFile,
                                 $previousString,
-                                $previousStringLine + 1,
+                                $previousLine + 1,
                                 $commentTagLine - 1
                             );
                             $phpcsFile->fixer->endChangeset();
                         }
                     }
                 } else {
-                    if ($previousStringLine !== $commentTagLine - 2) {
+                    if ($previousLine !== $commentTagLine - 2) {
                         $fix = $phpcsFile->addFixableError(
                             'Expected exactly one empty line '
                             . 'between annotations of different types',
@@ -73,7 +79,8 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
                         if ($fix === true) {
                             $phpcsFile->fixer->beginChangeset();
-                            if ($previousStringLine === $commentTagLine - 1) {
+
+                            if ($previousLine === $commentTagLine - 1) {
                                 $firstOnLine = $phpcsFile->findFirstOnLine(
                                     array(),
                                     $commentTag,
@@ -95,7 +102,7 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                                 $this->removeLines(
                                     $phpcsFile,
                                     $previousString,
-                                    $previousStringLine + 2,
+                                    $previousLine + 2,
                                     $commentTagLine - 1
                                 );
                             }
@@ -106,6 +113,7 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
             }
 
             $previousType = $currentType;
+            $previousTagLine = $commentTagLine;
         }
     }
 

Symfony3Custom/Tests/Commenting/DocCommentGroupSameTypeUnitTest.inc

@@ -5,6 +5,7 @@
  * @see http://doc.example.com/
  *
  * @see SomeClass::someMethod()
+ * @Route()
  * @param string $a
  *
  *

Symfony3Custom/Tests/Commenting/DocCommentGroupSameTypeUnitTest.inc.fixed

@@ -6,6 +6,8 @@
  * @see http://doc.example.com/
  * @see SomeClass::someMethod()
  *
+ * @Route()
+ *
  * @param string $a
  * @param string $b
  *

Symfony3Custom/Tests/Commenting/DocCommentGroupSameTypeUnitTest.php

@@ -22,12 +22,13 @@ public function getErrorList()
             5 => 1,
             7 => 1,
             8 => 1,
-            11 => 1,
+            9 => 1,
             12 => 1,
             13 => 1,
-            18 => 1,
-            27 => 1,
-            31 => 1,
+            14 => 1,
+            19 => 1,
+            28 => 1,
+            32 => 1,
         );
     }