Skip to content

Commit 274d972

Browse files
sebastianbergmannsebastianbergmann
committed
Decouple report generators from CodeCoverage object
1 parent 61d610c commit 274d972

File tree

13 files changed

+61
-62
lines changed

13 files changed

+61
-62
lines changed

‎ChangeLog.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
1212
### Changed
1313

1414
* [#856](https://github.com/sebastianbergmann/php-code-coverage/issues/856): Do not include (and execute) uncovered files
15+
* The `SebastianBergmann\CodeCoverage\Report\Clover::process()`, `SebastianBergmann\CodeCoverage\Report\Cobertura::process()`, `SebastianBergmann\CodeCoverage\Report\Html\Facade::process()`, `SebastianBergmann\CodeCoverage\Report\Crapj::process()`, `SebastianBergmann\CodeCoverage\Report\Text::process()`, and `SebastianBergmann\CodeCoverage\Report\Xml\Facade::process()` methods now require a `SebastianBergmann\CodeCoverage\Node\Directory` object (returned by `SebastianBergmann\CodeCoverage\CodeCoverage::getReport()`) instead of an `SebastianBergmann\CodeCoverage\CodeCoverage` object
1516

1617
### Removed
1718

‎src/Report/Clover.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
use function range;
1919
use function time;
2020
use DOMDocument;
21-
use SebastianBergmann\CodeCoverage\CodeCoverage;
2221
use SebastianBergmann\CodeCoverage\Driver\WriteOperationFailedException;
22+
use SebastianBergmann\CodeCoverage\Node\Directory;
2323
use SebastianBergmann\CodeCoverage\Node\File;
2424
use SebastianBergmann\CodeCoverage\Util\Filesystem;
2525

@@ -28,7 +28,7 @@ final class Clover
2828
/**
2929
* @throws WriteOperationFailedException
3030
*/
31-
public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string
31+
public function process(Directory $report, ?string $target = null, ?string $name = null): string
3232
{
3333
$time = (string) time();
3434

@@ -49,7 +49,6 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string
4949
$xmlCoverage->appendChild($xmlProject);
5050

5151
$packages = [];
52-
$report = $coverage->getReport();
5352

5453
foreach ($report as $item) {
5554
if (!$item instanceof File) {

‎src/Report/Cobertura.php‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
use function str_replace;
1919
use function time;
2020
use DOMImplementation;
21-
use SebastianBergmann\CodeCoverage\CodeCoverage;
2221
use SebastianBergmann\CodeCoverage\Driver\WriteOperationFailedException;
22+
use SebastianBergmann\CodeCoverage\Node\Directory;
2323
use SebastianBergmann\CodeCoverage\Node\File;
2424
use SebastianBergmann\CodeCoverage\Util\Filesystem;
2525

@@ -28,12 +28,10 @@ final class Cobertura
2828
/**
2929
* @throws WriteOperationFailedException
3030
*/
31-
public function process(CodeCoverage $coverage, ?string $target = null): string
31+
public function process(Directory $report, ?string $target = null): string
3232
{
3333
$time = (string) time();
3434

35-
$report = $coverage->getReport();
36-
3735
$implementation = new DOMImplementation;
3836

3937
$documentType = $implementation->createDocumentType(

‎src/Report/Crap4j.php‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
use function is_string;
1717
use function round;
1818
use DOMDocument;
19-
use SebastianBergmann\CodeCoverage\CodeCoverage;
2019
use SebastianBergmann\CodeCoverage\Driver\WriteOperationFailedException;
20+
use SebastianBergmann\CodeCoverage\Node\Directory;
2121
use SebastianBergmann\CodeCoverage\Node\File;
2222
use SebastianBergmann\CodeCoverage\Util\Filesystem;
2323

@@ -33,7 +33,7 @@ public function __construct(int $threshold = 30)
3333
/**
3434
* @throws WriteOperationFailedException
3535
*/
36-
public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string
36+
public function process(Directory $report, ?string $target = null, ?string $name = null): string
3737
{
3838
$document = new DOMDocument('1.0', 'UTF-8');
3939
$document->formatOutput = true;
@@ -48,9 +48,6 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string
4848
$stats = $document->createElement('stats');
4949
$methodsNode = $document->createElement('methods');
5050

51-
$report = $coverage->getReport();
52-
unset($coverage);
53-
5451
$fullMethodCount = 0;
5552
$fullCrapMethodCount = 0;
5653
$fullCrapLoad = 0;

‎src/Report/Html/Facade.php‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
use function date;
1515
use function dirname;
1616
use function str_ends_with;
17-
use SebastianBergmann\CodeCoverage\CodeCoverage;
1817
use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode;
18+
use SebastianBergmann\CodeCoverage\Node\Directory as NodeDirectory;
1919
use SebastianBergmann\CodeCoverage\Report\Thresholds;
2020
use SebastianBergmann\CodeCoverage\Util\Filesystem;
2121
use SebastianBergmann\Template\Template;
@@ -37,34 +37,33 @@ public function __construct(string $generator = '', ?Colors $colors = null, ?Thr
3737
$this->templatePath = __DIR__ . '/Renderer/Template/';
3838
}
3939

40-
public function process(CodeCoverage $coverage, string $target): void
40+
public function process(NodeDirectory $report, bool $pathCoverage, string $target): void
4141
{
4242
$target = $this->directory($target);
43-
$report = $coverage->getReport();
4443
$date = date('D M j G:i:s T Y');
4544

4645
$dashboard = new Dashboard(
4746
$this->templatePath,
4847
$this->generator,
4948
$date,
5049
$this->thresholds,
51-
$coverage->collectsBranchAndPathCoverage()
50+
$pathCoverage
5251
);
5352

5453
$directory = new Directory(
5554
$this->templatePath,
5655
$this->generator,
5756
$date,
5857
$this->thresholds,
59-
$coverage->collectsBranchAndPathCoverage()
58+
$pathCoverage
6059
);
6160

6261
$file = new File(
6362
$this->templatePath,
6463
$this->generator,
6564
$date,
6665
$this->thresholds,
67-
$coverage->collectsBranchAndPathCoverage()
66+
$pathCoverage
6867
);
6968

7069
$directory->render($report, $target . 'index.html');

‎src/Report/Text.php‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
use function sprintf;
1818
use function str_pad;
1919
use function strlen;
20-
use SebastianBergmann\CodeCoverage\CodeCoverage;
20+
use SebastianBergmann\CodeCoverage\Node\Directory;
2121
use SebastianBergmann\CodeCoverage\Node\File;
2222
use SebastianBergmann\CodeCoverage\Util\Percentage;
2323

@@ -58,12 +58,9 @@ public function __construct(Thresholds $thresholds, bool $showUncoveredFiles = f
5858
$this->showOnlySummary = $showOnlySummary;
5959
}
6060

61-
public function process(CodeCoverage $coverage, bool $showColors = false): string
61+
public function process(Directory $report, bool $pathCoverage, bool $showColors = false): string
6262
{
63-
$hasBranchCoverage = !empty($coverage->getData(true)->functionCoverage());
64-
6563
$output = PHP_EOL . PHP_EOL;
66-
$report = $coverage->getReport();
6764

6865
$colors = [
6966
'header' => '',
@@ -128,7 +125,7 @@ public function process(CodeCoverage $coverage, bool $showColors = false): strin
128125
$paths = '';
129126
$branches = '';
130127

131-
if ($hasBranchCoverage) {
128+
if ($pathCoverage) {
132129
$paths = sprintf(
133130
' Paths: %6s (%d/%d)',
134131
Percentage::fromFractionAndTotal(
@@ -180,10 +177,11 @@ public function process(CodeCoverage $coverage, bool $showColors = false): strin
180177
$output .= $this->format($colors['classes'], $padding, $classes);
181178
$output .= $this->format($colors['methods'], $padding, $methods);
182179

183-
if ($hasBranchCoverage) {
180+
if ($pathCoverage) {
184181
$output .= $this->format($colors['paths'], $padding, $paths);
185182
$output .= $this->format($colors['branches'], $padding, $branches);
186183
}
184+
187185
$output .= $this->format($colors['lines'], $padding, $lines);
188186

189187
if ($this->showOnlySummary) {
@@ -263,10 +261,11 @@ public function process(CodeCoverage $coverage, bool $showColors = false): strin
263261
$output .= PHP_EOL . $fullQualifiedPath . PHP_EOL
264262
. ' ' . $methodColor . 'Methods: ' . $this->printCoverageCounts($classInfo['methodsCovered'], $classInfo['methodCount'], 2) . $resetColor . ' ';
265263

266-
if ($hasBranchCoverage) {
264+
if ($pathCoverage) {
267265
$output .= ' ' . $pathsColor . 'Paths: ' . $this->printCoverageCounts($classInfo['pathsCovered'], $classInfo['pathsCount'], 3) . $resetColor . ' '
268266
. ' ' . $branchesColor . 'Branches: ' . $this->printCoverageCounts($classInfo['branchesCovered'], $classInfo['branchesCount'], 3) . $resetColor . ' ';
269267
}
268+
270269
$output .= ' ' . $linesColor . 'Lines: ' . $this->printCoverageCounts($classInfo['statementsCovered'], $classInfo['statementCount'], 3) . $resetColor;
271270
}
272271
}

‎src/Report/Xml/Facade.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
use function substr;
2828
use DateTimeImmutable;
2929
use DOMDocument;
30-
use SebastianBergmann\CodeCoverage\CodeCoverage;
3130
use SebastianBergmann\CodeCoverage\Driver\PathExistsButIsNotDirectoryException;
3231
use SebastianBergmann\CodeCoverage\Driver\WriteOperationFailedException;
3332
use SebastianBergmann\CodeCoverage\Node\AbstractNode;
@@ -50,9 +49,11 @@ public function __construct(string $version)
5049
}
5150

5251
/**
52+
* @psalm-param array<string, array{size: string, status: string}> $tests
53+
*
5354
* @throws XmlException
5455
*/
55-
public function process(CodeCoverage $coverage, string $target): void
56+
public function process(DirectoryNode $report, array $tests, string $target): void
5657
{
5758
if (substr($target, -1, 1) !== DIRECTORY_SEPARATOR) {
5859
$target .= DIRECTORY_SEPARATOR;
@@ -61,14 +62,10 @@ public function process(CodeCoverage $coverage, string $target): void
6162
$this->target = $target;
6263
$this->initTargetDirectory($target);
6364

64-
$report = $coverage->getReport();
65-
66-
$this->project = new Project(
67-
$coverage->getReport()->name()
68-
);
65+
$this->project = new Project($report->name());
6966

7067
$this->setBuildInformation();
71-
$this->processTests($coverage->getTests());
68+
$this->processTests($tests);
7269
$this->processDirectory($report, $this->project);
7370

7471
$this->saveDocument($this->project->asDom(), 'index');
@@ -215,6 +212,9 @@ private function processFunction(array $function, Report $report): void
215212
$functionObject->setTotals((string) $function['executableLines'], (string) $function['executedLines'], (string) $function['coverage']);
216213
}
217214

215+
/**
216+
* @psalm-param array<string, array{size: string, status: string}> $tests
217+
*/
218218
private function processTests(array $tests): void
219219
{
220220
$testsObject = $this->project->tests();

‎tests/tests/Report/CloverTest.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public function testLineCoverageForBankAccountTest(): void
2121

2222
$this->assertStringMatchesFormatFile(
2323
TEST_FILES_PATH . 'BankAccount-clover-line.xml',
24-
$clover->process($this->getLineCoverageForBankAccount(), null, 'BankAccount')
24+
$clover->process($this->getLineCoverageForBankAccount()->getReport(), null, 'BankAccount')
2525
);
2626
}
2727

@@ -31,7 +31,7 @@ public function testPathCoverageForBankAccountTest(): void
3131

3232
$this->assertStringMatchesFormatFile(
3333
TEST_FILES_PATH . 'BankAccount-clover-path.xml',
34-
$clover->process($this->getPathCoverageForBankAccount(), null, 'BankAccount')
34+
$clover->process($this->getPathCoverageForBankAccount()->getReport(), null, 'BankAccount')
3535
);
3636
}
3737

@@ -41,7 +41,7 @@ public function testCloverForFileWithIgnoredLines(): void
4141

4242
$this->assertStringMatchesFormatFile(
4343
TEST_FILES_PATH . 'ignored-lines-clover.xml',
44-
$clover->process($this->getCoverageForFileWithIgnoredLines())
44+
$clover->process($this->getCoverageForFileWithIgnoredLines()->getReport())
4545
);
4646
}
4747

@@ -51,7 +51,7 @@ public function testCloverForClassWithAnonymousFunction(): void
5151

5252
$this->assertStringMatchesFormatFile(
5353
TEST_FILES_PATH . 'class-with-anonymous-function-clover.xml',
54-
$clover->process($this->getCoverageForClassWithAnonymousFunction())
54+
$clover->process($this->getCoverageForClassWithAnonymousFunction()->getReport())
5555
);
5656
}
5757
}

‎tests/tests/Report/CoberturaTest.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public function testLineCoverageForBankAccountTest(): void
2121

2222
$this->assertStringMatchesFormatFile(
2323
TEST_FILES_PATH . 'BankAccount-cobertura-line.xml',
24-
$cobertura->process($this->getLineCoverageForBankAccount(), null)
24+
$cobertura->process($this->getLineCoverageForBankAccount()->getReport())
2525
);
2626
}
2727

@@ -31,7 +31,7 @@ public function testPathCoverageForBankAccountTest(): void
3131

3232
$this->assertStringMatchesFormatFile(
3333
TEST_FILES_PATH . 'BankAccount-cobertura-path.xml',
34-
$cobertura->process($this->getPathCoverageForBankAccount(), null)
34+
$cobertura->process($this->getPathCoverageForBankAccount()->getReport())
3535
);
3636
}
3737

@@ -41,7 +41,7 @@ public function testCoberturaForFileWithIgnoredLines(): void
4141

4242
$this->assertStringMatchesFormatFile(
4343
TEST_FILES_PATH . 'ignored-lines-cobertura.xml',
44-
$cobertura->process($this->getCoverageForFileWithIgnoredLines())
44+
$cobertura->process($this->getCoverageForFileWithIgnoredLines()->getReport())
4545
);
4646
}
4747

@@ -51,7 +51,7 @@ public function testCoberturaForClassWithAnonymousFunction(): void
5151

5252
$this->assertStringMatchesFormatFile(
5353
TEST_FILES_PATH . 'class-with-anonymous-function-cobertura.xml',
54-
$cobertura->process($this->getCoverageForClassWithAnonymousFunction())
54+
$cobertura->process($this->getCoverageForClassWithAnonymousFunction()->getReport())
5555
);
5656
}
5757

@@ -61,7 +61,7 @@ public function testCoberturaForClassAndOutsideFunction(): void
6161

6262
$this->assertStringMatchesFormatFile(
6363
TEST_FILES_PATH . 'class-with-outside-function-cobertura.xml',
64-
$cobertura->process($this->getCoverageForClassWithOutsideFunction())
64+
$cobertura->process($this->getCoverageForClassWithOutsideFunction()->getReport())
6565
);
6666
}
6767
}

‎tests/tests/Report/Crap4jTest.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public function testForBankAccountTest(): void
2121

2222
$this->assertStringMatchesFormatFile(
2323
TEST_FILES_PATH . 'BankAccount-crap4j.xml',
24-
$crap4j->process($this->getLineCoverageForBankAccount(), null, 'BankAccount')
24+
$crap4j->process($this->getLineCoverageForBankAccount()->getReport(), null, 'BankAccount')
2525
);
2626
}
2727

@@ -31,7 +31,7 @@ public function testForFileWithIgnoredLines(): void
3131

3232
$this->assertStringMatchesFormatFile(
3333
TEST_FILES_PATH . 'ignored-lines-crap4j.xml',
34-
$crap4j->process($this->getCoverageForFileWithIgnoredLines(), null, 'CoverageForFileWithIgnoredLines')
34+
$crap4j->process($this->getCoverageForFileWithIgnoredLines()->getReport(), null, 'CoverageForFileWithIgnoredLines')
3535
);
3636
}
3737

@@ -41,7 +41,7 @@ public function testForClassWithAnonymousFunction(): void
4141

4242
$this->assertStringMatchesFormatFile(
4343
TEST_FILES_PATH . 'class-with-anonymous-function-crap4j.xml',
44-
$crap4j->process($this->getCoverageForClassWithAnonymousFunction(), null, 'CoverageForClassWithAnonymousFunction')
44+
$crap4j->process($this->getCoverageForClassWithAnonymousFunction()->getReport(), null, 'CoverageForClassWithAnonymousFunction')
4545
);
4646
}
4747
}

0 commit comments

Comments
 (0)