Skip to content

Commit adabe34

Browse files
sebastianbergmannsebastianbergmann
committed
1 parent db5c61d commit adabe34

File tree

7 files changed

+99
-18
lines changed

7 files changed

+99
-18
lines changed

‎ChangeLog.markdown‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ PHP_CodeCoverage 1.1.0
88

99
* Added support for merging serialized-to-disk `PHP_CodeCoverage` objects using `phpcov --merge`.
1010
* Added support for traits.
11+
* Added an option to disable the caching of `PHP_Token_Stream` objects to reduce the memory usage.
1112
* Refactored the collection and processing of code coverage data improving code readability and performance.
1213
* Refactored the generation of Clover XML and HTML reports improving code readability and testability.
1314
* Removed the support for multiple blacklist groups.

‎PHP/CodeCoverage.php‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ class PHP_CodeCoverage
6767
*/
6868
protected $filter;
6969

70+
/**
71+
* @var boolean
72+
*/
73+
protected $cacheTokens = TRUE;
74+
7075
/**
7176
* @var boolean
7277
*/
@@ -321,6 +326,19 @@ public function merge(PHP_CodeCoverage $that)
321326
$this->tests = array_merge($this->tests, $that->getTests());
322327
}
323328

329+
/**
330+
* @param boolean $flag
331+
* @throws InvalidArgumentException
332+
*/
333+
public function setCacheTokens($flag)
334+
{
335+
if (!is_bool($flag)) {
336+
throw new InvalidArgumentException;
337+
}
338+
339+
$this->cacheTokens = $flag;
340+
}
341+
324342
/**
325343
* @param boolean $flag
326344
* @throws InvalidArgumentException
@@ -449,7 +467,12 @@ protected function processUncoveredFilesFromWhitelist()
449467
);
450468

451469
foreach ($uncoveredFiles as $uncoveredFile) {
452-
$tokens = PHP_Token_Stream_CachingFactory::get($uncoveredFile);
470+
if ($this->cacheTokens) {
471+
$tokens = PHP_Token_Stream_CachingFactory::get($uncoveredFile);
472+
} else {
473+
$tokens = new PHP_Token_Stream($uncoveredFile);
474+
}
475+
453476
$classes = $tokens->getClasses();
454477
$interfaces = $tokens->getInterfaces();
455478
$functions = $tokens->getFunctions();

‎PHP/CodeCoverage/Report/Clover.php‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,24 @@
5757
*/
5858
class PHP_CodeCoverage_Report_Clover
5959
{
60+
/**
61+
* @var boolean
62+
*/
63+
protected $cacheTokens;
64+
65+
/**
66+
* @param boolean $cacheTokens
67+
* @throws InvalidArgumentException
68+
*/
69+
public function __construct($cacheTokens = TRUE)
70+
{
71+
if (!is_bool($cacheTokens)) {
72+
throw new InvalidArgumentException;
73+
}
74+
75+
$this->cacheTokens = $cacheTokens;
76+
}
77+
6078
/**
6179
* @param PHP_CodeCoverage $coverage
6280
* @param string $target
@@ -114,13 +132,18 @@ public function process(PHP_CodeCoverage $coverage, $target = NULL, $name = NULL
114132
$file = $document->createElement('file');
115133
$file->setAttribute('name', $filename);
116134

117-
$tokens = PHP_Token_Stream_CachingFactory::get($filename);
135+
if ($this->cacheTokens) {
136+
$tokens = PHP_Token_Stream_CachingFactory::get($filename);
137+
} else {
138+
$tokens = new PHP_Token_Stream($filename);
139+
}
140+
118141
$classesInFile = $tokens->getClasses();
119142
$linesOfCode = $tokens->getLinesOfCode();
120143
unset($tokens);
121144

122145
$ignoredLines = PHP_CodeCoverage_Util::getLinesToBeIgnored(
123-
$filename
146+
$filename, $this->cacheTokens
124147
);
125148

126149
$lines = array();

‎PHP/CodeCoverage/Report/HTML.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ public function __construct(array $options = array())
8282
$options['charset'] = 'UTF-8';
8383
}
8484

85+
if (!isset($options['cacheTokens'])) {
86+
$options['cacheTokens'] = TRUE;
87+
}
88+
8589
if (!isset($options['yui'])) {
8690
$options['yui'] = TRUE;
8791
}
@@ -206,6 +210,7 @@ protected function addItems(PHP_CodeCoverage_Report_HTML_Node_Directory $root, a
206210
substr($key, 0, -2),
207211
$value,
208212
$tests,
213+
$this->options['cacheTokens'],
209214
$this->options['yui'],
210215
$this->options['highlight']
211216
);

‎PHP/CodeCoverage/Report/HTML/Node/Directory.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,15 +143,16 @@ public function addDirectory($name)
143143
* @param string $name
144144
* @param array $coverageData
145145
* @param array $testData
146+
* @param boolean $cacheTokens
146147
* @param boolean $yui
147148
* @param boolean $highlight
148149
* @return PHP_CodeCoverage_Report_HTML_Node_File
149150
* @throws PHP_CodeCoverage_Exception
150151
*/
151-
public function addFile($name, array $coverageData, array $testData, $yui, $highlight)
152+
public function addFile($name, array $coverageData, array $testData, $cacheTokens, $yui, $highlight)
152153
{
153154
$file = new PHP_CodeCoverage_Report_HTML_Node_File(
154-
$name, $this, $coverageData, $testData, $yui, $highlight
155+
$name, $this, $coverageData, $testData, $cacheTokens, $yui, $highlight
155156
);
156157

157158
$this->children[] = $file;

‎PHP/CodeCoverage/Report/HTML/Node/File.php‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@ class PHP_CodeCoverage_Report_HTML_Node_File extends PHP_CodeCoverage_Report_HTM
8181
*/
8282
protected $testData;
8383

84+
/**
85+
* @var boolean
86+
*/
87+
protected $cacheTokens = TRUE;
88+
8489
/**
8590
* @var boolean
8691
*/
@@ -148,11 +153,12 @@ class PHP_CodeCoverage_Report_HTML_Node_File extends PHP_CodeCoverage_Report_HTM
148153
* @param PHP_CodeCoverage_Report_HTML_Node $parent
149154
* @param array $coverageData
150155
* @param array $testData
156+
* @param boolean $cacheTokens
151157
* @param boolean $yui
152158
* @param boolean $highlight
153159
* @throws PHP_CodeCoverage_Exception
154160
*/
155-
public function __construct($name, PHP_CodeCoverage_Report_HTML_Node $parent, array $coverageData, array $testData, $yui = TRUE, $highlight = FALSE)
161+
public function __construct($name, PHP_CodeCoverage_Report_HTML_Node $parent, array $coverageData, array $testData, $cacheTokens, $yui, $highlight)
156162
{
157163
parent::__construct($name, $parent);
158164

@@ -166,11 +172,12 @@ public function __construct($name, PHP_CodeCoverage_Report_HTML_Node $parent, ar
166172

167173
$this->coverageData = $coverageData;
168174
$this->testData = $testData;
175+
$this->cacheTokens = $cacheTokens;
169176
$this->highlight = $highlight;
170177
$this->yui = $yui;
171178
$this->codeLines = $this->loadFile($path);
172179
$this->ignoredLines = PHP_CodeCoverage_Util::getLinesToBeIgnored(
173-
$path
180+
$path, $cacheTokens
174181
);
175182

176183
$this->calculateStatistics();
@@ -830,8 +837,14 @@ protected function loadFile($file)
830837

831838
protected function processClasses()
832839
{
833-
$file = $this->getId() . '.html#';
834-
$tokens = PHP_Token_Stream_CachingFactory::get($this->getPath());
840+
$file = $this->getId() . '.html#';
841+
842+
if ($this->cacheTokens) {
843+
$tokens = PHP_Token_Stream_CachingFactory::get($this->getPath());
844+
} else {
845+
$tokens = new PHP_Token_Stream($this->getPath());
846+
}
847+
835848
$classes = $tokens->getClasses();
836849
unset($tokens);
837850

@@ -870,7 +883,12 @@ protected function processClasses()
870883

871884
protected function processFunctions()
872885
{
873-
$tokens = PHP_Token_Stream_CachingFactory::get($this->getPath());
886+
if ($this->cacheTokens) {
887+
$tokens = PHP_Token_Stream_CachingFactory::get($this->getPath());
888+
} else {
889+
$tokens = new PHP_Token_Stream($this->getPath());
890+
}
891+
874892
$functions = $tokens->getFunctions();
875893
unset($tokens);
876894

‎PHP/CodeCoverage/Util.php‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -265,20 +265,30 @@ public static function getLinesToBeCovered($className, $methodName)
265265
/**
266266
* Returns the lines of a source file that should be ignored.
267267
*
268-
* @param string $filename
268+
* @param string $filename
269+
* @param boolean $cacheTokens
269270
* @return array
271+
* @throws InvalidArgumentException
270272
*/
271-
public static function getLinesToBeIgnored($filename)
273+
public static function getLinesToBeIgnored($filename, $cacheTokens = TRUE)
272274
{
275+
if (!is_bool($cacheTokens)) {
276+
throw new InvalidArgumentException;
277+
}
278+
273279
if (!isset(self::$ignoredLines[$filename])) {
274280
self::$ignoredLines[$filename] = array();
281+
$ignore = FALSE;
282+
$stop = FALSE;
283+
284+
if ($cacheTokens) {
285+
$tokens = PHP_Token_Stream_CachingFactory::get($filename);
286+
} else {
287+
$tokens = new PHP_Token_Stream($filename);
288+
}
275289

276-
$ignore = FALSE;
277-
$stop = FALSE;
278-
$stream = PHP_Token_Stream_CachingFactory::get($filename);
279-
$tokens = $stream->tokens();
280-
$classes = $stream->getClasses();
281-
unset($stream);
290+
$classes = $tokens->getClasses();
291+
$tokens = $tokens->tokens();
282292

283293
foreach ($tokens as $token) {
284294
switch (get_class($token)) {

0 commit comments

Comments
 (0)