Simplify (and always enable Xdebug dead code detection)

sebastianbergmann · Jan 14, 2025 · d4679aa · d4679aa
1 parent 516c847
commit d4679aa
Show file tree

Hide file tree

Showing 8 changed files with 3 additions and 126 deletions.
diff --git a/ChangeLog-12.0.md b/ChangeLog-12.0.md
@@ -11,6 +11,7 @@ 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
 * This component no longer supports Xdebug versions before Xdebug 3.1

diff --git a/src/CodeCoverage.php b/src/CodeCoverage.php
@@ -362,11 +362,6 @@ public function collectsBranchAndPathCoverage(): bool
         return $this->driver->collectsBranchAndPathCoverage();
     }
 
-    public function detectsDeadCode(): bool
-    {
-        return $this->driver->detectsDeadCode();
-    }
-
     public function validate(TargetCollection $targets): ValidationResult
     {
         return (new TargetCollectionValidator)->validate($this->targetMapper(), $targets);

diff --git a/src/Driver/Driver.php b/src/Driver/Driver.php
@@ -12,7 +12,6 @@
 use function sprintf;
 use SebastianBergmann\CodeCoverage\BranchAndPathCoverageNotSupportedException;
 use SebastianBergmann\CodeCoverage\Data\RawCodeCoverageData;
-use SebastianBergmann\CodeCoverage\DeadCodeDetectionNotSupportedException;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -54,7 +53,6 @@ abstract class Driver
      */
     public const int BRANCH_HIT                = 1;
     private bool $collectBranchAndPathCoverage = false;
-    private bool $detectDeadCode               = false;
 
     public function canCollectBranchAndPathCoverage(): bool
     {
@@ -88,38 +86,6 @@ public function disableBranchAndPathCoverage(): void
         $this->collectBranchAndPathCoverage = false;
     }
 
-    public function canDetectDeadCode(): bool
-    {
-        return false;
-    }
-
-    public function detectsDeadCode(): bool
-    {
-        return $this->detectDeadCode;
-    }
-
-    /**
-     * @throws DeadCodeDetectionNotSupportedException
-     */
-    public function enableDeadCodeDetection(): void
-    {
-        if (!$this->canDetectDeadCode()) {
-            throw new DeadCodeDetectionNotSupportedException(
-                sprintf(
-                    '%s does not support dead code detection',
-                    $this->nameAndVersion(),
-                ),
-            );
-        }
-
-        $this->detectDeadCode = true;
-    }
-
-    public function disableDeadCodeDetection(): void
-    {
-        $this->detectDeadCode = false;
-    }
-
     abstract public function nameAndVersion(): string;
 
     abstract public function start(): void;

diff --git a/src/Driver/Selector.php b/src/Driver/Selector.php
@@ -32,11 +32,7 @@ public function forLineCoverage(Filter $filter): Driver
         }
 
         if ($runtime->hasXdebug()) {
-            $driver = new XdebugDriver($filter);
-
-            $driver->enableDeadCodeDetection();
-
-            return $driver;
+            return new XdebugDriver($filter);
         }
 
         throw new NoCodeCoverageDriverAvailableException;
@@ -53,7 +49,6 @@ public function forLineAndPathCoverage(Filter $filter): Driver
         if ((new Runtime)->hasXdebug()) {
             $driver = new XdebugDriver($filter);
 
-            $driver->enableDeadCodeDetection();
             $driver->enableBranchAndPathCoverage();
 
             return $driver;

diff --git a/src/Driver/XdebugDriver.php b/src/Driver/XdebugDriver.php
@@ -82,18 +82,9 @@ public function canCollectBranchAndPathCoverage(): bool
         return true;
     }
 
-    public function canDetectDeadCode(): bool
-    {
-        return true;
-    }
-
     public function start(): void
     {
-        $flags = XDEBUG_CC_UNUSED;
-
-        if ($this->detectsDeadCode() || $this->collectsBranchAndPathCoverage()) {
-            $flags |= XDEBUG_CC_DEAD_CODE;
-        }
+        $flags = XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE;
 
         if ($this->collectsBranchAndPathCoverage()) {
             $flags |= XDEBUG_CC_BRANCH_CHECK;

diff --git a/src/Exception/DeadCodeDetectionNotSupportedException.php b/src/Exception/DeadCodeDetectionNotSupportedException.php
diff --git a/tests/tests/Driver/PcovDriverTest.php b/tests/tests/Driver/PcovDriverTest.php
@@ -13,7 +13,6 @@
 use function extension_loaded;
 use function ini_get;
 use SebastianBergmann\CodeCoverage\BranchAndPathCoverageNotSupportedException;
-use SebastianBergmann\CodeCoverage\DeadCodeDetectionNotSupportedException;
 use SebastianBergmann\CodeCoverage\Filter;
 use SebastianBergmann\CodeCoverage\TestCase;
 
@@ -60,32 +59,6 @@ public function testBranchAndPathCoverageIsNotCollected(): void
         $this->assertFalse($this->driver()->collectsBranchAndPathCoverage());
     }
 
-    public function testDoesNotSupportDeadCodeDetection(): void
-    {
-        $this->assertFalse($this->driver()->canDetectDeadCode());
-    }
-
-    public function testDeadCodeDetectionCanBeDisabled(): void
-    {
-        $driver = $this->driver();
-
-        $driver->disableDeadCodeDetection();
-
-        $this->assertFalse($driver->detectsDeadCode());
-    }
-
-    public function testDeadCodeDetectionCannotBeEnabled(): void
-    {
-        $this->expectException(DeadCodeDetectionNotSupportedException::class);
-
-        $this->driver()->enableDeadCodeDetection();
-    }
-
-    public function testDeadCodeIsNotDetected(): void
-    {
-        $this->assertFalse($this->driver()->detectsDeadCode());
-    }
-
     public function testHasNameAndVersion(): void
     {
         $this->assertStringMatchesFormat('PCOV %s', $this->driver()->nameAndVersion());

diff --git a/tests/tests/Driver/XdebugDriverTest.php b/tests/tests/Driver/XdebugDriverTest.php
@@ -66,34 +66,6 @@ public function testBranchAndPathCoverageIsNotCollectedByDefault(): void
         $this->assertFalse($this->driver()->collectsBranchAndPathCoverage());
     }
 
-    public function testSupportsDeadCodeDetection(): void
-    {
-        $this->assertTrue($this->driver()->canDetectDeadCode());
-    }
-
-    public function testDeadCodeDetectionCanBeDisabled(): void
-    {
-        $driver = $this->driver();
-
-        $driver->disableDeadCodeDetection();
-
-        $this->assertFalse($driver->detectsDeadCode());
-    }
-
-    public function testDeadCodeDetectionCanBeEnabled(): void
-    {
-        $driver = $this->driver();
-
-        $driver->enableDeadCodeDetection();
-
-        $this->assertTrue($driver->detectsDeadCode());
-    }
-
-    public function testDeadCodeIsNotDetectedByDefault(): void
-    {
-        $this->assertFalse($this->driver()->detectsDeadCode());
-    }
-
     public function testHasNameAndVersion(): void
     {
         $this->assertStringMatchesFormat('Xdebug %s', $this->driver()->nameAndVersion());