Skip to content

Commit a67e775

Browse files
sebastianbergmannsebastianbergmann
committed
Combine CoveredFileAnalyser and UncoveredFileAnalyser into FileAnalyser
1 parent 6882cdb commit a67e775

18 files changed

+248
-410
lines changed

‎.psalm/baseline.xml‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -228,22 +228,25 @@
228228
<code>createElementNS</code>
229229
</PossiblyNullReference>
230230
</file>
231-
<file src="src/StaticAnalysis/CachingCoveredFileAnalyser.php">
232-
<NullableReturnStatement occurrences="5">
231+
<file src="src/StaticAnalysis/CachingFileAnalyser.php">
232+
<NullableReturnStatement occurrences="6">
233233
<code>$this-&gt;cache[$filename]['classesIn']</code>
234+
<code>$this-&gt;cache[$filename]['executableLinesIn']</code>
234235
<code>$this-&gt;cache[$filename]['functionsIn']</code>
235236
<code>$this-&gt;cache[$filename]['ignoredLinesFor']</code>
236237
<code>$this-&gt;cache[$filename]['linesOfCodeFor']</code>
237238
<code>$this-&gt;cache[$filename]['traitsIn']</code>
238239
</NullableReturnStatement>
239-
<PossiblyNullArrayAccess occurrences="5">
240+
<PossiblyNullArrayAccess occurrences="6">
240241
<code>$this-&gt;cache[$filename]['classesIn']</code>
242+
<code>$this-&gt;cache[$filename]['executableLinesIn']</code>
241243
<code>$this-&gt;cache[$filename]['functionsIn']</code>
242244
<code>$this-&gt;cache[$filename]['ignoredLinesFor']</code>
243245
<code>$this-&gt;cache[$filename]['linesOfCodeFor']</code>
244246
<code>$this-&gt;cache[$filename]['traitsIn']</code>
245247
</PossiblyNullArrayAccess>
246-
<PossiblyUndefinedArrayOffset occurrences="5">
248+
<PossiblyUndefinedArrayOffset occurrences="6">
249+
<code>$this-&gt;cache[$filename]</code>
247250
<code>$this-&gt;cache[$filename]</code>
248251
<code>$this-&gt;cache[$filename]</code>
249252
<code>$this-&gt;cache[$filename]</code>

‎ChangeLog.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
44

55
## [9.2.11] - 2022-MM-DD
66

7+
### Changed
8+
9+
* `CoveredFileAnalyser` and `UncoveredFileAnalyser` have been combined to `FileAnalyser`
10+
711
### Fixed
812

913
* [#889](https://github.com/sebastianbergmann/php-code-coverage/issues/889): Code Coverage depends on autoload order

‎src/CodeCoverage.php‎

Lines changed: 16 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,9 @@
2929
use SebastianBergmann\CodeCoverage\Driver\Driver;
3030
use SebastianBergmann\CodeCoverage\Node\Builder;
3131
use SebastianBergmann\CodeCoverage\Node\Directory;
32-
use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingCoveredFileAnalyser;
33-
use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingUncoveredFileAnalyser;
34-
use SebastianBergmann\CodeCoverage\StaticAnalysis\CoveredFileAnalyser;
35-
use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingCoveredFileAnalyser;
36-
use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingUncoveredFileAnalyser;
37-
use SebastianBergmann\CodeCoverage\StaticAnalysis\UncoveredFileAnalyser;
32+
use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingFileAnalyser;
33+
use SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser;
34+
use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingFileAnalyser;
3835
use SebastianBergmann\CodeUnitReverseLookup\Wizard;
3936

4037
/**
@@ -109,14 +106,9 @@ final class CodeCoverage
109106
private $parentClassesExcludedFromUnintentionallyCoveredCodeCheck = [];
110107

111108
/**
112-
* @var ?CoveredFileAnalyser
109+
* @var ?FileAnalyser
113110
*/
114-
private $coveredFileAnalyser;
115-
116-
/**
117-
* @var ?UncoveredFileAnalyser
118-
*/
119-
private $uncoveredFileAnalyser;
111+
private $analyser;
120112

121113
/**
122114
* @var ?string
@@ -136,7 +128,7 @@ public function __construct(Driver $driver, Filter $filter)
136128
*/
137129
public function getReport(): Directory
138130
{
139-
return (new Builder($this->coveredFileAnalyser()))->build($this);
131+
return (new Builder($this->analyser()))->build($this);
140132
}
141133

142134
/**
@@ -492,7 +484,7 @@ private function applyExecutableLinesFilter(RawCodeCoverageData $data): void
492484
foreach (array_keys($data->lineCoverage()) as $filename) {
493485
$data->keepLineCoverageDataOnlyForLines(
494486
$filename,
495-
$this->uncoveredFileAnalyser()->executableLinesIn($filename)
487+
$this->analyser()->executableLinesIn($filename)
496488
);
497489
}
498490
}
@@ -506,7 +498,7 @@ private function applyIgnoredLinesFilter(RawCodeCoverageData $data): void
506498

507499
$data->removeCoverageDataForLines(
508500
$filename,
509-
$this->coveredFileAnalyser()->ignoredLinesFor($filename)
501+
$this->analyser()->ignoredLinesFor($filename)
510502
);
511503
}
512504
}
@@ -526,7 +518,7 @@ private function addUncoveredFilesFromFilter(): void
526518
$this->append(
527519
RawCodeCoverageData::fromUncoveredFile(
528520
$uncoveredFile,
529-
$this->uncoveredFileAnalyser()
521+
$this->analyser()
530522
),
531523
self::UNCOVERED_FILES
532524
);
@@ -657,42 +649,24 @@ private function processUnintentionallyCoveredUnits(array $unintentionallyCovere
657649
return array_values($unintentionallyCoveredUnits);
658650
}
659651

660-
private function coveredFileAnalyser(): CoveredFileAnalyser
652+
private function analyser(): FileAnalyser
661653
{
662-
if ($this->coveredFileAnalyser !== null) {
663-
return $this->coveredFileAnalyser;
654+
if ($this->analyser !== null) {
655+
return $this->analyser;
664656
}
665657

666-
$this->coveredFileAnalyser = new ParsingCoveredFileAnalyser(
658+
$this->analyser = new ParsingFileAnalyser(
667659
$this->useAnnotationsForIgnoringCode,
668660
$this->ignoreDeprecatedCode
669661
);
670662

671663
if ($this->cachesStaticAnalysis()) {
672-
$this->coveredFileAnalyser = new CachingCoveredFileAnalyser(
673-
$this->cacheDirectory,
674-
$this->coveredFileAnalyser
675-
);
676-
}
677-
678-
return $this->coveredFileAnalyser;
679-
}
680-
681-
private function uncoveredFileAnalyser(): UncoveredFileAnalyser
682-
{
683-
if ($this->uncoveredFileAnalyser !== null) {
684-
return $this->uncoveredFileAnalyser;
685-
}
686-
687-
$this->uncoveredFileAnalyser = new ParsingUncoveredFileAnalyser;
688-
689-
if ($this->cachesStaticAnalysis()) {
690-
$this->uncoveredFileAnalyser = new CachingUncoveredFileAnalyser(
664+
$this->analyser = new CachingFileAnalyser(
691665
$this->cacheDirectory,
692-
$this->uncoveredFileAnalyser
666+
$this->analyser
693667
);
694668
}
695669

696-
return $this->uncoveredFileAnalyser;
670+
return $this->analyser;
697671
}
698672
}

‎src/Node/Builder.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@
2222
use function substr;
2323
use SebastianBergmann\CodeCoverage\CodeCoverage;
2424
use SebastianBergmann\CodeCoverage\ProcessedCodeCoverageData;
25-
use SebastianBergmann\CodeCoverage\StaticAnalysis\CoveredFileAnalyser;
25+
use SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser;
2626

2727
/**
2828
* @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
2929
*/
3030
final class Builder
3131
{
3232
/**
33-
* @var CoveredFileAnalyser
33+
* @var FileAnalyser
3434
*/
3535
private $coveredFileAnalyser;
3636

37-
public function __construct(CoveredFileAnalyser $coveredFileAnalyser)
37+
public function __construct(FileAnalyser $coveredFileAnalyser)
3838
{
3939
$this->coveredFileAnalyser = $coveredFileAnalyser;
4040
}

‎src/RawCodeCoverageData.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
use function in_array;
2020
use function range;
2121
use SebastianBergmann\CodeCoverage\Driver\Driver;
22-
use SebastianBergmann\CodeCoverage\StaticAnalysis\UncoveredFileAnalyser;
22+
use SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser;
2323

2424
/**
2525
* @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -84,11 +84,11 @@ public static function fromXdebugWithMixedCoverage(array $rawCoverage): self
8484
return new self($lineCoverage, $functionCoverage);
8585
}
8686

87-
public static function fromUncoveredFile(string $filename, UncoveredFileAnalyser $uncoveredFileAnalyser): self
87+
public static function fromUncoveredFile(string $filename, FileAnalyser $analyser): self
8888
{
8989
$lineCoverage = [];
9090

91-
foreach ($uncoveredFileAnalyser->executableLinesIn($filename) as $line) {
91+
foreach ($analyser->executableLinesIn($filename) as $line) {
9292
$lineCoverage[$line] = Driver::LINE_NOT_EXECUTED;
9393
}
9494

‎src/StaticAnalysis/Cache.php‎

Lines changed: 0 additions & 90 deletions
This file was deleted.

‎src/StaticAnalysis/CacheWarmer.php‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,16 @@ final class CacheWarmer
1515
{
1616
public function warmCache(string $cacheDirectory, bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode, Filter $filter): void
1717
{
18-
$coveredFileAnalyser = new CachingCoveredFileAnalyser(
18+
$analyser = new CachingFileAnalyser(
1919
$cacheDirectory,
20-
new ParsingCoveredFileAnalyser(
20+
new ParsingFileAnalyser(
2121
$useAnnotationsForIgnoringCode,
2222
$ignoreDeprecatedCode
2323
)
2424
);
2525

26-
$uncoveredFileAnalyser = new CachingUncoveredFileAnalyser(
27-
$cacheDirectory,
28-
new ParsingUncoveredFileAnalyser
29-
);
30-
3126
foreach ($filter->files() as $file) {
32-
$coveredFileAnalyser->process($file);
33-
34-
/* @noinspection UnusedFunctionResultInspection */
35-
$uncoveredFileAnalyser->executableLinesIn($file);
27+
$analyser->process($file);
3628
}
3729
}
3830
}

0 commit comments

Comments
 (0)