Skip to content

Commit 25b4dd5

Browse files
sebastianbergmannsebastianbergmann
committed
Revert "Decouple report generators from CodeCoverage object"
This reverts commit 274d972.
1 parent 47ba26f commit 25b4dd5

File tree

13 files changed

+62
-61
lines changed

13 files changed

+62
-61
lines changed

‎ChangeLog.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ 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
1615

1716
### Removed
1817

‎src/Report/Clover.php‎

Lines changed: 3 additions & 2 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;
2122
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(Directory $report, ?string $target = null, ?string $name = null): string
31+
public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string
3232
{
3333
$time = (string) time();
3434

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

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

5354
foreach ($report as $item) {
5455
if (!$item instanceof File) {

‎src/Report/Cobertura.php‎

Lines changed: 4 additions & 2 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;
2122
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,10 +28,12 @@ final class Cobertura
2828
/**
2929
* @throws WriteOperationFailedException
3030
*/
31-
public function process(Directory $report, ?string $target = null): string
31+
public function process(CodeCoverage $coverage, ?string $target = null): string
3232
{
3333
$time = (string) time();
3434

35+
$report = $coverage->getReport();
36+
3537
$implementation = new DOMImplementation;
3638

3739
$documentType = $implementation->createDocumentType(

‎src/Report/Crap4j.php‎

Lines changed: 5 additions & 2 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;
1920
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(Directory $report, ?string $target = null, ?string $name = null): string
36+
public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string
3737
{
3838
$document = new DOMDocument('1.0', 'UTF-8');
3939
$document->formatOutput = true;
@@ -48,6 +48,9 @@ public function process(Directory $report, ?string $target = null, ?string $name
4848
$stats = $document->createElement('stats');
4949
$methodsNode = $document->createElement('methods');
5050

51+
$report = $coverage->getReport();
52+
unset($coverage);
53+
5154
$fullMethodCount = 0;
5255
$fullCrapMethodCount = 0;
5356
$fullCrapLoad = 0;

‎src/Report/Html/Facade.php‎

Lines changed: 6 additions & 5 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;
1718
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,33 +37,34 @@ public function __construct(string $generator = '', ?Colors $colors = null, ?Thr
3737
$this->templatePath = __DIR__ . '/Renderer/Template/';
3838
}
3939

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

4546
$dashboard = new Dashboard(
4647
$this->templatePath,
4748
$this->generator,
4849
$date,
4950
$this->thresholds,
50-
$pathCoverage
51+
$coverage->collectsBranchAndPathCoverage()
5152
);
5253

5354
$directory = new Directory(
5455
$this->templatePath,
5556
$this->generator,
5657
$date,
5758
$this->thresholds,
58-
$pathCoverage
59+
$coverage->collectsBranchAndPathCoverage()
5960
);
6061

6162
$file = new File(
6263
$this->templatePath,
6364
$this->generator,
6465
$date,
6566
$this->thresholds,
66-
$pathCoverage
67+
$coverage->collectsBranchAndPathCoverage()
6768
);
6869

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

‎src/Report/Text.php‎

Lines changed: 8 additions & 7 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\Node\Directory;
20+
use SebastianBergmann\CodeCoverage\CodeCoverage;
2121
use SebastianBergmann\CodeCoverage\Node\File;
2222
use SebastianBergmann\CodeCoverage\Util\Percentage;
2323

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

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

6568
$colors = [
6669
'header' => '',
@@ -125,7 +128,7 @@ public function process(Directory $report, bool $pathCoverage, bool $showColors
125128
$paths = '';
126129
$branches = '';
127130

128-
if ($pathCoverage) {
131+
if ($hasBranchCoverage) {
129132
$paths = sprintf(
130133
' Paths: %6s (%d/%d)',
131134
Percentage::fromFractionAndTotal(
@@ -177,11 +180,10 @@ public function process(Directory $report, bool $pathCoverage, bool $showColors
177180
$output .= $this->format($colors['classes'], $padding, $classes);
178181
$output .= $this->format($colors['methods'], $padding, $methods);
179182

180-
if ($pathCoverage) {
183+
if ($hasBranchCoverage) {
181184
$output .= $this->format($colors['paths'], $padding, $paths);
182185
$output .= $this->format($colors['branches'], $padding, $branches);
183186
}
184-
185187
$output .= $this->format($colors['lines'], $padding, $lines);
186188

187189
if ($this->showOnlySummary) {
@@ -261,11 +263,10 @@ public function process(Directory $report, bool $pathCoverage, bool $showColors
261263
$output .= PHP_EOL . $fullQualifiedPath . PHP_EOL
262264
. ' ' . $methodColor . 'Methods: ' . $this->printCoverageCounts($classInfo['methodsCovered'], $classInfo['methodCount'], 2) . $resetColor . ' ';
263265

264-
if ($pathCoverage) {
266+
if ($hasBranchCoverage) {
265267
$output .= ' ' . $pathsColor . 'Paths: ' . $this->printCoverageCounts($classInfo['pathsCovered'], $classInfo['pathsCount'], 3) . $resetColor . ' '
266268
. ' ' . $branchesColor . 'Branches: ' . $this->printCoverageCounts($classInfo['branchesCovered'], $classInfo['branchesCount'], 3) . $resetColor . ' ';
267269
}
268-
269270
$output .= ' ' . $linesColor . 'Lines: ' . $this->printCoverageCounts($classInfo['statementsCovered'], $classInfo['statementCount'], 3) . $resetColor;
270271
}
271272
}

‎src/Report/Xml/Facade.php‎

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

5152
/**
52-
* @psalm-param array<string, array{size: string, status: string}> $tests
53-
*
5453
* @throws XmlException
5554
*/
56-
public function process(DirectoryNode $report, array $tests, string $target): void
55+
public function process(CodeCoverage $coverage, string $target): void
5756
{
5857
if (substr($target, -1, 1) !== DIRECTORY_SEPARATOR) {
5958
$target .= DIRECTORY_SEPARATOR;
@@ -62,10 +61,14 @@ public function process(DirectoryNode $report, array $tests, string $target): vo
6261
$this->target = $target;
6362
$this->initTargetDirectory($target);
6463

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

6770
$this->setBuildInformation();
68-
$this->processTests($tests);
71+
$this->processTests($coverage->getTests());
6972
$this->processDirectory($report, $this->project);
7073

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

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()->getReport(), null, 'BankAccount')
24+
$clover->process($this->getLineCoverageForBankAccount(), 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()->getReport(), null, 'BankAccount')
34+
$clover->process($this->getPathCoverageForBankAccount(), 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()->getReport())
44+
$clover->process($this->getCoverageForFileWithIgnoredLines())
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()->getReport())
54+
$clover->process($this->getCoverageForClassWithAnonymousFunction())
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()->getReport())
24+
$cobertura->process($this->getLineCoverageForBankAccount(), null)
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()->getReport())
34+
$cobertura->process($this->getPathCoverageForBankAccount(), null)
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()->getReport())
44+
$cobertura->process($this->getCoverageForFileWithIgnoredLines())
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()->getReport())
54+
$cobertura->process($this->getCoverageForClassWithAnonymousFunction())
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()->getReport())
64+
$cobertura->process($this->getCoverageForClassWithOutsideFunction())
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()->getReport(), null, 'BankAccount')
24+
$crap4j->process($this->getLineCoverageForBankAccount(), 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()->getReport(), null, 'CoverageForFileWithIgnoredLines')
34+
$crap4j->process($this->getCoverageForFileWithIgnoredLines(), 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()->getReport(), null, 'CoverageForClassWithAnonymousFunction')
44+
$crap4j->process($this->getCoverageForClassWithAnonymousFunction(), null, 'CoverageForClassWithAnonymousFunction')
4545
);
4646
}
4747
}

0 commit comments

Comments
 (0)