minor #4377 CommentsAnalyzer - fix for declare before header comment (kubawerlos)

This PR was squashed before being merged into the 2.15 branch (closes #4377).

Discussion
----------

CommentsAnalyzer - fix for declare before header comment

Commits
-------

b27f23f CommentsAnalyzer - fix for declare before header comment

Author: SpacePossum

php-cs-fixer

@@ -11,10 +11,6 @@
  * with this source code in the file LICENSE.
  */
 
-/**
- * @author Fabien Potencier <fabien@symfony.com>
- * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
- */
 if (getenv('PHP_CS_FIXER_FUTURE_MODE')) {
     error_reporting(-1);
 }

src/Tokenizer/Analyzer/CommentsAnalyzer.php

@@ -40,9 +40,28 @@ public function isHeaderComment(Tokens $tokens, $index)
             throw new \InvalidArgumentException('Given index must point to a comment.');
         }
 
-        $prevIndex = $tokens->getPrevMeaningfulToken($index);
+        if (null === $tokens->getNextMeaningfulToken($index)) {
+            return false;
+        }
+
+        $prevIndex = $tokens->getPrevNonWhitespace($index);
+
+        if ($tokens[$prevIndex]->equals(';')) {
+            $braceCloseIndex = $tokens->getPrevMeaningfulToken($prevIndex);
+            if (!$tokens[$braceCloseIndex]->equals(')')) {
+                return false;
+            }
+
+            $braceOpenIndex = $tokens->findBlockStart(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $braceCloseIndex);
+            $declareIndex = $tokens->getPrevMeaningfulToken($braceOpenIndex);
+            if (!$tokens[$declareIndex]->isGivenKind(T_DECLARE)) {
+                return false;
+            }
+
+            $prevIndex = $tokens->getPrevNonWhitespace($declareIndex);
+        }
 
-        return $tokens[$prevIndex]->isGivenKind(T_OPEN_TAG) && null !== $tokens->getNextMeaningfulToken($index);
+        return $tokens[$prevIndex]->isGivenKind(T_OPEN_TAG);
     }
 
     /**
@@ -224,8 +243,7 @@ private function isValidLanguageConstruct(Tokens $tokens, Token $docsToken, $lan
 
         $endKind = $tokens[$languageConstructIndex]->isGivenKind(CT::T_DESTRUCTURING_SQUARE_BRACE_OPEN)
             ? [CT::T_DESTRUCTURING_SQUARE_BRACE_CLOSE]
-            : ')'
-        ;
+            : ')';
 
         $endIndex = $tokens->getNextTokenOfKind($languageConstructIndex, [$endKind]);
 

tests/Tokenizer/Analyzer/CommentsAnalyzerTest.php

@@ -157,20 +157,54 @@ public function testHeaderCommentAcceptsOnlyComments()
         $analyzer->isHeaderComment($tokens, 2);
     }
 
-    public function testHeaderComment()
+    /**
+     * @param string $code
+     * @param int    $index
+     *
+     * @dataProvider provideHeaderCommentCases
+     */
+    public function testHeaderComment($code, $index)
     {
-        $tokens = Tokens::fromCode('<?php /* This is header */ namespace Foo;');
+        $tokens = Tokens::fromCode($code);
         $analyzer = new CommentsAnalyzer();
 
-        static::assertTrue($analyzer->isHeaderComment($tokens, 1));
+        static::assertTrue($analyzer->isHeaderComment($tokens, $index));
     }
 
-    public function testNotHeaderComment()
+    public function provideHeaderCommentCases()
     {
-        $tokens = Tokens::fromCode('<?php /* This is not header */');
+        return [
+            ['<?php /* Comment */ namespace Foo;', 1],
+            ['<?php /** Comment */ namespace Foo;', 1],
+            ['<?php declare(strict_types=1); /* Comment */ namespace Foo;', 9],
+            ['<?php /* We test this one */ /* Foo */ namespace Bar;', 1],
+        ];
+    }
+
+    /**
+     * @param string $code
+     * @param int    $index
+     *
+     * @dataProvider provideNotHeaderCommentCases
+     */
+    public function testNotHeaderComment($code, $index)
+    {
+        $tokens = Tokens::fromCode($code);
         $analyzer = new CommentsAnalyzer();
 
-        static::assertFalse($analyzer->isHeaderComment($tokens, 1));
+        static::assertFalse($analyzer->isHeaderComment($tokens, $index));
+    }
+
+    public function provideNotHeaderCommentCases()
+    {
+        return [
+            ['<?php $foo; /* Comment */ $bar;', 4],
+            ['<?php foo(); /* Comment */ $bar;', 6],
+            ['<?php namespace Foo; /* Comment */ class Bar {};', 6],
+            ['<?php /* It is not header when no content after */', 1],
+            ['<?php /* Foo */ /* We test this one */ namespace Bar;', 3],
+            ['<?php /* Foo */ declare(strict_types=1); /* We test this one */ namespace Bar;', 11],
+        ];
     }
 
     public function testPhpdocCandidateAcceptsOnlyComments()