Implement blacklist groups.

Author: sebastianbergmann

PHP/CodeCoverage/Filter.php

@@ -86,17 +86,18 @@ class PHP_CodeCoverage_Filter
      * @param  string $directory
      * @param  string $suffix
      * @param  string $prefix
+     * @param  string $group
      * @throws RuntimeException
      */
-    public function addDirectoryToBlacklist($directory, $suffix = '.php', $prefix = '')
+    public function addDirectoryToBlacklist($directory, $suffix = '.php', $prefix = '', $group = 'DEFAULT')
     {
         if (file_exists($directory)) {
             $files = File_Iterator_Factory::getFileIterator(
               $directory, $suffix, $prefix
             );
 
             foreach ($files as $file) {
-                $this->addFileToBlacklist($file->getPathName());
+                $this->addFileToBlacklist($file->getPathName(), $group);
             }
         } else {
             throw new RuntimeException($directory . ' does not exist');
@@ -107,15 +108,20 @@ public function addDirectoryToBlacklist($directory, $suffix = '.php', $prefix =
      * Adds a new file to be filtered (blacklist).
      *
      * @param  string $filename
+     * @param  string $group
      * @throws RuntimeException
      */
-    public function addFileToBlacklist($filename)
+    public function addFileToBlacklist($filename, $group = 'DEFAULT')
     {
         if (file_exists($filename)) {
             $filename = realpath($filename);
 
-            if (!in_array($filename, $this->blacklistedFiles)) {
-                $this->blacklistedFiles[] = $filename;
+            if (!isset($this->blacklistedFiles[$group])) {
+                $this->blacklistedFiles[$group] = array($filename);
+            }
+
+            else if (!in_array($filename, $this->blacklistedFiles[$group])) {
+                $this->blacklistedFiles[$group][] = $filename;
             }
         } else {
             throw new RuntimeException($filename . ' does not exist');
@@ -128,17 +134,18 @@ public function addFileToBlacklist($filename)
      * @param  string $directory
      * @param  string $suffix
      * @param  string $prefix
+     * @param  string $group
      * @throws RuntimeException
      */
-    public function removeDirectoryFromBlacklist($directory, $suffix = '.php', $prefix = '')
+    public function removeDirectoryFromBlacklist($directory, $suffix = '.php', $prefix = '', $group = 'DEFAULT')
     {
         if (file_exists($directory)) {
             $files = File_Iterator_Factory::getFileIterator(
               $directory, $suffix, $prefix
             );
 
             foreach ($files as $file) {
-                $this->removeFileFromBlacklist($file->getPathName());
+                $this->removeFileFromBlacklist($file->getPathName(), $group);
             }
         } else {
             throw new RuntimeException($directory . ' does not exist');
@@ -149,16 +156,19 @@ public function removeDirectoryFromBlacklist($directory, $suffix = '.php', $pref
      * Removes a file from the filter (blacklist).
      *
      * @param  string $filename
+     * @param  string $group
      * @throws RuntimeException
      */
-    public function removeFileFromBlacklist($filename)
+    public function removeFileFromBlacklist($filename, $group = 'DEFAULT')
     {
         if (file_exists($filename)) {
-            $filename = realpath($filename);
+            if (isset($this->blacklistedFiles[$group])) {
+                $filename = realpath($filename);
 
-            foreach ($this->blacklistedFiles as $key => $_filename) {
-                if ($filename == $_filename) {
-                    unset($this->blacklistedFiles[$key]);
+                foreach ($this->blacklistedFiles[$group] as $key => $_filename) {
+                    if ($filename == $_filename) {
+                        unset($this->blacklistedFiles[$group][$key]);
+                    }
                 }
             }
         } else {
@@ -272,21 +282,29 @@ public static function isFile($filename)
 
     /**
      * @param  string $filename
+     * @param  array  $groups
      * @return boolean
      */
-    public function isFiltered($filename)
+    public function isFiltered($filename, array $groups = array('DEFAULT'))
     {
         $filename = realpath($filename);
 
         if (!empty($this->whitelistedFiles)) {
             return !in_array($filename, $this->whitelistedFiles);
         }
 
-        if (in_array($filename, $this->blacklistedFiles)) {
-            return TRUE;
+        $blacklistedFiles = array();
+
+        foreach ($groups as $group) {
+            if (isset($this->blacklistedFiles[$group])) {
+                $blacklistedFiles = array_merge(
+                  $blacklistedFiles,
+                  $this->blacklistedFiles[$group]
+                );
+            }
         }
 
-        return FALSE;
+        return in_array($filename, $blacklistedFiles);
     }
 
     /**

Tests/PHP/CodeCoverage/FilterTest.php

@@ -115,7 +115,8 @@ public function testAddingAFileToTheBlacklistWorks()
         $this->filter->addFileToBlacklist($this->files[0]);
 
         $this->assertEquals(
-          array($this->files[0]), $this->filter->getBlacklist()
+          array('DEFAULT' => array($this->files[0])),
+          $this->filter->getBlacklist()
         );
     }
 
@@ -137,7 +138,9 @@ public function testRemovingAFileFromTheBlacklistWorks()
         $this->filter->addFileToBlacklist($this->files[0]);
         $this->filter->removeFileFromBlacklist($this->files[0]);
 
-        $this->assertEquals(array(), $this->filter->getBlacklist());
+        $this->assertEquals(
+          array('DEFAULT' => array()), $this->filter->getBlacklist()
+        );
     }
 
     /**
@@ -159,9 +162,12 @@ public function testAddingADirectoryToTheBlacklistWorks()
         $this->filter->addDirectoryToBlacklist(TEST_FILES_PATH);
 
         $blacklist = $this->filter->getBlacklist();
-        sort($blacklist);
 
-        $this->assertEquals($this->files, $blacklist);
+        foreach (array_keys($blacklist) as $group) {
+            sort($blacklist[$group]);
+        }
+
+        $this->assertEquals(array('DEFAULT' => $this->files), $blacklist);
     }
 
     /**
@@ -184,7 +190,9 @@ public function testRemovingADirectoryFromTheBlacklistWorks()
         $this->filter->addDirectoryToBlacklist(TEST_FILES_PATH);
         $this->filter->removeDirectoryFromBlacklist(TEST_FILES_PATH);
 
-        $this->assertEquals(array(), $this->filter->getBlacklist());
+        $this->assertEquals(
+          array('DEFAULT' => array()), $this->filter->getBlacklist()
+        );
     }
 
     /**