Skip to content

Commit 4b3424f

Browse files
sebastianbergmannsebastianbergmann
committed
* Rename driver classes
* Replace detectDeadCode($flag) with enableDeadCodeDetection() and disableDeadCodeDetection() * Rename detectingDeadCode() to detectsDeadCode() * Replace collectBranchAndPathCoverage($flag) with enableBranchAndPathCoverage() and disableBranchAndPathCoverage() * Rename collectingBranchAndPathCoverage() to collectsBranchAndPathCoverage()
1 parent 8660835 commit 4b3424f

16 files changed

+185
-261
lines changed

‎src/CodeCoverage.php

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
use PHPUnit\Runner\PhptTestCase;
1414
use PHPUnit\Util\Test;
1515
use SebastianBergmann\CodeCoverage\Driver\Driver;
16-
use SebastianBergmann\CodeCoverage\Driver\PCOV;
17-
use SebastianBergmann\CodeCoverage\Driver\PHPDBG;
18-
use SebastianBergmann\CodeCoverage\Driver\Xdebug;
16+
use SebastianBergmann\CodeCoverage\Driver\PcovDriver;
17+
use SebastianBergmann\CodeCoverage\Driver\PhpdbgDriver;
18+
use SebastianBergmann\CodeCoverage\Driver\XdebugDriver;
1919
use SebastianBergmann\CodeCoverage\Node\Builder;
2020
use SebastianBergmann\CodeCoverage\Node\Directory;
2121
use SebastianBergmann\CodeUnitReverseLookup\Wizard;
@@ -410,9 +410,14 @@ public function setUnintentionallyCoveredSubclassesWhitelist(array $whitelist):
410410
$this->unintentionallyCoveredSubclassesWhitelist = $whitelist;
411411
}
412412

413-
public function setBranchAndPathCollection(bool $flag): void
413+
public function enableBranchAndPathCoverage(): void
414414
{
415-
$this->driver->collectBranchAndPathCoverage($flag);
415+
$this->driver->enableBranchAndPathCoverage();
416+
}
417+
418+
public function disableBranchAndPathCoverage(): void
419+
{
420+
$this->driver->disableBranchAndPathCoverage();
416421
}
417422

418423
/**
@@ -806,15 +811,15 @@ private function selectDriver(Filter $filter): Driver
806811
$runtime = new Runtime;
807812

808813
if ($runtime->hasPHPDBGCodeCoverage()) {
809-
return new PHPDBG;
814+
return new PhpdbgDriver;
810815
}
811816

812817
if ($runtime->hasPCOV()) {
813-
return new PCOV($filter);
818+
return new PcovDriver($filter);
814819
}
815820

816821
if ($runtime->hasXdebug()) {
817-
return new Xdebug($filter);
822+
return new XdebugDriver($filter);
818823
}
819824

820825
throw new RuntimeException('No code coverage driver available');
@@ -859,10 +864,9 @@ private function initializeData(): void
859864
$this->isInitialized = true;
860865

861866
if ($this->processUncoveredFilesFromWhitelist) {
862-
863867
// by collecting dead code data here on an initial pass, future runs with test data do not need to
864868
if ($this->driver->canDetectDeadCode()) {
865-
$this->driver->detectDeadCode(true);
869+
$this->driver->enableDeadCodeDetection();
866870
}
867871

868872
$this->driver->start();
@@ -893,7 +897,7 @@ private function initializeData(): void
893897

894898
// having now collected dead code for the entire whitelist, we can safely skip this data on subsequent runs
895899
if ($this->driver->canDetectDeadCode()) {
896-
$this->driver->detectDeadCode(false);
900+
$this->driver->disableDeadCodeDetection();
897901
}
898902
}
899903
}

‎src/Driver/Driver.php

Lines changed: 35 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313
use SebastianBergmann\CodeCoverage\DeadCodeDetectionNotSupportedException;
1414
use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
1515

16-
/**
17-
* Interface for code coverage drivers.
18-
*/
1916
abstract class Driver
2017
{
2118
/**
@@ -39,67 +36,65 @@ abstract class Driver
3936
*/
4037
public const LINE_NOT_EXECUTABLE = -2;
4138

42-
protected $detectDeadCode = false;
43-
44-
protected $collectBranchAndPathCoverage = false;
45-
4639
/**
47-
* Does this driver support detecting dead code?
40+
* @var bool
4841
*/
49-
abstract public function canDetectDeadCode(): bool;
42+
private $collectBranchAndPathCoverage = false;
5043

5144
/**
52-
* Does this driver support collecting branch and path coverage?
45+
* @var bool
5346
*/
54-
abstract public function canCollectBranchAndPathCoverage(): bool;
47+
private $detectDeadCode = false;
5548

56-
/**
57-
* Detect dead code
58-
*/
59-
public function detectDeadCode(bool $flag): void
49+
public function canCollectBranchAndPathCoverage(): bool
6050
{
61-
if ($flag && !$this->canDetectDeadCode()) {
62-
throw new DeadCodeDetectionNotSupportedException;
63-
}
51+
return false;
52+
}
6453

65-
$this->detectDeadCode = $flag;
54+
public function collectsBranchAndPathCoverage(): bool
55+
{
56+
return $this->collectBranchAndPathCoverage;
6657
}
6758

68-
/**
69-
* Collecting path coverage
70-
*/
71-
public function collectBranchAndPathCoverage(bool $flag): void
59+
public function enableBranchAndPathCoverage(): void
7260
{
73-
if ($flag && !$this->canCollectBranchAndPathCoverage()) {
61+
if (!$this->canCollectBranchAndPathCoverage()) {
7462
throw new BranchAndPathCoverageNotSupportedException;
7563
}
7664

77-
$this->collectBranchAndPathCoverage = $flag;
65+
$this->collectBranchAndPathCoverage = true;
7866
}
7967

80-
/**
81-
* Is this driver detecting dead code?
82-
*/
83-
public function detectingDeadCode(): bool
68+
public function disableBranchAndPathCoverage(): void
69+
{
70+
$this->collectBranchAndPathCoverage = false;
71+
}
72+
73+
public function canDetectDeadCode(): bool
74+
{
75+
return false;
76+
}
77+
78+
public function detectsDeadCode(): bool
8479
{
8580
return $this->detectDeadCode;
8681
}
8782

88-
/**
89-
* Is this driver collecting branch and path coverage?
90-
*/
91-
public function collectingBranchAndPathCoverage(): bool
83+
public function enableDeadCodeDetection(): void
9284
{
93-
return $this->collectBranchAndPathCoverage;
85+
if (!$this->canDetectDeadCode()) {
86+
throw new DeadCodeDetectionNotSupportedException;
87+
}
88+
89+
$this->detectDeadCode = true;
90+
}
91+
92+
public function disableDeadCodeDetection(): void
93+
{
94+
$this->detectDeadCode = false;
9495
}
9596

96-
/**
97-
* Start collection of code coverage information.
98-
*/
9997
abstract public function start(): void;
10098

101-
/**
102-
* Stop collection of code coverage information.
103-
*/
10499
abstract public function stop(): RawCodeCoverageData;
105100
}

‎src/Driver/PCOV.php renamed to ‎src/Driver/PcovDriver.php

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@
1212
use SebastianBergmann\CodeCoverage\Filter;
1313
use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
1414

15-
/**
16-
* Driver for PCOV code coverage functionality.
17-
*/
18-
final class PCOV extends Driver
15+
final class PcovDriver extends Driver
1916
{
2017
/**
2118
* @var Filter
@@ -27,33 +24,11 @@ public function __construct(Filter $filter)
2724
$this->filter = $filter;
2825
}
2926

30-
/**
31-
* Does this driver support detecting dead code?
32-
*/
33-
public function canDetectDeadCode(): bool
34-
{
35-
return false;
36-
}
37-
38-
/**
39-
* Does this driver support collecting path coverage?
40-
*/
41-
public function canCollectBranchAndPathCoverage(): bool
42-
{
43-
return false;
44-
}
45-
46-
/**
47-
* Start collection of code coverage information.
48-
*/
4927
public function start(): void
5028
{
5129
\pcov\start();
5230
}
5331

54-
/**
55-
* Stop collection of code coverage information.
56-
*/
5732
public function stop(): RawCodeCoverageData
5833
{
5934
\pcov\stop();

‎src/Driver/PHPDBG.php renamed to ‎src/Driver/PhpdbgDriver.php

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@
1212
use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
1313
use SebastianBergmann\CodeCoverage\RuntimeException;
1414

15-
/**
16-
* Driver for PHPDBG's code coverage functionality.
17-
*/
18-
final class PHPDBG extends Driver
15+
final class PhpdbgDriver extends Driver
1916
{
2017
/**
2118
* @throws RuntimeException
@@ -35,48 +32,26 @@ public function __construct()
3532
}
3633
}
3734

38-
/**
39-
* Does this driver support detecting dead code?
40-
*/
41-
public function canDetectDeadCode(): bool
42-
{
43-
return false;
44-
}
45-
46-
/**
47-
* Does this driver support collecting path coverage?
48-
*/
49-
public function canCollectBranchAndPathCoverage(): bool
50-
{
51-
return false;
52-
}
53-
54-
/**
55-
* Start collection of code coverage information.
56-
*/
5735
public function start(): void
5836
{
5937
\phpdbg_start_oplog();
6038
}
6139

62-
/**
63-
* Stop collection of code coverage information.
64-
*/
6540
public function stop(): RawCodeCoverageData
6641
{
6742
static $fetchedLines = [];
6843

6944
$dbgData = \phpdbg_end_oplog();
7045

71-
if ($fetchedLines == []) {
46+
if ($fetchedLines === []) {
7247
$sourceLines = \phpdbg_get_executable();
7348
} else {
7449
$newFiles = \array_diff(\get_included_files(), \array_keys($fetchedLines));
7550

7651
$sourceLines = [];
7752

7853
if ($newFiles) {
79-
$sourceLines = phpdbg_get_executable(['files' => $newFiles]);
54+
$sourceLines = \phpdbg_get_executable(['files' => $newFiles]);
8055
}
8156
}
8257

@@ -91,9 +66,6 @@ public function stop(): RawCodeCoverageData
9166
return RawCodeCoverageData::fromXdebugWithoutPathCoverage($this->detectExecutedLines($fetchedLines, $dbgData));
9267
}
9368

94-
/**
95-
* Convert phpdbg based data into the format CodeCoverage expects
96-
*/
9769
private function detectExecutedLines(array $sourceLines, array $dbgData): array
9870
{
9971
foreach ($dbgData as $file => $coveredLines) {

‎src/Driver/Xdebug.php renamed to ‎src/Driver/XdebugDriver.php

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,7 @@
1313
use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
1414
use SebastianBergmann\CodeCoverage\RuntimeException;
1515

16-
/**
17-
* Driver for Xdebug's code coverage functionality.
18-
*/
19-
final class Xdebug extends Driver
16+
final class XdebugDriver extends Driver
2017
{
2118
/**
2219
* @throws RuntimeException
@@ -32,53 +29,42 @@ public function __construct(Filter $filter)
3229
}
3330

3431
\xdebug_set_filter(\XDEBUG_FILTER_CODE_COVERAGE, \XDEBUG_PATH_WHITELIST, $filter->getWhitelist());
35-
$this->detectDeadCode = true;
32+
33+
$this->enableDeadCodeDetection();
3634
}
3735

38-
/**
39-
* Does this driver support detecting dead code?
40-
*/
41-
public function canDetectDeadCode(): bool
36+
public function canCollectBranchAndPathCoverage(): bool
4237
{
4338
return true;
4439
}
4540

46-
/**
47-
* Does this driver support collecting path coverage?
48-
*/
49-
public function canCollectBranchAndPathCoverage(): bool
41+
public function canDetectDeadCode(): bool
5042
{
5143
return true;
5244
}
5345

54-
/**
55-
* Start collection of code coverage information.
56-
*/
5746
public function start(): void
5847
{
5948
$flags = \XDEBUG_CC_UNUSED;
6049

61-
if ($this->detectDeadCode || $this->collectBranchAndPathCoverage) { // branch/path collection requires enabling dead code checks
50+
if ($this->detectsDeadCode() || $this->collectsBranchAndPathCoverage()) {
6251
$flags |= \XDEBUG_CC_DEAD_CODE;
6352
}
6453

65-
if ($this->collectBranchAndPathCoverage) {
54+
if ($this->collectsBranchAndPathCoverage()) {
6655
$flags |= \XDEBUG_CC_BRANCH_CHECK;
6756
}
6857

6958
\xdebug_start_code_coverage($flags);
7059
}
7160

72-
/**
73-
* Stop collection of code coverage information.
74-
*/
7561
public function stop(): RawCodeCoverageData
7662
{
7763
$data = \xdebug_get_code_coverage();
7864

7965
\xdebug_stop_code_coverage();
8066

81-
if ($this->collectBranchAndPathCoverage) {
67+
if ($this->collectsBranchAndPathCoverage()) {
8268
return RawCodeCoverageData::fromXdebugWithPathCoverage($data);
8369
}
8470

‎src/Exception/BranchAndPathCoverageNotSupportedException.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@
99
*/
1010
namespace SebastianBergmann\CodeCoverage;
1111

12-
/**
13-
* Exception that is raised when branch and path coverage is not supported by the driver but is attempted to be used.
14-
*/
1512
final class BranchAndPathCoverageNotSupportedException extends RuntimeException
1613
{
1714
}

‎src/Exception/CoveredCodeNotExecutedException.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@
99
*/
1010
namespace SebastianBergmann\CodeCoverage;
1111

12-
/**
13-
* Exception that is raised when covered code is not executed.
14-
*/
1512
final class CoveredCodeNotExecutedException extends RuntimeException
1613
{
1714
}

0 commit comments

Comments
 (0)