Skip to content

Commit d792809

Browse files
sebastianbergmannsebastianbergmann
committed
Make the world a better place, one Singleton at a time
1 parent c142075 commit d792809

File tree

7 files changed

+80
-68
lines changed

7 files changed

+80
-68
lines changed

‎src/CodeCoverage.php‎

Lines changed: 49 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
use SebastianBergmann\CodeCoverage\Node\Directory;
3232
use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingExecutedFileAnalyser;
3333
use SebastianBergmann\CodeCoverage\StaticAnalysis\ExecutedFileAnalyser;
34+
use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingExecutedFileAnalyser;
3435
use SebastianBergmann\CodeUnitReverseLookup\Wizard;
3536

3637
/**
@@ -116,20 +117,27 @@ final class CodeCoverage
116117
*/
117118
private $executedFileAnalyser;
118119

120+
/**
121+
* @var ?string
122+
*/
123+
private $cacheDirectory;
124+
119125
public function __construct(Driver $driver, Filter $filter)
120126
{
121127
$this->driver = $driver;
122128
$this->filter = $filter;
123129
$this->data = new ProcessedCodeCoverageData;
124130
$this->wizard = new Wizard;
131+
132+
$this->cacheStaticAnalysis('/tmp/cache');
125133
}
126134

127135
/**
128136
* Returns the code coverage information as a graph of node objects.
129137
*/
130138
public function getReport(): Directory
131139
{
132-
return (new Builder)->build($this);
140+
return (new Builder($this->executedFileAnalyser()))->build($this);
133141
}
134142

135143
/**
@@ -364,6 +372,24 @@ public function doNotIgnoreDeprecatedCode(): void
364372
$this->ignoreDeprecatedCode = false;
365373
}
366374

375+
/**
376+
* @psalm-assert-if-true !null $this->cacheDirectory
377+
*/
378+
public function cachesStaticAnalysis(): bool
379+
{
380+
return $this->cacheDirectory !== null;
381+
}
382+
383+
public function cacheStaticAnalysis(string $cacheDirectory): void
384+
{
385+
$this->cacheDirectory = $cacheDirectory;
386+
}
387+
388+
public function doNotCacheStaticAnalysis(): void
389+
{
390+
$this->cacheDirectory = null;
391+
}
392+
367393
/**
368394
* @psalm-param class-string $className
369395
*/
@@ -447,22 +473,14 @@ private function applyFilter(RawCodeCoverageData $data): void
447473

448474
private function applyIgnoredLinesFilter(RawCodeCoverageData $data): void
449475
{
450-
if ($this->executedFileAnalyser === null) {
451-
$this->executedFileAnalyser = CachingExecutedFileAnalyser::createInstance(
452-
'/tmp/cache',
453-
$this->useAnnotationsForIgnoringCode,
454-
$this->ignoreDeprecatedCode
455-
);
456-
}
457-
458476
foreach (array_keys($data->lineCoverage()) as $filename) {
459477
if (!$this->filter->isFile($filename)) {
460478
continue;
461479
}
462480

463481
$data->removeCoverageDataForLines(
464482
$filename,
465-
$this->executedFileAnalyser->ignoredLinesFor($filename)
483+
$this->executedFileAnalyser()->ignoredLinesFor($filename)
466484
);
467485
}
468486
}
@@ -615,4 +633,25 @@ private function initializeData(): void
615633
$this->append($this->driver->stop(), self::UNCOVERED_FILES);
616634
}
617635
}
636+
637+
private function executedFileAnalyser(): ExecutedFileAnalyser
638+
{
639+
if ($this->executedFileAnalyser !== null) {
640+
return $this->executedFileAnalyser;
641+
}
642+
643+
$this->executedFileAnalyser = new ParsingExecutedFileAnalyser(
644+
$this->useAnnotationsForIgnoringCode,
645+
$this->ignoreDeprecatedCode
646+
);
647+
648+
if ($this->cachesStaticAnalysis()) {
649+
$this->executedFileAnalyser = new CachingExecutedFileAnalyser(
650+
$this->cacheDirectory,
651+
$this->executedFileAnalyser
652+
);
653+
}
654+
655+
return $this->executedFileAnalyser;
656+
}
618657
}

‎src/Node/Builder.php‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,23 @@
2222
use function substr;
2323
use SebastianBergmann\CodeCoverage\CodeCoverage;
2424
use SebastianBergmann\CodeCoverage\ProcessedCodeCoverageData;
25+
use SebastianBergmann\CodeCoverage\StaticAnalysis\ExecutedFileAnalyser;
2526

2627
/**
2728
* @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
2829
*/
2930
final class Builder
3031
{
32+
/**
33+
* @var ExecutedFileAnalyser
34+
*/
35+
private $executedFileAnalyser;
36+
37+
public function __construct(ExecutedFileAnalyser $executedFileAnalyser)
38+
{
39+
$this->executedFileAnalyser = $executedFileAnalyser;
40+
}
41+
3142
public function build(CodeCoverage $coverage): Directory
3243
{
3344
$data = clone $coverage->getData(); // clone because path munging is destructive to the original data
@@ -55,7 +66,13 @@ private function addItems(Directory $root, array $items, array $tests): void
5566
$key = substr($key, 0, -2);
5667

5768
if (file_exists($root->pathAsString() . DIRECTORY_SEPARATOR . $key)) {
58-
$root->addFile($key, $value['lineCoverage'], $value['functionCoverage'], $tests);
69+
$root->addFile(
70+
$key,
71+
$value['lineCoverage'],
72+
$value['functionCoverage'],
73+
$tests,
74+
$this->executedFileAnalyser
75+
);
5976
}
6077
} else {
6178
$child = $root->addDirectory($key);

‎src/Node/Directory.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
use function count;
1414
use IteratorAggregate;
1515
use RecursiveIteratorIterator;
16+
use SebastianBergmann\CodeCoverage\StaticAnalysis\ExecutedFileAnalyser;
1617
use SebastianBergmann\LinesOfCode\LinesOfCode;
1718

1819
/**
@@ -161,9 +162,9 @@ public function addDirectory(string $name): self
161162
return $directory;
162163
}
163164

164-
public function addFile(string $name, array $lineCoverageData, array $functionCoverageData, array $testData): void
165+
public function addFile(string $name, array $lineCoverageData, array $functionCoverageData, array $testData, ExecutedFileAnalyser $executedFileAnalyser): void
165166
{
166-
$file = new File($name, $this, $lineCoverageData, $functionCoverageData, $testData);
167+
$file = new File($name, $this, $lineCoverageData, $functionCoverageData, $testData, $executedFileAnalyser);
167168

168169
$this->children[] = $file;
169170
$this->files[] = &$this->children[count($this->children) - 1];

‎src/Node/File.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
use function count;
1414
use function range;
1515
use SebastianBergmann\CodeCoverage\CrapIndex;
16-
use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingExecutedFileAnalyser;
16+
use SebastianBergmann\CodeCoverage\StaticAnalysis\ExecutedFileAnalyser;
1717
use SebastianBergmann\LinesOfCode\LinesOfCode;
1818

1919
/**
@@ -126,15 +126,15 @@ final class File extends AbstractNode
126126
*/
127127
private $codeUnitsByLine = [];
128128

129-
public function __construct(string $name, AbstractNode $parent, array $lineCoverageData, array $functionCoverageData, array $testData)
129+
public function __construct(string $name, AbstractNode $parent, array $lineCoverageData, array $functionCoverageData, array $testData, ExecutedFileAnalyser $executedFileAnalyser)
130130
{
131131
parent::__construct($name, $parent);
132132

133133
$this->lineCoverageData = $lineCoverageData;
134134
$this->functionCoverageData = $functionCoverageData;
135135
$this->testData = $testData;
136136

137-
$this->calculateStatistics();
137+
$this->calculateStatistics($executedFileAnalyser);
138138
}
139139

140140
public function count(): int
@@ -328,17 +328,17 @@ public function numberOfTestedFunctions(): int
328328
return $this->numTestedFunctions;
329329
}
330330

331-
private function calculateStatistics(): void
331+
private function calculateStatistics(ExecutedFileAnalyser $executedFileAnalyser): void
332332
{
333-
$this->linesOfCode = CachingExecutedFileAnalyser::getInstance()->linesOfCodeFor($this->pathAsString());
333+
$this->linesOfCode = $executedFileAnalyser->linesOfCodeFor($this->pathAsString());
334334

335335
foreach (range(1, $this->linesOfCode->linesOfCode()) as $lineNumber) {
336336
$this->codeUnitsByLine[$lineNumber] = [];
337337
}
338338

339-
$this->processClasses(CachingExecutedFileAnalyser::getInstance()->classesIn($this->pathAsString()));
340-
$this->processTraits(CachingExecutedFileAnalyser::getInstance()->traitsIn($this->pathAsString()));
341-
$this->processFunctions(CachingExecutedFileAnalyser::getInstance()->functionsIn($this->pathAsString()));
339+
$this->processClasses($executedFileAnalyser->classesIn($this->pathAsString()));
340+
$this->processTraits($executedFileAnalyser->traitsIn($this->pathAsString()));
341+
$this->processFunctions($executedFileAnalyser->functionsIn($this->pathAsString()));
342342

343343
foreach (range(1, $this->linesOfCode->linesOfCode()) as $lineNumber) {
344344
if (isset($this->lineCoverageData[$lineNumber])) {

‎src/StaticAnalysis/CachingExecutedFileAnalyser.php‎

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,8 @@
2020
use SebastianBergmann\CodeCoverage\Directory;
2121
use SebastianBergmann\LinesOfCode\LinesOfCode;
2222

23-
/**
24-
* @todo Refactor how Node\File objects are created so a Singleton of this is not required
25-
*/
2623
final class CachingExecutedFileAnalyser implements ExecutedFileAnalyser
2724
{
28-
/**
29-
* @var ExecutedFileAnalyser
30-
*/
31-
private static $instance;
32-
3325
/**
3426
* @var string
3527
*/
@@ -40,24 +32,6 @@ final class CachingExecutedFileAnalyser implements ExecutedFileAnalyser
4032
*/
4133
private $executedFileAnalyser;
4234

43-
public static function createInstance(string $directory, bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode): ExecutedFileAnalyser
44-
{
45-
self::$instance = new self(
46-
$directory,
47-
new ParsingExecutedFileAnalyser(
48-
$useAnnotationsForIgnoringCode,
49-
$ignoreDeprecatedCode
50-
)
51-
);
52-
53-
return self::$instance;
54-
}
55-
56-
public static function getInstance(): ExecutedFileAnalyser
57-
{
58-
return self::$instance;
59-
}
60-
6135
public function __construct(string $directory, ExecutedFileAnalyser $executedFileAnalyser)
6236
{
6337
Directory::create($directory);

‎src/StaticAnalysis/ParsingExecutedFileAnalyser.php‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,8 @@
2525
use SebastianBergmann\LinesOfCode\LineCountingVisitor;
2626
use SebastianBergmann\LinesOfCode\LinesOfCode;
2727

28-
/**
29-
* @todo Refactor how Node\File objects are created so a Singleton of this is not required
30-
*/
3128
final class ParsingExecutedFileAnalyser implements ExecutedFileAnalyser
3229
{
33-
/**
34-
* @var ExecutedFileAnalyser
35-
*/
36-
private static $instance;
37-
3830
/**
3931
* @var array
4032
*/
@@ -70,18 +62,6 @@ final class ParsingExecutedFileAnalyser implements ExecutedFileAnalyser
7062
*/
7163
private $ignoreDeprecatedCode;
7264

73-
public static function createInstance(bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode): ExecutedFileAnalyser
74-
{
75-
self::$instance = new self($useAnnotationsForIgnoringCode, $ignoreDeprecatedCode);
76-
77-
return self::$instance;
78-
}
79-
80-
public static function getInstance(): ExecutedFileAnalyser
81-
{
82-
return self::$instance;
83-
}
84-
8565
public function __construct(bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode)
8666
{
8767
$this->useAnnotationsForIgnoringCode = $useAnnotationsForIgnoringCode;

‎tests/tests/BuilderTest.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
use ReflectionMethod;
1515
use SebastianBergmann\CodeCoverage\Node\Builder;
1616
use SebastianBergmann\CodeCoverage\ProcessedCodeCoverageData;
17+
use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingExecutedFileAnalyser;
1718
use SebastianBergmann\CodeCoverage\TestCase;
1819

1920
final class BuilderTest extends TestCase
@@ -22,7 +23,7 @@ final class BuilderTest extends TestCase
2223

2324
protected function setUp(): void
2425
{
25-
$this->factory = new Builder;
26+
$this->factory = new Builder(new ParsingExecutedFileAnalyser(true, true));
2627
}
2728

2829
public function testSomething(): void

0 commit comments

Comments
 (0)