Skip to content

Commit fb35cb5

Browse files
sebastianbergmannsebastianbergmann
committed
Initial work on issue sebastianbergmann#139.
1 parent 40af62f commit fb35cb5

File tree

8 files changed

+323
-350
lines changed

8 files changed

+323
-350
lines changed

‎PHP/CodeCoverage.php

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,11 @@ class PHP_CodeCoverage
108108
*/
109109
protected $data = array();
110110

111+
/**
112+
* @var array
113+
*/
114+
protected $ignoredLines = array();
115+
111116
/**
112117
* Test data.
113118
*
@@ -266,6 +271,7 @@ public function append(array $data, $id = NULL, $append = TRUE)
266271
}
267272

268273
$this->applyListsFilter($data);
274+
$this->applyIgnoredLinesFilter($data);
269275
$this->initializeFilesThatAreSeenTheFirstTime($data);
270276

271277
if (!$append) {
@@ -525,6 +531,20 @@ protected function applyListsFilter(&$data)
525531
}
526532
}
527533

534+
/**
535+
* Applies the "ignored lines" filtering.
536+
*
537+
* @param array $data
538+
*/
539+
protected function applyIgnoredLinesFilter(&$data)
540+
{
541+
foreach (array_keys($data) as $filename) {
542+
foreach ($this->getLinesToBeIgnored($filename) as $line) {
543+
unset($data[$filename][$line]);
544+
}
545+
}
546+
}
547+
528548
/**
529549
* @since Method available since Release 1.1.0
530550
*/
@@ -825,4 +845,175 @@ class_parents($coveredElement)
825845

826846
return $codeToCoverList;
827847
}
848+
849+
/**
850+
* Returns the lines of a source file that should be ignored.
851+
*
852+
* @param string $filename
853+
* @return array
854+
* @throws PHP_CodeCoverage_Exception
855+
* @since Method available since Release 1.3.0
856+
*/
857+
protected function getLinesToBeIgnored($filename)
858+
{
859+
if (!is_string($filename)) {
860+
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
861+
1, 'string'
862+
);
863+
}
864+
865+
if (!isset($this->ignoredLines[$filename])) {
866+
$this->ignoredLines[$filename] = array();
867+
$ignore = FALSE;
868+
$stop = FALSE;
869+
$lines = file($filename);
870+
871+
foreach ($lines as $index => $line) {
872+
if (!trim($line)) {
873+
$this->ignoredLines[$filename][] = $index + 1;
874+
}
875+
}
876+
877+
if ($this->cacheTokens) {
878+
$tokens = PHP_Token_Stream_CachingFactory::get($filename);
879+
} else {
880+
$tokens = new PHP_Token_Stream($filename);
881+
}
882+
883+
$classes = array_merge($tokens->getClasses(), $tokens->getTraits());
884+
$tokens = $tokens->tokens();
885+
886+
foreach ($tokens as $token) {
887+
switch (get_class($token)) {
888+
case 'PHP_Token_COMMENT':
889+
case 'PHP_Token_DOC_COMMENT': {
890+
$count = substr_count($token, "\n");
891+
$line = $token->getLine();
892+
893+
for ($i = $line; $i < $line + $count; $i++) {
894+
$this->ignoredLines[$filename][] = $i;
895+
}
896+
897+
if ($token instanceof PHP_Token_DOC_COMMENT) {
898+
// Workaround for the fact the DOC_COMMENT token
899+
// does not include the final \n character in its
900+
// text.
901+
if (substr(trim($lines[$i-1]), -2) == '*/') {
902+
$this->ignoredLines[$filename][] = $i;
903+
}
904+
905+
break;
906+
}
907+
908+
$_token = trim($token);
909+
910+
if ($_token == '// @codeCoverageIgnore' ||
911+
$_token == '//@codeCoverageIgnore') {
912+
$ignore = TRUE;
913+
$stop = TRUE;
914+
}
915+
916+
else if ($_token == '// @codeCoverageIgnoreStart' ||
917+
$_token == '//@codeCoverageIgnoreStart') {
918+
$ignore = TRUE;
919+
}
920+
921+
else if ($_token == '// @codeCoverageIgnoreEnd' ||
922+
$_token == '//@codeCoverageIgnoreEnd') {
923+
$stop = TRUE;
924+
}
925+
}
926+
break;
927+
928+
case 'PHP_Token_INTERFACE':
929+
case 'PHP_Token_TRAIT':
930+
case 'PHP_Token_CLASS':
931+
case 'PHP_Token_FUNCTION': {
932+
$docblock = $token->getDocblock();
933+
934+
if (strpos($docblock, '@codeCoverageIgnore')) {
935+
$endLine = $token->getEndLine();
936+
937+
for ($i = $token->getLine(); $i <= $endLine; $i++) {
938+
$this->ignoredLines[$filename][] = $i;
939+
}
940+
}
941+
942+
else if ($token instanceof PHP_Token_INTERFACE ||
943+
$token instanceof PHP_Token_TRAIT ||
944+
$token instanceof PHP_Token_CLASS) {
945+
if (empty($classes[$token->getName()]['methods'])) {
946+
for ($i = $token->getLine();
947+
$i <= $token->getEndLine();
948+
$i++) {
949+
$this->ignoredLines[$filename][] = $i;
950+
}
951+
} else {
952+
$firstMethod = array_shift(
953+
$classes[$token->getName()]['methods']
954+
);
955+
956+
$lastMethod = array_pop(
957+
$classes[$token->getName()]['methods']
958+
);
959+
960+
if ($lastMethod === NULL) {
961+
$lastMethod = $firstMethod;
962+
}
963+
964+
for ($i = $token->getLine();
965+
$i < $firstMethod['startLine'];
966+
$i++) {
967+
$this->ignoredLines[$filename][] = $i;
968+
}
969+
970+
for ($i = $token->getEndLine();
971+
$i > $lastMethod['endLine'];
972+
$i--) {
973+
$this->ignoredLines[$filename][] = $i;
974+
}
975+
}
976+
}
977+
}
978+
break;
979+
980+
case 'PHP_Token_INTERFACE': {
981+
$endLine = $token->getEndLine();
982+
983+
for ($i = $token->getLine(); $i <= $endLine; $i++) {
984+
$this->ignoredLines[$filename][] = $i;
985+
}
986+
}
987+
break;
988+
989+
case 'PHP_Token_NAMESPACE': {
990+
$this->ignoredLines[$filename][] = $token->getEndLine();
991+
} // Intentional fallthrough
992+
case 'PHP_Token_OPEN_TAG':
993+
case 'PHP_Token_CLOSE_TAG':
994+
case 'PHP_Token_USE': {
995+
$this->ignoredLines[$filename][] = $token->getLine();
996+
}
997+
break;
998+
}
999+
1000+
if ($ignore) {
1001+
$this->ignoredLines[$filename][] = $token->getLine();
1002+
1003+
if ($stop) {
1004+
$ignore = FALSE;
1005+
$stop = FALSE;
1006+
}
1007+
}
1008+
}
1009+
1010+
$this->ignoredLines[$filename] = array_unique(
1011+
$this->ignoredLines[$filename]
1012+
);
1013+
1014+
sort($this->ignoredLines[$filename]);
1015+
}
1016+
1017+
return $this->ignoredLines[$filename];
1018+
}
8281019
}

‎PHP/CodeCoverage/Report/Clover.php

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,9 @@ public function process(PHP_CodeCoverage $coverage, $target = NULL, $name = NULL
9494
$xmlFile = $xmlDocument->createElement('file');
9595
$xmlFile->setAttribute('name', $item->getPath());
9696

97-
$classes = $item->getClassesAndTraits();
98-
$coverage = $item->getCoverageData();
99-
$lines = array();
100-
$ignoredLines = $item->getIgnoredLines();
97+
$classes = $item->getClassesAndTraits();
98+
$coverage = $item->getCoverageData();
99+
$lines = array();
101100

102101
foreach ($classes as $className => $class) {
103102
$classStatements = 0;
@@ -112,10 +111,6 @@ public function process(PHP_CodeCoverage $coverage, $target = NULL, $name = NULL
112111
for ($i = $method['startLine'];
113112
$i <= $method['endLine'];
114113
$i++) {
115-
if (isset($ignoredLines[$i])) {
116-
continue;
117-
}
118-
119114
$add = TRUE;
120115
$count = 0;
121116

@@ -216,9 +211,7 @@ public function process(PHP_CodeCoverage $coverage, $target = NULL, $name = NULL
216211
}
217212

218213
foreach ($coverage as $line => $data) {
219-
if ($data === NULL ||
220-
isset($lines[$line]) ||
221-
isset($ignoredLines[$line])) {
214+
if ($data === NULL || isset($lines[$line])) {
222215
continue;
223216
}
224217

@@ -230,10 +223,6 @@ public function process(PHP_CodeCoverage $coverage, $target = NULL, $name = NULL
230223
ksort($lines);
231224

232225
foreach ($lines as $line => $data) {
233-
if (isset($ignoredLines[$line])) {
234-
continue;
235-
}
236-
237226
$xmlLine = $xmlDocument->createElement('line');
238227
$xmlLine->setAttribute('num', $line);
239228
$xmlLine->setAttribute('type', $data['type']);

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,6 @@ protected function renderFunctionOrMethodItem(Text_Template $template, array $it
305305
protected function renderSource(PHP_CodeCoverage_Report_Node_File $node)
306306
{
307307
$coverageData = $node->getCoverageData();
308-
$ignoredLines = $node->getIgnoredLines();
309308
$testData = $node->getTestData();
310309
$codeLines = $this->loadFile($node->getPath());
311310
$lines = '';
@@ -317,7 +316,7 @@ protected function renderSource(PHP_CodeCoverage_Report_Node_File $node)
317316
$popoverContent = '';
318317
$popoverTitle = '';
319318

320-
if (!isset($ignoredLines[$i]) && isset($coverageData[$i])) {
319+
if (isset($coverageData[$i])) {
321320
$numTests = count($coverageData[$i]);
322321

323322
if ($coverageData[$i] === NULL) {

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

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,6 @@ class PHP_CodeCoverage_Report_Node_File extends PHP_CodeCoverage_Report_Node
6666
*/
6767
protected $testData;
6868

69-
/**
70-
* @var array
71-
*/
72-
protected $ignoredLines;
73-
7469
/**
7570
* @var integer
7671
*/
@@ -163,9 +158,6 @@ public function __construct($name, PHP_CodeCoverage_Report_Node $parent, array $
163158

164159
$this->coverageData = $coverageData;
165160
$this->testData = $testData;
166-
$this->ignoredLines = PHP_CodeCoverage_Util::getLinesToBeIgnored(
167-
$this->getPath(), $cacheTokens
168-
);
169161
$this->cacheTokens = $cacheTokens;
170162

171163
$this->calculateStatistics();
@@ -201,14 +193,6 @@ public function getTestData()
201193
return $this->testData;
202194
}
203195

204-
/**
205-
* @return array
206-
*/
207-
public function getIgnoredLines()
208-
{
209-
return $this->ignoredLines;
210-
}
211-
212196
/**
213197
* Returns the classes of this node.
214198
*
@@ -442,8 +426,7 @@ protected function calculateStatistics()
442426
}
443427
}
444428

445-
if (!isset($this->ignoredLines[$lineNumber]) &&
446-
isset($this->coverageData[$lineNumber]) &&
429+
if (isset($this->coverageData[$lineNumber]) &&
447430
$this->coverageData[$lineNumber] !== NULL) {
448431
if (isset($currentClass)) {
449432
$currentClass['executableLines']++;
@@ -463,8 +446,7 @@ protected function calculateStatistics()
463446

464447
$this->numExecutableLines++;
465448

466-
if (count($this->coverageData[$lineNumber]) > 0 ||
467-
isset($this->ignoredLines[$lineNumber])) {
449+
if (count($this->coverageData[$lineNumber]) > 0) {
468450
if (isset($currentClass)) {
469451
$currentClass['executedLines']++;
470452
}

‎PHP/CodeCoverage/Report/Text.php

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,9 @@ public function process(PHP_CodeCoverage $coverage, $showColors = FALSE)
151151
continue;
152152
}
153153

154-
$classes = $item->getClassesAndTraits();
155-
$coverage = $item->getCoverageData();
156-
$lines = array();
157-
$ignoredLines = $item->getIgnoredLines();
154+
$classes = $item->getClassesAndTraits();
155+
$coverage = $item->getCoverageData();
156+
$lines = array();
158157

159158
foreach ($classes as $className => $class) {
160159
$classStatements = 0;
@@ -169,10 +168,6 @@ public function process(PHP_CodeCoverage $coverage, $showColors = FALSE)
169168
for ($i = $method['startLine'];
170169
$i <= $method['endLine'];
171170
$i++) {
172-
if (isset($ignoredLines[$i])) {
173-
continue;
174-
}
175-
176171
$add = TRUE;
177172
$count = 0;
178173

0 commit comments

Comments
 (0)