Add support for targeting traits

sebastianbergmann · sebastianbergmann · commit 30b614244b02 · 2025-01-28T11:09:07.000+01:00
diff --git a/src/Target/MapBuilder.php b/src/Target/MapBuilder.php
@@ -181,6 +181,7 @@ public function build(Filter $filter, FileAnalyser $analyser): array
 
         return [
             'namespaces'                    => $namespaces,
+            'traits'                        => $traits,
             'classes'                       => $classes,
             'classesThatExtendClass'        => $classesThatExtendClass,
             'classesThatImplementInterface' => $classesThatImplementInterface,
diff --git a/src/Target/Mapper.php b/src/Target/Mapper.php
@@ -13,7 +13,7 @@
 use function array_unique;
 
 /**
- * @phpstan-type TargetMap array{namespaces: TargetMapPart, classes: TargetMapPart, classesThatExtendClass: TargetMapPart, classesThatImplementInterface: TargetMapPart, methods: TargetMapPart, functions: TargetMapPart, reverseLookup: ReverseLookup}
+ * @phpstan-type TargetMap array{namespaces: TargetMapPart, traits: TargetMapPart, classes: TargetMapPart, classesThatExtendClass: TargetMapPart, classesThatImplementInterface: TargetMapPart, methods: TargetMapPart, functions: TargetMapPart, reverseLookup: ReverseLookup}
  * @phpstan-type TargetMapPart array<non-empty-string, array<non-empty-string, list<positive-int>>>
  * @phpstan-type ReverseLookup array<non-empty-string, non-empty-string>
  *
diff --git a/src/Target/Target.php b/src/Target/Target.php
@@ -65,6 +65,14 @@ public static function forFunction(string $functionName): Function_
         return new Function_($functionName);
     }
 
+    /**
+     * @param trait-string $traitName
+     */
+    public static function forTrait(string $traitName): Trait_
+    {
+        return new Trait_($traitName);
+    }
+
     public function isNamespace(): bool
     {
         return false;
@@ -95,6 +103,11 @@ public function isFunction(): bool
         return false;
     }
 
+    public function isTrait(): bool
+    {
+        return false;
+    }
+
     /**
      * @return non-empty-string
      */
diff --git a/src/Target/Trait_.php b/src/Target/Trait_.php
@@ -0,0 +1,68 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of phpunit/php-code-coverage.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\CodeCoverage\Test\Target;
+
+/**
+ * @immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage
+ */
+final class Trait_ extends Target
+{
+    /**
+     * @var trait-string
+     */
+    private string $traitName;
+
+    /**
+     * @param trait-string $traitName
+     */
+    protected function __construct(string $traitName)
+    {
+        $this->traitName = $traitName;
+    }
+
+    public function isTrait(): true
+    {
+        return true;
+    }
+
+    /**
+     * @return trait-string
+     */
+    public function traitName(): string
+    {
+        return $this->traitName;
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function key(): string
+    {
+        return 'traits';
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function target(): string
+    {
+        return $this->traitName;
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function description(): string
+    {
+        return 'Trait ' . $this->target();
+    }
+}
diff --git a/tests/tests/Target/MapBuilderTest.php b/tests/tests/Target/MapBuilderTest.php
@@ -57,6 +57,11 @@ public function testBuildsMap(): void
                         ),
                     ],
                 ],
+                'traits' => [
+                    'SebastianBergmann\\CodeCoverage\\StaticAnalysis\\T' => [
+                        $file => range(19, 24),
+                    ],
+                ],
                 'classes' => [
                     'SebastianBergmann\\CodeCoverage\\StaticAnalysis\\ParentClass' => [
                         $file => range(26, 31),
diff --git a/tests/tests/Target/MapperTest.php b/tests/tests/Target/MapperTest.php
@@ -20,6 +20,7 @@
 use PHPUnit\Framework\TestCase;
 use SebastianBergmann\CodeCoverage\Filter;
 use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingFileAnalyser;
+use SebastianBergmann\CodeCoverage\TestFixture\Target\TraitOne;
 
 /**
  * @phpstan-import-type TargetMap from Mapper
@@ -83,6 +84,16 @@ public static function provider(): array
                     ],
                 ),
             ],
+            'trait' => [
+                [
+                    realpath(__DIR__ . '/../../_files/Target/TraitOne.php') => range(4, 9),
+                ],
+                TargetCollection::fromArray(
+                    [
+                        Target::forTrait(TraitOne::class),
+                    ],
+                ),
+            ],
             'function' => [
                 [
                     $file => range(54, 56),
@@ -93,7 +104,7 @@ public static function provider(): array
                     ],
                 ),
             ],
-            'method' => [
+            'method of class' => [
                 [
                     $file => range(37, 39),
                 ],
@@ -103,7 +114,7 @@ public static function provider(): array
                     ],
                 ),
             ],
-            'methods' => [
+            'methods of class' => [
                 [
                     $file => array_merge(range(37, 39), range(41, 43)),
                 ],
@@ -114,6 +125,16 @@ public static function provider(): array
                     ],
                 ),
             ],
+            'method of trait' => [
+                [
+                    $file => range(21, 23),
+                ],
+                TargetCollection::fromArray(
+                    [
+                        Target::forMethod('SebastianBergmann\\CodeCoverage\\StaticAnalysis\\T', 'four'),
+                    ],
+                ),
+            ],
             'namespace' => [
                 [
                     $file => array_merge(
diff --git a/tests/tests/Target/TargetTest.php b/tests/tests/Target/TargetTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use SebastianBergmann\CodeCoverage\TestFixture\Target\TargetClass;
 use SebastianBergmann\CodeCoverage\TestFixture\Target\TargetInterface;
+use SebastianBergmann\CodeCoverage\TestFixture\Target\TraitOne;
 
 #[CoversClass(Target::class)]
 #[CoversClass(Class_::class)]
@@ -22,6 +23,7 @@
 #[CoversClass(Function_::class)]
 #[CoversClass(Method::class)]
 #[CoversClass(Namespace_::class)]
+#[CoversClass(Trait_::class)]
 #[Small]
 final class TargetTest extends TestCase
 {
@@ -37,6 +39,7 @@ public function testCanBeClass(): void
         $this->assertFalse($target->isFunction());
         $this->assertFalse($target->isMethod());
         $this->assertFalse($target->isNamespace());
+        $this->assertFalse($target->isTrait());
 
         $this->assertSame($className, $target->className());
         $this->assertSame('classes', $target->key());
@@ -56,6 +59,7 @@ public function testCanBeClassesThatExtendClass(): void
         $this->assertFalse($target->isFunction());
         $this->assertFalse($target->isMethod());
         $this->assertFalse($target->isNamespace());
+        $this->assertFalse($target->isTrait());
 
         $this->assertSame($className, $target->className());
         $this->assertSame('classesThatExtendClass', $target->key());
@@ -75,6 +79,7 @@ public function testCanBeClassesThatImplementInterface(): void
         $this->assertFalse($target->isFunction());
         $this->assertFalse($target->isMethod());
         $this->assertFalse($target->isNamespace());
+        $this->assertFalse($target->isTrait());
 
         $this->assertSame($interfaceName, $target->interfaceName());
         $this->assertSame('classesThatImplementInterface', $target->key());
@@ -94,6 +99,7 @@ public function testCanBeFunction(): void
         $this->assertTrue($target->isFunction());
         $this->assertFalse($target->isMethod());
         $this->assertFalse($target->isNamespace());
+        $this->assertFalse($target->isTrait());
 
         $this->assertSame($functionName, $target->functionName());
         $this->assertSame('functions', $target->key());
@@ -114,6 +120,7 @@ public function testCanBeMethod(): void
         $this->assertFalse($target->isFunction());
         $this->assertTrue($target->isMethod());
         $this->assertFalse($target->isNamespace());
+        $this->assertFalse($target->isTrait());
 
         $this->assertSame($className, $target->className());
         $this->assertSame($methodName, $target->methodName());
@@ -134,10 +141,31 @@ public function testCanBeNamespace(): void
         $this->assertFalse($target->isFunction());
         $this->assertFalse($target->isMethod());
         $this->assertTrue($target->isNamespace());
+        $this->assertFalse($target->isTrait());
 
         $this->assertSame($namespace, $target->namespace());
         $this->assertSame('namespaces', $target->key());
         $this->assertSame($namespace, $target->target());
         $this->assertSame('Namespace ' . $namespace, $target->description());
     }
+
+    public function testCanBeTrait(): void
+    {
+        $traitName = TraitOne::class;
+
+        $target = Target::forTrait($traitName);
+
+        $this->assertTrue($target->isTrait());
+        $this->assertFalse($target->isClass());
+        $this->assertFalse($target->isClassesThatExtendClass());
+        $this->assertFalse($target->isClassesThatImplementInterface());
+        $this->assertFalse($target->isFunction());
+        $this->assertFalse($target->isMethod());
+        $this->assertFalse($target->isNamespace());
+
+        $this->assertSame($traitName, $target->traitName());
+        $this->assertSame('traits', $target->key());
+        $this->assertSame($traitName, $target->target());
+        $this->assertSame('Trait ' . $traitName, $target->description());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`use function array_unique;`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * @phpstan-type TargetMap array{namespaces: TargetMapPart, classes: TargetMapPart, classesThatExtendClass: TargetMapPart, classesThatImplementInterface: TargetMapPart, methods: TargetMapPart, functions: TargetMapPart, reverseLookup: ReverseLookup}`
	`16`	`+ * @phpstan-type TargetMap array{namespaces: TargetMapPart, traits: TargetMapPart, classes: TargetMapPart, classesThatExtendClass: TargetMapPart, classesThatImplementInterface: TargetMapPart, methods: TargetMapPart, functions: TargetMapPart, reverseLookup: ReverseLookup}`
`17`	`17`	`* @phpstan-type TargetMapPart array<non-empty-string, array<non-empty-string, list<positive-int>>>`
`18`	`18`	`* @phpstan-type ReverseLookup array<non-empty-string, non-empty-string>`
`19`	`19`	`*`