Closes #1033

sebastianbergmann · Mar 12, 2024 · 316534a · 316534a
1 parent c0fe94b
commit 316534a
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 0 deletions.
diff --git a/ChangeLog-10.1.md b/ChangeLog-10.1.md
@@ -2,6 +2,12 @@
 
 All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## [10.1.14] - 2024-MM-DD
+
+### Fixed
+
+* [#1033](https://github.com/sebastianbergmann/php-code-coverage/issues/1033): `@codeCoverageIgnore` annotation does not work on `enum`
+
 ## [10.1.13] - 2024-03-09
 
 ### Changed
@@ -95,6 +101,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 
 * The `SebastianBergmann\CodeCoverage\Filter::includeDirectory()`, `SebastianBergmann\CodeCoverage\Filter::excludeDirectory()`, and `SebastianBergmann\CodeCoverage\Filter::excludeFile()` methods are now deprecated
 
+[10.1.13]: https://github.com/sebastianbergmann/php-code-coverage/compare/10.1.13...10.1
 [10.1.13]: https://github.com/sebastianbergmann/php-code-coverage/compare/10.1.12...10.1.13
 [10.1.12]: https://github.com/sebastianbergmann/php-code-coverage/compare/10.1.11...10.1.12
 [10.1.11]: https://github.com/sebastianbergmann/php-code-coverage/compare/10.1.10...10.1.11

diff --git a/src/StaticAnalysis/IgnoredLinesFindingVisitor.php b/src/StaticAnalysis/IgnoredLinesFindingVisitor.php
@@ -15,6 +15,7 @@
 use PhpParser\Node\Attribute;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Enum_;
 use PhpParser\Node\Stmt\Function_;
 use PhpParser\Node\Stmt\Interface_;
 use PhpParser\Node\Stmt\Trait_;
@@ -43,6 +44,7 @@ public function enterNode(Node $node): void
  if (!$node instanceof Class_ &&
  !$node instanceof Trait_ &&
  !$node instanceof Interface_ &&
+ !$node instanceof Enum_ &&
  !$node instanceof ClassMethod &&
  !$node instanceof Function_ &&
  !$node instanceof Attribute) {

diff --git a/tests/_files/source_with_enum_and_enum_level_ignore_annotation.php b/tests/_files/source_with_enum_and_enum_level_ignore_annotation.php
@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+/**
+ * @codeCoverageIgnore
+ */
+enum TestEnumeration
+{
+ case SomeCase;
+
+ public function isSomeCase(): bool
+ {
+ return $this === self::SomeCase;
+ }
+}
diff --git a/tests/_files/source_with_enum_and_method_level_ignore_annotation.php b/tests/_files/source_with_enum_and_method_level_ignore_annotation.php
@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+enum TestEnumeration
+{
+ case SomeCase;
+
+ /**
+ * @codeCoverageIgnore
+ */
+ public function isSomeCase(): bool
+ {
+ return $this === self::SomeCase;
+ }
+}
diff --git a/tests/tests/StaticAnalysis/ParsingFileAnalyserTest.php b/tests/tests/StaticAnalysis/ParsingFileAnalyserTest.php
@@ -9,7 +9,9 @@
  */
 namespace SebastianBergmann\CodeCoverage\StaticAnalysis;
 
+use function range;
 use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Ticket;
 use PHPUnit\Framework\TestCase;
 
 #[CoversClass(CodeUnitFindingVisitor::class)]
@@ -165,4 +167,26 @@ public function testLinesCanBeIgnoredUsingAttribute(): void
  ),
  );
  }
+
+ #[Ticket('https://github.com/sebastianbergmann/php-code-coverage/issues/1033')]
+ public function testEnumWithEnumLevelIgnore(): void
+ {
+ $this->assertSame(
+ range(5, 13),
+ (new ParsingFileAnalyser(true, true))->ignoredLinesFor(
+ TEST_FILES_PATH . 'source_with_enum_and_enum_level_ignore_annotation.php',
+ ),
+ );
+ }
+
+ #[Ticket('https://github.com/sebastianbergmann/php-code-coverage/issues/1033')]
+ public function testEnumWithMethodLevelIgnore(): void
+ {
+ $this->assertSame(
+ range(9, 12),
+ (new ParsingFileAnalyser(true, true))->ignoredLinesFor(
+ TEST_FILES_PATH . 'source_with_enum_and_method_level_ignore_annotation.php',
+ ),
+ );
+ }
 }