Skip to content

Commit 12259bb

Browse files
sebastianbergmannsebastianbergmann
committed
Remove blacklist functionality and make using a whitelist mandatory
1 parent b8436b0 commit 12259bb

File tree

6 files changed

+29
-221
lines changed

6 files changed

+29
-221
lines changed

‎ChangeLog-3.0.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@ All notable changes of the PHP_CodeCoverage 3.0 release series are documented in
44

55
## [3.0.0] - 2015-10-02
66

7+
### Changed
8+
9+
* It is now mandatory to configure a whitelist
10+
711
### Removed
812

13+
* The blacklist functionality has been removed
914
* PHP_CodeCoverage is no longer supported on PHP 5.3, PHP 5.4, and PHP 5.5
1015

1116
[3.0.0]: https://github.com/sebastianbergmann/php-code-coverage/compare/2.2...3.0.0

‎src/CodeCoverage.php‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,6 @@ public function getData($raw = false)
155155
$this->addUncoveredFilesFromWhitelist();
156156
}
157157

158-
// We need to apply the blacklist filter a second time
159-
// when no whitelist is used.
160-
if (!$raw && !$this->filter->hasWhitelist()) {
161-
$this->applyListsFilter($this->data);
162-
}
163-
164158
return $this->data;
165159
}
166160

@@ -340,10 +334,6 @@ public function append(array $data, $id = null, $append = true, $linesToBeCovere
340334
*/
341335
public function merge(PHP_CodeCoverage $that)
342336
{
343-
$this->filter->setBlacklistedFiles(
344-
array_merge($this->filter->getBlacklistedFiles(), $that->filter()->getBlacklistedFiles())
345-
);
346-
347337
$this->filter->setWhitelistedFiles(
348338
array_merge($this->filter->getWhitelistedFiles(), $that->filter()->getWhitelistedFiles())
349339
);
@@ -538,7 +528,7 @@ private function applyCoversAnnotationFilter(array &$data, $linesToBeCovered, ar
538528
}
539529

540530
/**
541-
* Applies the blacklist/whitelist filtering.
531+
* Applies the whitelist filtering.
542532
*
543533
* @param array $data
544534
*/

‎src/CodeCoverage/Filter.php‎

Lines changed: 2 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -9,96 +9,19 @@
99
*/
1010

1111
/**
12-
* Filter for blacklisting and whitelisting of code coverage information.
12+
* Filter for whitelisting of code coverage information.
1313
*
1414
* @since Class available since Release 1.0.0
1515
*/
1616
class PHP_CodeCoverage_Filter
1717
{
18-
/**
19-
* Source files that are blacklisted.
20-
*
21-
* @var array
22-
*/
23-
private $blacklistedFiles = [];
24-
2518
/**
2619
* Source files that are whitelisted.
2720
*
2821
* @var array
2922
*/
3023
private $whitelistedFiles = [];
3124

32-
/**
33-
* Adds a directory to the blacklist (recursively).
34-
*
35-
* @param string $directory
36-
* @param string $suffix
37-
* @param string $prefix
38-
*/
39-
public function addDirectoryToBlacklist($directory, $suffix = '.php', $prefix = '')
40-
{
41-
$facade = new File_Iterator_Facade;
42-
$files = $facade->getFilesAsArray($directory, $suffix, $prefix);
43-
44-
foreach ($files as $file) {
45-
$this->addFileToBlacklist($file);
46-
}
47-
}
48-
49-
/**
50-
* Adds a file to the blacklist.
51-
*
52-
* @param string $filename
53-
*/
54-
public function addFileToBlacklist($filename)
55-
{
56-
$this->blacklistedFiles[realpath($filename)] = true;
57-
}
58-
59-
/**
60-
* Adds files to the blacklist.
61-
*
62-
* @param array $files
63-
*/
64-
public function addFilesToBlacklist(array $files)
65-
{
66-
foreach ($files as $file) {
67-
$this->addFileToBlacklist($file);
68-
}
69-
}
70-
71-
/**
72-
* Removes a directory from the blacklist (recursively).
73-
*
74-
* @param string $directory
75-
* @param string $suffix
76-
* @param string $prefix
77-
*/
78-
public function removeDirectoryFromBlacklist($directory, $suffix = '.php', $prefix = '')
79-
{
80-
$facade = new File_Iterator_Facade;
81-
$files = $facade->getFilesAsArray($directory, $suffix, $prefix);
82-
83-
foreach ($files as $file) {
84-
$this->removeFileFromBlacklist($file);
85-
}
86-
}
87-
88-
/**
89-
* Removes a file from the blacklist.
90-
*
91-
* @param string $filename
92-
*/
93-
public function removeFileFromBlacklist($filename)
94-
{
95-
$filename = realpath($filename);
96-
97-
if (isset($this->blacklistedFiles[$filename])) {
98-
unset($this->blacklistedFiles[$filename]);
99-
}
100-
}
101-
10225
/**
10326
* Adds a directory to the whitelist (recursively).
10427
*
@@ -194,9 +117,6 @@ public function isFile($filename)
194117
/**
195118
* Checks whether or not a file is filtered.
196119
*
197-
* When the whitelist is empty (default), blacklisting is used.
198-
* When the whitelist is not empty, whitelisting is used.
199-
*
200120
* @param string $filename
201121
* @return bool
202122
*/
@@ -208,21 +128,7 @@ public function isFiltered($filename)
208128

209129
$filename = realpath($filename);
210130

211-
if (!empty($this->whitelistedFiles)) {
212-
return !isset($this->whitelistedFiles[$filename]);
213-
}
214-
215-
return isset($this->blacklistedFiles[$filename]);
216-
}
217-
218-
/**
219-
* Returns the list of blacklisted files.
220-
*
221-
* @return array
222-
*/
223-
public function getBlacklist()
224-
{
225-
return array_keys($this->blacklistedFiles);
131+
return !isset($this->whitelistedFiles[$filename]);
226132
}
227133

228134
/**
@@ -246,28 +152,6 @@ public function hasWhitelist()
246152
return !empty($this->whitelistedFiles);
247153
}
248154

249-
/**
250-
* Returns the blacklisted files.
251-
*
252-
* @return array
253-
* @since Method available since Release 2.0.0
254-
*/
255-
public function getBlacklistedFiles()
256-
{
257-
return $this->blacklistedFiles;
258-
}
259-
260-
/**
261-
* Sets the blacklisted files.
262-
*
263-
* @param array $blacklistedFiles
264-
* @since Method available since Release 2.0.0
265-
*/
266-
public function setBlacklistedFiles($blacklistedFiles)
267-
{
268-
$this->blacklistedFiles = $blacklistedFiles;
269-
}
270-
271155
/**
272156
* Returns the whitelisted files.
273157
*

‎src/CodeCoverage/Report/PHP.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,11 @@ public function process(PHP_CodeCoverage $coverage, $target = null)
3131
$coverage->setTests(%s);
3232
3333
$filter = $coverage->filter();
34-
$filter->setBlacklistedFiles(%s);
3534
$filter->setWhitelistedFiles(%s);
3635
3736
return $coverage;',
3837
var_export($coverage->getData(true), 1),
3938
var_export($coverage->getTests(), 1),
40-
var_export($filter->getBlacklistedFiles(), 1),
4139
var_export($filter->getWhitelistedFiles(), 1)
4240
);
4341

‎tests/PHP/CodeCoverage/FilterTest.php‎

Lines changed: 1 addition & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -75,80 +75,6 @@ protected function setUp()
7575
];
7676
}
7777

78-
/**
79-
* @covers PHP_CodeCoverage_Filter::addFileToBlacklist
80-
* @covers PHP_CodeCoverage_Filter::getBlacklist
81-
*/
82-
public function testAddingAFileToTheBlacklistWorks()
83-
{
84-
$this->filter->addFileToBlacklist($this->files[0]);
85-
86-
$this->assertEquals(
87-
[$this->files[0]],
88-
$this->filter->getBlacklist()
89-
);
90-
}
91-
92-
/**
93-
* @covers PHP_CodeCoverage_Filter::removeFileFromBlacklist
94-
* @covers PHP_CodeCoverage_Filter::getBlacklist
95-
*/
96-
public function testRemovingAFileFromTheBlacklistWorks()
97-
{
98-
$this->filter->addFileToBlacklist($this->files[0]);
99-
$this->filter->removeFileFromBlacklist($this->files[0]);
100-
101-
$this->assertEquals([], $this->filter->getBlacklist());
102-
}
103-
104-
/**
105-
* @covers PHP_CodeCoverage_Filter::addDirectoryToBlacklist
106-
* @covers PHP_CodeCoverage_Filter::getBlacklist
107-
* @depends testAddingAFileToTheBlacklistWorks
108-
*/
109-
public function testAddingADirectoryToTheBlacklistWorks()
110-
{
111-
$this->filter->addDirectoryToBlacklist(TEST_FILES_PATH);
112-
113-
$blacklist = $this->filter->getBlacklist();
114-
sort($blacklist);
115-
116-
$this->assertEquals($this->files, $blacklist);
117-
}
118-
119-
/**
120-
* @covers PHP_CodeCoverage_Filter::addFilesToBlacklist
121-
* @covers PHP_CodeCoverage_Filter::getBlacklist
122-
*/
123-
public function testAddingFilesToTheBlacklistWorks()
124-
{
125-
$facade = new File_Iterator_Facade;
126-
$files = $facade->getFilesAsArray(
127-
TEST_FILES_PATH,
128-
$suffixes = '.php'
129-
);
130-
131-
$this->filter->addFilesToBlacklist($files);
132-
133-
$blacklist = $this->filter->getBlacklist();
134-
sort($blacklist);
135-
136-
$this->assertEquals($this->files, $blacklist);
137-
}
138-
139-
/**
140-
* @covers PHP_CodeCoverage_Filter::removeDirectoryFromBlacklist
141-
* @covers PHP_CodeCoverage_Filter::getBlacklist
142-
* @depends testAddingADirectoryToTheBlacklistWorks
143-
*/
144-
public function testRemovingADirectoryFromTheBlacklistWorks()
145-
{
146-
$this->filter->addDirectoryToBlacklist(TEST_FILES_PATH);
147-
$this->filter->removeDirectoryFromBlacklist(TEST_FILES_PATH);
148-
149-
$this->assertEquals([], $this->filter->getBlacklist());
150-
}
151-
15278
/**
15379
* @covers PHP_CodeCoverage_Filter::addFileToWhitelist
15480
* @covers PHP_CodeCoverage_Filter::getWhitelist
@@ -192,7 +118,7 @@ public function testAddingADirectoryToTheWhitelistWorks()
192118

193119
/**
194120
* @covers PHP_CodeCoverage_Filter::addFilesToWhitelist
195-
* @covers PHP_CodeCoverage_Filter::getBlacklist
121+
* @covers PHP_CodeCoverage_Filter::getWhitelist
196122
*/
197123
public function testAddingFilesToTheWhitelistWorks()
198124
{
@@ -237,15 +163,6 @@ public function testIsFile()
237163
$this->assertTrue($this->filter->isFile(__FILE__));
238164
}
239165

240-
/**
241-
* @covers PHP_CodeCoverage_Filter::isFiltered
242-
*/
243-
public function testBlacklistedFileIsFiltered()
244-
{
245-
$this->filter->addFileToBlacklist($this->files[0]);
246-
$this->assertTrue($this->filter->isFiltered($this->files[0]));
247-
}
248-
249166
/**
250167
* @covers PHP_CodeCoverage_Filter::isFiltered
251168
*/
@@ -276,6 +193,5 @@ public function testNonFilesAreFiltered()
276193
$this->assertTrue($this->filter->isFiltered('runtime-created function'));
277194
$this->assertTrue($this->filter->isFiltered('assert code'));
278195
$this->assertTrue($this->filter->isFiltered('regexp code'));
279-
$this->assertFalse($this->filter->isFiltered(__FILE__));
280196
}
281197
}

‎tests/TestCase.php‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,10 @@ protected function getCoverageForBankAccount()
8181
$data[3]
8282
));
8383

84-
$coverage = new PHP_CodeCoverage($stub, new PHP_CodeCoverage_Filter);
84+
$filter = new PHP_CodeCoverage_Filter;
85+
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
86+
87+
$coverage = new PHP_CodeCoverage($stub, $filter);
8588

8689
$coverage->start(
8790
new BankAccountTest('testBalanceIsInitiallyZero'),
@@ -141,7 +144,10 @@ protected function getCoverageForBankAccountForFirstTwoTests()
141144
$data[1]
142145
));
143146

144-
$coverage = new PHP_CodeCoverage($stub, new PHP_CodeCoverage_Filter);
147+
$filter = new PHP_CodeCoverage_Filter;
148+
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
149+
150+
$coverage = new PHP_CodeCoverage($stub, $filter);
145151

146152
$coverage->start(
147153
new BankAccountTest('testBalanceIsInitiallyZero'),
@@ -177,7 +183,10 @@ protected function getCoverageForBankAccountForLastTwoTests()
177183
$data[3]
178184
));
179185

180-
$coverage = new PHP_CodeCoverage($stub, new PHP_CodeCoverage_Filter);
186+
$filter = new PHP_CodeCoverage_Filter;
187+
$filter->addFileToWhitelist(TEST_FILES_PATH . 'BankAccount.php');
188+
189+
$coverage = new PHP_CodeCoverage($stub, $filter);
181190

182191
$coverage->start(
183192
new BankAccountTest('testBalanceCannotBecomeNegative2')
@@ -242,9 +251,12 @@ protected function getExpectedDataArrayForBankAccount()
242251

243252
protected function getCoverageForFileWithIgnoredLines()
244253
{
254+
$filter = new PHP_CodeCoverage_Filter;
255+
$filter->addFileToWhitelist(TEST_FILES_PATH . 'source_with_ignore.php');
256+
245257
$coverage = new PHP_CodeCoverage(
246258
$this->setUpXdebugStubForFileWithIgnoredLines(),
247-
new PHP_CodeCoverage_Filter
259+
$filter
248260
);
249261

250262
$coverage->start('FileWithIgnoredLines', true);
@@ -274,9 +286,12 @@ protected function setUpXdebugStubForFileWithIgnoredLines()
274286

275287
protected function getCoverageForClassWithAnonymousFunction()
276288
{
289+
$filter = new PHP_CodeCoverage_Filter;
290+
$filter->addFileToWhitelist(TEST_FILES_PATH . 'source_with_class_and_anonymous_function.php');
291+
277292
$coverage = new PHP_CodeCoverage(
278293
$this->setUpXdebugStubForClassWithAnonymousFunction(),
279-
new PHP_CodeCoverage_Filter
294+
$filter
280295
);
281296

282297
$coverage->start('ClassWithAnonymousFunction', true);

0 commit comments

Comments
 (0)