Skip to content

Commit f920e24

Browse files
sebastianbergmannsebastianbergmann
committed
Refactor
1 parent b4f6183 commit f920e24

File tree

4 files changed

+63
-49
lines changed

4 files changed

+63
-49
lines changed

‎ChangeLog.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
77
### Added
88

99
* [#761](https://github.com/sebastianbergmann/php-code-coverage/pull/761): Support for Branch Coverage and Path Coverage
10+
* Named constructors `CodeCoverage::create()`, `CodeCoverage::createWithDriver()`, `CodeCoverage::createWithFilter()`, and `CodeCoverage::createWithDriverAndFilter()`
1011

1112
### Changed
1213

@@ -18,6 +19,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
1819
* [#754](https://github.com/sebastianbergmann/php-code-coverage/pull/754): Implement collection of raw branch and path coverage
1920
* [#755](https://github.com/sebastianbergmann/php-code-coverage/pull/755): Implement processing of raw branch and path coverage
2021
* [#756](https://github.com/sebastianbergmann/php-code-coverage/pull/756): Improve handling of uncovered files
22+
* `CodeCoverage::__construct()` is now private, use named constructors instead
2123

2224
## [8.0.2] - 2020-05-23
2325

‎src/CodeCoverage.php‎

Lines changed: 48 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -133,20 +133,33 @@ final class CodeCoverage
133133
*/
134134
private $report;
135135

136-
public function __construct(Driver $driver = null, Filter $filter = null)
136+
public static function create(): self
137137
{
138-
if ($filter === null) {
139-
$filter = new Filter;
140-
}
138+
$filter = new Filter;
141139

142-
if ($driver === null) {
143-
$driver = $this->selectDriver($filter);
144-
}
140+
return new self(self::selectDriver($filter), $filter);
141+
}
142+
143+
public static function createWithDriver(Driver $driver): self
144+
{
145+
return new self($driver, new Filter);
146+
}
147+
148+
public static function createWithFilter(Filter $filter): self
149+
{
150+
return new self(self::selectDriver($filter), $filter);
151+
}
152+
153+
public static function createWithDriverAndFilter(Driver $driver, Filter $filter): self
154+
{
155+
return new self($driver, $filter);
156+
}
145157

158+
private function __construct(Driver $driver, Filter $filter)
159+
{
146160
$this->driver = $driver;
147161
$this->filter = $filter;
148-
149-
$this->data = new ProcessedCodeCoverageData;
162+
$this->data = new ProcessedCodeCoverageData;
150163
}
151164

152165
/**
@@ -721,32 +734,6 @@ private function getAllowedLines(array $linesToBeCovered, array $linesToBeUsed):
721734
return $allowedLines;
722735
}
723736

724-
/**
725-
* @throws NoCodeCoverageDriverAvailableException
726-
* @throws PcovNotAvailableException
727-
* @throws PhpdbgNotAvailableException
728-
* @throws XdebugNotAvailableException
729-
* @throws XdebugNotEnabledException
730-
*/
731-
private function selectDriver(Filter $filter): Driver
732-
{
733-
$runtime = new Runtime;
734-
735-
if ($runtime->hasPHPDBGCodeCoverage()) {
736-
return new PhpdbgDriver;
737-
}
738-
739-
if ($runtime->hasPCOV()) {
740-
return new PcovDriver($filter);
741-
}
742-
743-
if ($runtime->hasXdebug()) {
744-
return new XdebugDriver($filter);
745-
}
746-
747-
throw new NoCodeCoverageDriverAvailableException;
748-
}
749-
750737
/**
751738
* @throws ReflectionException
752739
*/
@@ -852,4 +839,30 @@ private function wizard(): Wizard
852839

853840
return $this->wizard;
854841
}
842+
843+
/**
844+
* @throws NoCodeCoverageDriverAvailableException
845+
* @throws PcovNotAvailableException
846+
* @throws PhpdbgNotAvailableException
847+
* @throws XdebugNotAvailableException
848+
* @throws XdebugNotEnabledException
849+
*/
850+
private static function selectDriver(Filter $filter): Driver
851+
{
852+
$runtime = new Runtime;
853+
854+
if ($runtime->hasPHPDBGCodeCoverage()) {
855+
return new PhpdbgDriver;
856+
}
857+
858+
if ($runtime->hasPCOV()) {
859+
return new PcovDriver($filter);
860+
}
861+
862+
if ($runtime->hasXdebug()) {
863+
return new XdebugDriver($filter);
864+
}
865+
866+
throw new NoCodeCoverageDriverAvailableException;
867+
}
855868
}

‎tests/TestCase.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ protected function getLineCoverageForBankAccount(): CodeCoverage
828828
$filter = new Filter;
829829
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
830830

831-
$coverage = new CodeCoverage($stub, $filter);
831+
$coverage = CodeCoverage::createWithDriverAndFilter($stub, $filter);
832832

833833
$coverage->start(
834834
new \BankAccountTest('testBalanceIsInitiallyZero'),
@@ -890,7 +890,7 @@ protected function getPathCoverageForBankAccount(): CodeCoverage
890890
$filter = new Filter;
891891
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
892892

893-
$coverage = new CodeCoverage($stub, $filter);
893+
$coverage = CodeCoverage::createWithDriverAndFilter($stub, $filter);
894894

895895
$coverage->start(
896896
new \BankAccountTest('testBalanceIsInitiallyZero'),
@@ -1002,7 +1002,7 @@ protected function getLineCoverageForNamespacedBankAccount(): CodeCoverage
10021002
$filter = new Filter;
10031003
$filter->addFileToWhitelist(TEST_FILES_PATH . 'NamespacedBankAccount.php');
10041004

1005-
$coverage = new CodeCoverage($stub, $filter);
1005+
$coverage = CodeCoverage::createWithDriverAndFilter($stub, $filter);
10061006

10071007
$coverage->start(
10081008
new \BankAccountTest('testBalanceIsInitiallyZero'),
@@ -1062,7 +1062,7 @@ protected function getLineCoverageForBankAccountForFirstTwoTests(): CodeCoverage
10621062
$filter = new Filter;
10631063
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
10641064

1065-
$coverage = new CodeCoverage($stub, $filter);
1065+
$coverage = CodeCoverage::createWithDriverAndFilter($stub, $filter);
10661066

10671067
$coverage->start(
10681068
new \BankAccountTest('testBalanceIsInitiallyZero'),
@@ -1098,7 +1098,7 @@ protected function getLineCoverageForBankAccountForLastTwoTests(): CodeCoverage
10981098
$filter = new Filter;
10991099
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
11001100

1101-
$coverage = new CodeCoverage($stub, $filter);
1101+
$coverage = CodeCoverage::createWithDriverAndFilter($stub, $filter);
11021102

11031103
$coverage->start(
11041104
new \BankAccountTest('testBalanceCannotBecomeNegative2')
@@ -1207,7 +1207,7 @@ protected function getPathCoverageForBankAccountForFirstTwoTests(): CodeCoverage
12071207
$filter = new Filter;
12081208
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
12091209

1210-
$coverage = new CodeCoverage($stub, $filter);
1210+
$coverage = CodeCoverage::createWithDriverAndFilter($stub, $filter);
12111211

12121212
$coverage->start(
12131213
new \BankAccountTest('testBalanceIsInitiallyZero'),
@@ -1243,7 +1243,7 @@ protected function getPathCoverageForBankAccountForLastTwoTests(): CodeCoverage
12431243
$filter = new Filter;
12441244
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
12451245

1246-
$coverage = new CodeCoverage($stub, $filter);
1246+
$coverage = CodeCoverage::createWithDriverAndFilter($stub, $filter);
12471247

12481248
$coverage->start(
12491249
new \BankAccountTest('testBalanceCannotBecomeNegative2')
@@ -1480,7 +1480,7 @@ protected function getCoverageForFileWithIgnoredLines(): CodeCoverage
14801480
$filter = new Filter;
14811481
$filter->addFileToWhitelist(TEST_FILES_PATH . 'source_with_ignore.php');
14821482

1483-
$coverage = new CodeCoverage(
1483+
$coverage = CodeCoverage::createWithDriverAndFilter(
14841484
$this->setUpXdebugStubForFileWithIgnoredLines(),
14851485
$filter
14861486
);
@@ -1514,7 +1514,7 @@ protected function getCoverageForClassWithAnonymousFunction(): CodeCoverage
15141514
$filter = new Filter;
15151515
$filter->addFileToWhitelist(TEST_FILES_PATH . 'source_with_class_and_anonymous_function.php');
15161516

1517-
$coverage = new CodeCoverage(
1517+
$coverage = CodeCoverage::createWithDriverAndFilter(
15181518
$this->setUpXdebugStubForClassWithAnonymousFunction(),
15191519
$filter
15201520
);
@@ -1555,7 +1555,7 @@ protected function getCoverageForCrashParsing(): CodeCoverage
15551555
$filter->addFileToWhitelist(TEST_FILES_PATH . 'Crash.php');
15561556

15571557
// This is a file with invalid syntax, so it isn't executed.
1558-
return new CodeCoverage(
1558+
return CodeCoverage::createWithDriverAndFilter(
15591559
$this->setUpXdebugStubForCrashParsing(),
15601560
$filter
15611561
);

‎tests/tests/CodeCoverageTest.php‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ protected function setUp(): void
3030
$this->markTestSkipped('No code coverage driver available');
3131
}
3232

33-
$this->coverage = new CodeCoverage;
33+
$this->coverage = CodeCoverage::create();
3434
}
3535

3636
public function testCannotStopWithInvalidSecondArgument(): void
@@ -111,9 +111,8 @@ public function testMergeReverseOrder(): void
111111

112112
public function testMerge2(): void
113113
{
114-
$coverage = new CodeCoverage(
115-
$this->createStub(Driver::class),
116-
new Filter
114+
$coverage = CodeCoverage::createWithDriver(
115+
$this->createStub(Driver::class)
117116
);
118117

119118
$coverage->merge($this->getLineCoverageForBankAccount());

0 commit comments

Comments
 (0)