fix: Add support for single-line docblocks with covers annotation

Author: Stephan Wentz

composer.json

@@ -49,7 +49,10 @@
     },
     "config": {
         "preferred-install": "dist",
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     },
     "extra": {
         "branch-alias": {

phpstan.neon.dist

@@ -9,5 +9,5 @@ parameters:
 	paths:
 		- src
 		- tests
-	excludes_analyse:
+	excludePaths:
 		- %currentWorkingDirectory%/tests/Fixture

src/CoversAnnotationRule.php

@@ -63,6 +63,12 @@ public function processNode(Node $node, Scope $scope): array
                 $hasCovers = true;
                 break;
             }
+
+            $lineHasCovers = (bool) preg_match('/^(?:\s*\/\*\*\s*@(?:covers|coversDefaultClass)\h+)\\\\?(?<className>\w[^:\s]*)(?:::\S+)?\s*\*\/\s*$/u', $lineContent, $matches);
+            if ($lineHasCovers) {
+                $hasCovers = true;
+                break;
+            }
         }
 
         if ($isUnitTest && !$hasCovers) {

src/CoversExistsRule.php

@@ -71,7 +71,9 @@ public function processNode(Node $node, Scope $scope): array
             $matches = [];
 
             if (! preg_match('/^(?:\s*\*\s*@(?:covers|coversDefaultClass)\h+)\\\\?(?<className>\w[^:\s]*)(?:::\S+)?\s*$/u', $lineContent, $matches)) {
-                continue;
+                if (! preg_match('/^(?:\s*\/\*\*\s*@(?:covers|coversDefaultClass)\h+)\\\\?(?<className>\w[^:\s]*)(?:::\S+)?\s*\*\/\s*$/u', $lineContent, $matches)) {
+                    continue;
+                }
             }
 
             if ($this->broker->hasClass($matches['className'])) {

tests/CoversExistsRuleTest.php

@@ -19,6 +19,7 @@ public function testRule(): void
         $this->analyse([__DIR__ . '/Fixture/CoversExistsRule/fixture.php'], [
             ['Class BrainbitsPhpStan\Tests\Fixture\CoversExistsRule\Invalid does not exist.', 32],
             ['Class BrainbitsPhpStan\Tests\Fixture\CoversExistsRule\Invalid does not exist.', 33],
+            ['Class BrainbitsPhpStan\Tests\Fixture\CoversExistsRule\Invalid does not exist.', 58],
         ]);
     }
 

tests/Fixture/CoversAnnotationRule/Unit/fixture-with-unit.php

@@ -33,3 +33,18 @@ final class WithInvalidCoversTest extends TestCase
 final class UnitWithValidCoversTest extends TestCase
 {
 }
+
+/** @covers \BrainbitsPhpStan\Tests\Fixture\CoversAnnotationRule\JustAClass */
+final class SingleLineClassUnitWithValidCoversTest extends TestCase
+{
+}
+
+/** @covers \BrainbitsPhpStan\Tests\Fixture\CoversAnnotationRule\JustAClass::test */
+final class SingleLineMethodUnitWithValidCoversTest extends TestCase
+{
+}
+
+/** @covers \BrainbitsPhpStan\Tests\Fixture\CoversAnnotationRule\Invalid::test */
+final class SingleLineMethodUnitWithInvalidCoversTest extends TestCase
+{
+}

tests/Fixture/CoversExistsRule/fixture.php

@@ -44,3 +44,23 @@ final class WithInvalidCoversTest extends TestCase
 final class UnitWithValidCoversTest extends TestCase
 {
 }
+
+/** @covers \BrainbitsPhpStan\Tests\Fixture\CoversExistsRule\Valid */
+final class SingleLineValidClassUnitWithValidCoversTest extends TestCase
+{
+}
+
+/** @covers \BrainbitsPhpStan\Tests\Fixture\CoversExistsRule\Valid::validMethod */
+final class SingleLineValidMethodUnitWithValidCoversTest extends TestCase
+{
+}
+
+/** @covers \BrainbitsPhpStan\Tests\Fixture\CoversExistsRule\Invalid::invalid */
+final class SingleLineInvalidClassUnitWithInvalidCoversTest extends TestCase
+{
+}
+
+/** @covers \BrainbitsPhpStan\Tests\Fixture\CoversExistsRule\Valid::invalidMethod */
+final class SingleLineInvalidMethodUnitWithValidCoversTest extends TestCase
+{
+}