Closes #5513

sebastianbergmann · Sep 16, 2023 · 20032ed · 20032ed
1 parent 4449996
commit 20032ed
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 5 deletions.
diff --git a/.psalm/baseline.xml b/.psalm/baseline.xml
@@ -526,6 +526,13 @@
       <code>trim($tmp[1])</code>
     </ArgumentTypeCoercion>
   </file>
+  <file src="src/Metadata/Parser/AttributeParser.php">
+    <DeprecatedClass>
+      <code>IgnoreClassForCodeCoverage::class</code>
+      <code>IgnoreFunctionForCodeCoverage::class</code>
+      <code>IgnoreMethodForCodeCoverage::class</code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Metadata/Version/Requirement.php">
     <ArgumentTypeCoercion>
       <code><![CDATA[!empty($matches['operator']) ? $matches['operator'] : '>=']]></code>

diff --git a/ChangeLog-10.4.md b/ChangeLog-10.4.md
@@ -17,11 +17,13 @@ All notable changes of the PHPUnit 10.4 release series are documented in this fi
 * The name of the top-level test suite that is created when a directory or file path is passed as an argument to the test runner is now `CLI Arguments`
 * Simplified the failure description for `assertInstanceOf()` and `assertNotInstanceOf()`
 * Simplified the failure description for `assertJson()`
+* The `@codeCoverageIgnore`, `@codeCoverageIgnoreStart`, and `@codeCoverageIgnoreEnd` annotations are no longer deprecated
 
 ### Deprecated
 
 * [#5472](https://github.com/sebastianbergmann/phpunit/issues/5472): `TestCase::assertStringNotMatchesFormat()` and `TestCase::assertStringNotMatchesFormatFile()` (these methods only have a `@deprecated` annotation for now; using these methods will trigger a deprecation warning in PHPUnit 11; these methods will be removed in PHPUnit 12)
 * [#5481](https://github.com/sebastianbergmann/phpunit/issues/5481): `dataSet` attribute for `testCaseMethod` elements in the XML document generated by `--list-tests-xml` (the attribute will not be generated anymore starting with PHPUnit 11)
+* [#5513](https://github.com/sebastianbergmann/phpunit/issues/5513): `IgnoreClassForCodeCoverage`, `IgnoreMethodForCodeCoverage`, and `IgnoreFunctionForCodeCoverage` attributes (these attributes will be removed in PHPUnit 11)
 * `PHPUnit\TextUI\Configuration\Configuration::cliArgument()` and `PHPUnit\TextUI\Configuration\Configuration::hasCliArgument()`
 
 [10.4.0]: https://github.com/sebastianbergmann/phpunit/compare/10.3...main
diff --git a/DEPRECATIONS.md b/DEPRECATIONS.md
@@ -45,11 +45,14 @@ This functionality is currently [soft-deprecated](https://phpunit.de/backward-co
 
 #### Miscellaneous
 
-| Issue                                                             | Description                                         | Since  | Replacement |
-|-------------------------------------------------------------------|-----------------------------------------------------|--------|-------------|
-| [#5236](https://github.com/sebastianbergmann/phpunit/issues/5236) | `PHPUnit\Framework\Attributes\CodeCoverageIgnore()` | 10.1.0 |             |
-| [#5214](https://github.com/sebastianbergmann/phpunit/issues/5214) | `TestCase::iniSet()`                                | 10.3.0 |             |
-| [#5216](https://github.com/sebastianbergmann/phpunit/issues/5216) | `TestCase::setLocale()`                             | 10.3.0 |             |
+| Issue                                                             | Description                                                    | Since  | Replacement                                                        |
+|-------------------------------------------------------------------|----------------------------------------------------------------|--------|--------------------------------------------------------------------|
+| [#5236](https://github.com/sebastianbergmann/phpunit/issues/5236) | `PHPUnit\Framework\Attributes\CodeCoverageIgnore()`            | 10.1.0 |                                                                    |
+| [#5214](https://github.com/sebastianbergmann/phpunit/issues/5214) | `TestCase::iniSet()`                                           | 10.3.0 |                                                                    |
+| [#5216](https://github.com/sebastianbergmann/phpunit/issues/5216) | `TestCase::setLocale()`                                        | 10.3.0 |                                                                    |
+| [#5236](https://github.com/sebastianbergmann/phpunit/issues/5513) | `PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage()`    | 10.4.0 | Use `@codeCoverageIgnore` annotation in the class' doc-comment     |
+| [#5236](https://github.com/sebastianbergmann/phpunit/issues/5513) | `PHPUnit\Framework\Attributes\IgnoreMethodForCodeCoverage()`   | 10.4.0 | Use `@codeCoverageIgnore` annotation in the method's doc-comment   |
+| [#5236](https://github.com/sebastianbergmann/phpunit/issues/5513) | `PHPUnit\Framework\Attributes\IgnoreFunctionForCodeCoverage()` | 10.4.0 | Use `@codeCoverageIgnore` annotation in the function's doc-comment |
 
 ### Running Tests
 

diff --git a/src/Framework/Attributes/IgnoreClassForCodeCoverage.php b/src/Framework/Attributes/IgnoreClassForCodeCoverage.php
@@ -15,6 +15,8 @@
  * @psalm-immutable
  *
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated https://github.com/sebastianbergmann/phpunit/issues/5513
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
 final class IgnoreClassForCodeCoverage

diff --git a/src/Framework/Attributes/IgnoreFunctionForCodeCoverage.php b/src/Framework/Attributes/IgnoreFunctionForCodeCoverage.php
@@ -15,6 +15,8 @@
  * @psalm-immutable
  *
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated https://github.com/sebastianbergmann/phpunit/issues/5513
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
 final class IgnoreFunctionForCodeCoverage

diff --git a/src/Framework/Attributes/IgnoreMethodForCodeCoverage.php b/src/Framework/Attributes/IgnoreMethodForCodeCoverage.php
@@ -15,6 +15,8 @@
  * @psalm-immutable
  *
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated https://github.com/sebastianbergmann/phpunit/issues/5513
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
 final class IgnoreMethodForCodeCoverage