Added more tests and fixes

Added cases with names with namespace separator and some cases
with comments

Author: michalbundyra

src/Standards/PSR2/Sniffs/Classes/ClassDeclarationSniff.php

@@ -168,15 +168,32 @@ public function processOpen(File $phpcsFile, $stackPtr)
                     $fix   = $phpcsFile->addFixableError($error, $keyword, ucfirst($keywordType).'Line', $data);
                     if ($fix === true) {
                         $phpcsFile->fixer->beginChangeset();
-                        for ($i = ($stackPtr + 1); $i < $keyword; $i++) {
-                            if ($tokens[$i]['line'] !== $tokens[($i + 1)]['line']) {
-                                $phpcsFile->fixer->substrToken($i, 0, (strlen($phpcsFile->eolChar) * -1));
+                        $comments = [];
+
+                        for ($i = ($stackPtr + 1); $i < $keyword; ++$i) {
+                            if ($tokens[$i]['code'] === T_COMMENT) {
+                                $comments[] = trim($tokens[$i]['content']);
+                            }
+
+                            if ($tokens[$i]['code'] === T_WHITESPACE
+                                || $tokens[$i]['code'] === T_COMMENT
+                            ) {
+                                $phpcsFile->fixer->replaceToken($i, ' ');
+                            }
+                        }
+
+                        $phpcsFile->fixer->addContent($stackPtr, ' ');
+                        if (empty($comments) === false) {
+                            $i = $keyword;
+                            while ($tokens[($i + 1)]['line'] === $tokens[$keyword]['line']) {
+                                ++$i;
                             }
+
+                            $phpcsFile->fixer->addContentBefore($i, ' '.implode(' ', $comments));
                         }
 
-                        $phpcsFile->fixer->addContentBefore($keyword, ' ');
                         $phpcsFile->fixer->endChangeset();
-                    }
+                    }//end if
                 } else {
                     // Check the whitespace before. Whitespace after is checked
                     // later by looking at the whitespace before the first class name
@@ -228,19 +245,28 @@ public function processOpen(File $phpcsFile, $stackPtr)
             $nextClass    = $phpcsFile->findNext($find, ($nextClass + 1), ($openingBrace - 1));
         }
 
+        $skip = array_merge(
+            Tokens::$emptyTokens,
+            [
+                T_STRING,
+                T_NS_SEPARATOR,
+            ]
+        );
+
         $classCount         = count($classNames);
         $checkingImplements = false;
         $implementsToken    = null;
-        $numberOfInterface  = 0;
+        $oneInterface       = false;
         foreach ($classNames as $n => $className) {
             if ($tokens[$className]['code'] === $keywordTokenType) {
                 $checkingImplements = true;
                 $implementsToken    = $className;
-                continue;
-            }
 
-            if ($checkingImplements === true) {
-                $numberOfInterface += 1;
+                if (false === $phpcsFile->findNext($skip, ($implementsToken + 1), ($openingBrace - 1), true)) {
+                    $oneInterface = true;
+                }
+
+                continue;
             }
 
             if ($checkingImplements === true
@@ -302,15 +328,39 @@ public function processOpen(File $phpcsFile, $stackPtr)
                         $phpcsFile->fixer->addNewline($prev);
                         $phpcsFile->fixer->endChangeset();
                     }
-                } else if ($n === ($classCount - 1) && $numberOfInterface === 1) {
-                    $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($className - 1), $implements, true);
-                    if ($tokens[$prev]['line'] !== $tokens[$className]['line']) {
+                } else if ($oneInterface === true) {
+                    if ($tokens[$implementsToken]['line'] !== $tokens[$className]['line']) {
                         $error = 'Interface name should be in the same line as '.$keywordType.' keyword';
                         $fix   = $phpcsFile->addFixableError($error, $className, 'InterfaceWrongLine');
                         if ($fix === true) {
-                            $phpcsFile->fixer->replaceToken(($prev + 1), ' ');
-                        }
-                    }
+                            $phpcsFile->fixer->beginChangeset();
+                            $comments = [];
+
+                            for ($i = ($implementsToken + 1); $i < $className; ++$i) {
+                                if ($tokens[$i]['code'] === T_COMMENT) {
+                                    $comments[] = trim($tokens[$i]['content']);
+                                }
+
+                                if ($tokens[$i]['code'] === T_WHITESPACE
+                                    || $tokens[$i]['code'] === T_COMMENT
+                                ) {
+                                    $phpcsFile->fixer->replaceToken($i, '');
+                                }
+                            }
+
+                            $phpcsFile->fixer->addContent($implementsToken, ' ');
+                            if (empty($comments) === false) {
+                                $i = $className;
+                                while ($tokens[($i + 1)]['line'] === $tokens[$className]['line']) {
+                                    ++$i;
+                                }
+
+                                $phpcsFile->fixer->addContentBefore($i, ' '.implode(' ', $comments));
+                            }
+
+                            $phpcsFile->fixer->endChangeset();
+                        }//end if
+                    }//end if
                 } else {
                     $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($className - 1), $implements);
                     if ($tokens[$prev]['line'] !== $tokens[$className]['line']) {
@@ -321,7 +371,7 @@ public function processOpen(File $phpcsFile, $stackPtr)
 
                     $expected = ($classIndent + $this->indent);
                     if ($found !== $expected) {
-                        $error = 'Expected %s spaces before interface name; %s found';
+                        $error = 'Expected %s spaces before interface name; %s found - '.$n.' :: '.$classCount;
                         $data  = [
                             $expected,
                             $found,

src/Standards/PSR2/Tests/Classes/ClassDeclarationUnitTest.inc

@@ -205,3 +205,29 @@ class C5 extends Foo implements
  Baz
 {
 }
+
+class C6 extends \Foo\Bar implements
+  \Baz\Bar
+{
+}
+
+interface I4 extends
+  \Baz
+  \Bar
+{
+}
+
+interface I5 extends /* comment */
+    \Foo\Bar
+{
+}
+
+interface I6 extends // comment
+    \Foo\Bar
+{
+}
+
+class C7 extends // comment
+    \Foo\Bar implements \Baz\Bar
+{
+}

src/Standards/PSR2/Tests/Classes/ClassDeclarationUnitTest.inc.fixed

@@ -197,3 +197,23 @@ class C5 extends Foo implements
     Baz
 {
 }
+
+class C6 extends \Foo\Bar implements \Baz\Bar
+{
+}
+
+interface I4 extends \Baz\Bar
+{
+}
+
+interface I5 extends \Foo\Bar /* comment */
+{
+}
+
+interface I6 extends \Foo\Bar // comment
+{
+}
+
+class C7 extends \Foo\Bar implements \Baz\Bar // comment
+{
+}

src/Standards/PSR2/Tests/Classes/ClassDeclarationUnitTest.php

@@ -60,6 +60,12 @@ public function getErrorList()
             199 => 1,
             204 => 1,
             205 => 1,
+            210 => 1,
+            215 => 2,
+            216 => 1,
+            221 => 1,
+            226 => 1,
+            231 => 2,
         ];
 
     }//end getErrorList()