Revert "Remove deprecated methods"

This reverts commit b25c249.
sebastianbergmann · Feb 6, 2025 · 0f52179 · 0f52179
1 parent 8aa25b8
commit 0f52179
Show file tree

Hide file tree

Showing 7 changed files with 384 additions and 2 deletions.
diff --git a/ChangeLog-12.0.md b/ChangeLog-12.0.md
@@ -10,7 +10,6 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 
 ### Removed
 
-* Methods `CodeCoverage::includeUncoveredFiles()` and `CodeCoverage::excludeUncoveredFiles()`
 * Method `CodeCoverage::detectsDeadCode()`
 * Optional argument `$linesToBeUsed` of `CodeCoverage::stop()` and `CodeCoverage::append()` methods
 * This component is no longer supported on PHP 8.2

diff --git a/src/CodeCoverage.php b/src/CodeCoverage.php
@@ -49,6 +49,7 @@ final class CodeCoverage
     private readonly Filter $filter;
     private ?Mapper $targetMapper                    = null;
     private bool $checkForUnintentionallyCoveredCode = false;
+    private bool $includeUncoveredFiles              = true;
     private bool $ignoreDeprecatedCode               = false;
     private ?string $currentId                       = null;
     private ?TestSize $currentSize                   = null;
@@ -121,7 +122,9 @@ public function filter(): Filter
     public function getData(bool $raw = false): ProcessedCodeCoverageData
     {
         if (!$raw) {
-            $this->addUncoveredFilesFromFilter();
+            if ($this->includeUncoveredFiles) {
+                $this->addUncoveredFilesFromFilter();
+            }
         }
 
         return $this->data;
@@ -287,6 +290,16 @@ public function disableCheckForUnintentionallyCoveredCode(): void
         $this->checkForUnintentionallyCoveredCode = false;
     }
 
+    public function includeUncoveredFiles(): void
+    {
+        $this->includeUncoveredFiles = true;
+    }
+
+    public function excludeUncoveredFiles(): void
+    {
+        $this->includeUncoveredFiles = false;
+    }
+
     public function enableAnnotationsForIgnoringCode(): void
     {
         $this->useAnnotationsForIgnoringCode = true;

diff --git a/tests/_files/NamespacedBankAccount-text-with-colors.txt b/tests/_files/NamespacedBankAccount-text-with-colors.txt
@@ -0,0 +1,14 @@
+
+
+[1;37;40mCode Coverage Report:  [0m
+[1;37;40m  %s  [0m
+[1;37;40m                       [0m
+[1;37;40m Summary:              [0m
+[37;41m  Classes:  0.00% (0/1)[0m
+[30;43m  Methods: 75.00% (3/4)[0m
+[30;43m  Lines:   62.50% (5/8)[0m
+
+SomeNamespace\BankAccount
+  [30;42mMethods:  ( 0/ 0)[0m   [30;42mLines:  (  0/  0)[0m
+SomeNamespace\BankAccountTrait
+  [30;43mMethods:  75.00% ( 3/ 4)[0m   [30;43mLines:  62.50% (  5/  8)[0m
diff --git a/tests/_files/NamespacedBankAccount-text.txt b/tests/_files/NamespacedBankAccount-text.txt
@@ -0,0 +1,14 @@
+
+
+Code Coverage Report:
+  %s
+
+ Summary:
+  Classes:  0.00% (0/1)
+  Methods: 75.00% (3/4)
+  Lines:   62.50% (5/8)
+
+SomeNamespace\BankAccount
+  Methods:  ( 0/ 0)   Lines:  (  0/  0)
+SomeNamespace\BankAccountTrait
+  Methods:  75.00% ( 3/ 4)   Lines:  62.50% (  5/  8)
diff --git a/tests/_files/NamespacedBankAccount.php b/tests/_files/NamespacedBankAccount.php
@@ -0,0 +1,38 @@
+<?php
+namespace SomeNamespace;
+class BankAccount
+{
+    use BankAccountTrait;
+}
+
+trait BankAccountTrait {
+    protected $balance = 0;
+
+    public function getBalance()
+    {
+        return $this->balance;
+    }
+
+    protected function setBalance($balance)
+    {
+        if ($balance >= 0) {
+            $this->balance = $balance;
+        } else {
+            throw new \RuntimeException;
+        }
+    }
+
+    public function depositMoney($balance)
+    {
+        $this->setBalance($this->getBalance() + $balance);
+
+        return $this->getBalance();
+    }
+
+    public function withdrawMoney($balance)
+    {
+        $this->setBalance($this->getBalance() - $balance);
+
+        return $this->getBalance();
+    }
+}
diff --git a/tests/src/TestCase.php b/tests/src/TestCase.php
@@ -18,6 +18,7 @@
 use SebastianBergmann\CodeCoverage\Driver\Driver;
 use SebastianBergmann\CodeCoverage\Test\Target\Target;
 use SebastianBergmann\CodeCoverage\Test\Target\TargetCollection;
+use SomeNamespace\BankAccountTrait;
 
 abstract class TestCase extends \PHPUnit\Framework\TestCase
 {
@@ -1182,6 +1183,127 @@ protected function getPathCoverageForSourceWithoutNamespace(): CodeCoverage
         return $coverage;
     }
 
+    protected function getXdebugDataForNamespacedBankAccount()
+    {
+        return [
+            RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+                TEST_FILES_PATH . 'NamespacedBankAccount.php' => [
+                    13 => 1,
+                    14 => -2,
+                    18 => -1,
+                    19 => -1,
+                    20 => -1,
+                    21 => -1,
+                    23 => -1,
+                    27 => -1,
+                    29 => -1,
+                    30 => -2,
+                    34 => -1,
+                    36 => -1,
+                    37 => -2,
+                ],
+            ]),
+            RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+                TEST_FILES_PATH . 'NamespacedBankAccount.php' => [
+                    13 => 1,
+                    18 => 1,
+                    21 => 1,
+                    34 => 1,
+                ],
+            ]),
+            RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+                TEST_FILES_PATH . 'NamespacedBankAccount.php' => [
+                    13 => 1,
+                    18 => 1,
+                    21 => 1,
+                    27 => 1,
+                ],
+            ]),
+            RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+                TEST_FILES_PATH . 'NamespacedBankAccount.php' => [
+                    13 => 1,
+                    18 => 1,
+                    19 => 1,
+                    20 => 1,
+                    23 => 1,
+                    27 => 1,
+                    29 => 1,
+                    34 => 1,
+                    36 => 1,
+                ],
+            ]),
+        ];
+    }
+
+    protected function getLineCoverageForNamespacedBankAccount(): CodeCoverage
+    {
+        $data = $this->getXdebugDataForNamespacedBankAccount();
+
+        $stub = $this->createStub(Driver::class);
+
+        $stub->method('stop')
+            ->willReturn(...$data);
+
+        $filter = new Filter;
+        $filter->includeFile(TEST_FILES_PATH . 'NamespacedBankAccount.php');
+
+        $coverage = new CodeCoverage($stub, $filter);
+
+        $coverage->start(
+            'BankAccountTest::testBalanceIsInitiallyZero',
+            null,
+            true,
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccountTrait::class, 'getBalance'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testBalanceCannotBecomeNegative',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccountTrait::class, 'withdrawMoney'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testBalanceCannotBecomeNegative2',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccountTrait::class, 'depositMoney'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testDepositWithdrawMoney',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccountTrait::class, 'getBalance'),
+                Target::forMethod(BankAccountTrait::class, 'depositMoney'),
+                Target::forMethod(BankAccountTrait::class, 'withdrawMoney'),
+            ]),
+        );
+
+        return $coverage;
+    }
+
     protected function getLineCoverageForBankAccountForFirstTwoTests(): CodeCoverage
     {
         $data = $this->getLineCoverageXdebugDataForBankAccount();
@@ -1791,4 +1913,146 @@ protected function removeTemporaryFiles(): void
             $fileInfo->isDir() ? rmdir($pathname) : unlink($pathname);
         }
     }
+
+    protected function getCoverageForFilesWithUncoveredIncluded(): CodeCoverage
+    {
+        $data = $this->getLineCoverageXdebugDataForBankAccount();
+
+        $stub = $this->createStub(Driver::class);
+
+        $stub->method('stop')
+            ->willReturn(...$data);
+
+        $filter = new Filter;
+        $filter->includeFile(TEST_FILES_PATH . 'BankAccount.php');
+        $filter->includeFile(TEST_FILES_PATH . 'NamespacedBankAccount.php');
+
+        $coverage = new CodeCoverage($stub, $filter);
+        $coverage->includeUncoveredFiles();
+
+        $coverage->start(
+            'BankAccountTest::testBalanceIsInitiallyZero',
+            null,
+            true,
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'getBalance'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testBalanceCannotBecomeNegative',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'withdrawMoney'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testBalanceCannotBecomeNegative2',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'depositMoney'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testDepositWithdrawMoney',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'getBalance'),
+                Target::forMethod(BankAccount::class, 'depositMoney'),
+                Target::forMethod(BankAccount::class, 'withdrawMoney'),
+            ]),
+        );
+
+        return $coverage;
+    }
+
+    protected function getCoverageForFilesWithUncoveredExcluded(): CodeCoverage
+    {
+        $data = $this->getLineCoverageXdebugDataForBankAccount();
+
+        $stub = $this->createStub(Driver::class);
+
+        $stub->method('stop')
+            ->willReturn(...$data);
+
+        $filter = new Filter;
+        $filter->includeFile(TEST_FILES_PATH . 'BankAccount.php');
+        $filter->includeFile(TEST_FILES_PATH . 'NamespacedBankAccount.php');
+
+        $coverage = new CodeCoverage($stub, $filter);
+        $coverage->excludeUncoveredFiles();
+
+        $coverage->start(
+            'BankAccountTest::testBalanceIsInitiallyZero',
+            null,
+            true,
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'getBalance'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testBalanceCannotBecomeNegative',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'withdrawMoney'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testBalanceCannotBecomeNegative2',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'depositMoney'),
+            ]),
+        );
+
+        $coverage->start(
+            'BankAccountTest::testDepositWithdrawMoney',
+        );
+
+        $coverage->stop(
+            true,
+            null,
+            TargetCollection::fromArray([
+                Target::forMethod(BankAccount::class, 'getBalance'),
+                Target::forMethod(BankAccount::class, 'depositMoney'),
+                Target::forMethod(BankAccount::class, 'withdrawMoney'),
+            ]),
+        );
+
+        return $coverage;
+    }
 }