Merge pull request #1 from jrfnl/feature/test-is-bs-simplification

PSR2/UseDeclaration: simplify the fix

src/Standards/PSR2/Sniffs/Namespaces/UseDeclarationSniff.php

@@ -138,17 +138,32 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $end = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1));
-        $candidateComment = $end;
+        if ($end === false) {
+            return;
+        }
+
+        // Find either the start of the next line or the beginning of the next statement,
+        // whichever comes first.
+        for ($end = ++$end; $end < $phpcsFile->numTokens; $end++) {
+            if (isset(Tokens::$emptyTokens[$tokens[$end]['code']]) === false) {
+                break;
+            }
 
-        do {
-            $nextComment      = $candidateComment;
-            $candidateComment = $phpcsFile->findNext(Tokens::$emptyTokens, ($nextComment + 1));
-        } while ($candidateComment !== false && $tokens[$candidateComment]['line'] === $tokens[$end]['line']);
+            if ($tokens[$end]['column'] === 1) {
+                // Reached the next line.
+                break;
+            }
+        }
 
-        $end = $nextComment;
+        --$end;
 
-        if ($end === false) {
-            return;
+        if (($tokens[$end]['code'] === T_COMMENT
+            || isset(Tokens::$phpcsCommentTokens[$tokens[$end]['code']]) === true)
+            && substr($tokens[$end]['content'], 0, 2) === '/*'
+            && substr($tokens[$end]['content'], -2) !== '*/'
+        ) {
+            // Multi-line block comments are not allowed as trailing comment after a use statement.
+            --$end;
         }
 
         $next = $phpcsFile->findNext(T_WHITESPACE, ($end + 1), null, true);

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.11.inc

@@ -0,0 +1,2 @@
+<?php
+use Foo\Bar; class Baz {}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.11.inc.fixed

@@ -0,0 +1,4 @@
+<?php
+use Foo\Bar; 
+
+class Baz {}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.12.inc

@@ -0,0 +1,9 @@
+<?php
+use Foo\Bar; /*
+ * This multi-line comment shouldn't be allowed here.
+ */
+
+class Baz
+{
+
+}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.12.inc.fixed

@@ -0,0 +1,11 @@
+<?php
+use Foo\Bar; 
+
+/*
+ * This multi-line comment shouldn't be allowed here.
+ */
+
+class Baz
+{
+
+}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.13.inc

@@ -0,0 +1,10 @@
+<?php
+use Foo\Bar; // trailing comment
+/*
+ * This multi-line comment shouldn't be allowed here.
+ */
+
+class Baz
+{
+
+}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.13.inc.fixed

@@ -0,0 +1,11 @@
+<?php
+use Foo\Bar; // trailing comment
+
+/*
+ * This multi-line comment shouldn't be allowed here.
+ */
+
+class Baz
+{
+
+}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.14.inc

@@ -0,0 +1,8 @@
+<?php
+use Foo\Bar; // trailing comment
+/* phpcs:ignore Standard.Category.Sniff -- for reasons */
+
+class Baz
+{
+
+}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.14.inc.fixed

@@ -0,0 +1,9 @@
+<?php
+use Foo\Bar; // trailing comment
+
+/* phpcs:ignore Standard.Category.Sniff -- for reasons */
+
+class Baz
+{
+
+}

src/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.php

@@ -50,6 +50,10 @@ public function getErrorList($testFile='')
                 19 => 1,
             ];
         case 'UseDeclarationUnitTest.10.inc':
+        case 'UseDeclarationUnitTest.11.inc':
+        case 'UseDeclarationUnitTest.12.inc':
+        case 'UseDeclarationUnitTest.13.inc':
+        case 'UseDeclarationUnitTest.14.inc':
             return [2 => 1];
         default:
             return [];