Re-introduction of processUncoveredFilesFromWhitelist alongside performance tweaks

Author: Rob Caiger

ChangeLog-3.0.md

@@ -6,15 +6,11 @@ All notable changes of the PHP_CodeCoverage 3.0 release series are documented in
 
 ### Changed
 
-* It is now mandatory to configure a whitelist
-* Merged [#384](https://github.com/sebastianbergmann/php-code-coverage/pull/384): Performance improvements
 * It is now mandatory to configure a whitelist
 * Merged [#384](https://github.com/sebastianbergmann/php-code-coverage/pull/384): Performance improvements
 
 ### Removed
 
-* The blacklist functionality has been removed
-* The `PHP_CodeCoverage::setProcessUncoveredFilesFromWhitelist()` method has been remove
 * The blacklist functionality has been removed
 * The `PHP_CodeCoverage::setProcessUncoveredFilesFromWhitelist()` method has been remove
 * PHP_CodeCoverage is no longer supported on PHP 5.3, PHP 5.4, and PHP 5.5

src/CodeCoverage.php

@@ -52,6 +52,11 @@ class PHP_CodeCoverage
      */
     private $addUncoveredFilesFromWhitelist = true;
 
+    /**
+     * @var bool
+     */
+    private $processUncoveredFilesFromWhitelist = false;
+
     /**
      * @var mixed
      */
@@ -81,13 +86,6 @@ class PHP_CodeCoverage
      */
     private $tests = [];
 
-    /**
-     * Store all uncovered files
-     *
-     * @var array
-     */
-    private $uncoveredFiles = [];
-
     /**
      * Constructor.
      *
@@ -107,8 +105,6 @@ public function __construct(PHP_CodeCoverage_Driver $driver = null, PHP_CodeCove
 
         $this->driver = $driver;
         $this->filter = $filter;
-
-        $this->initData();
     }
 
     /**
@@ -155,9 +151,7 @@ public function filter()
      */
     public function getData($raw = false)
     {
-        if (!$raw && $this->addUncoveredFilesFromWhitelist) {
-            $this->addUncoveredFilesFromWhitelist();
-        }
+        $this->processUncoveredLines($raw);
 
         return $this->data;
     }
@@ -248,12 +242,6 @@ public function stop($append = true, $linesToBeCovered = [], array $linesToBeUse
         $data = $this->driver->stop();
         $this->append($data, null, $append, $linesToBeCovered, $linesToBeUsed);
 
-        foreach (array_keys($data) as $file) {
-            if (isset($this->uncoveredFiles[$file])) {
-                unset($this->uncoveredFiles[$file]);
-            }
-        }
-
         $this->currentId = null;
 
         return $data;
@@ -280,7 +268,6 @@ public function append(array $data, $id = null, $append = true, $linesToBeCovere
         }
 
         $this->applyListsFilter($data);
-        $this->applyIgnoredLinesFilter($data);
         $this->initializeFilesThatAreSeenTheFirstTime($data);
 
         if (!$append) {
@@ -464,6 +451,22 @@ public function setAddUncoveredFilesFromWhitelist($flag)
         $this->addUncoveredFilesFromWhitelist = $flag;
     }
 
+    /**
+     * @param  bool                                      $flag
+     * @throws PHP_CodeCoverage_InvalidArgumentException
+     */
+    public function setProcessUncoveredFilesFromWhitelist($flag)
+    {
+        if (!is_bool($flag)) {
+            throw PHP_CodeCoverage_InvalidArgumentException::create(
+                1,
+                'boolean'
+            );
+        }
+
+        $this->processUncoveredFilesFromWhitelist = $flag;
+    }
+
     /**
      * @param  bool                                      $flag
      * @throws PHP_CodeCoverage_InvalidArgumentException
@@ -535,24 +538,6 @@ private function applyListsFilter(array &$data)
         }
     }
 
-    /**
-     * Applies the "ignored lines" filtering.
-     *
-     * @param array $data
-     */
-    private function applyIgnoredLinesFilter(array &$data)
-    {
-        foreach (array_keys($data) as $filename) {
-            if (!$this->filter->isFile($filename)) {
-                continue;
-            }
-
-            foreach ($this->getLinesToBeIgnored($filename) as $line) {
-                unset($data[$filename][$line]);
-            }
-        }
-    }
-
     /**
      * @param array $data
      * @since Method available since Release 1.1.0
@@ -572,20 +557,6 @@ private function initializeFilesThatAreSeenTheFirstTime(array $data)
         }
     }
 
-    /**
-     * Processes whitelisted files that are not covered.
-     */
-    private function addUncoveredFilesFromWhitelist()
-    {
-        $data = [];
-
-        foreach (array_keys($this->uncoveredFiles) as $file) {
-            $data[$file] = $this->data[$file];
-        }
-
-        $this->append($data, 'UNCOVERED_FILES_FROM_WHITELIST');
-    }
-
     /**
      * Returns the lines of a source file that should be ignored.
      *
@@ -860,20 +831,60 @@ private function selectDriver()
     }
 
     /**
-     * Initialise the data with the executable/dead lines from each file in the whitelist
+     * Determine uncovered lines
      */
-    private function initData()
+    private function processUncoveredLines($raw = false)
     {
-        foreach ($this->filter()->getWhitelist() as $file) {
-            $this->driver->start();
-            include_once($file);
-            $data = $this->driver->stop();
+        if (!$raw && $this->addUncoveredFilesFromWhitelist) {
+            $filesToProcess = $this->filter()->getWhitelist();
+        } else {
+            $filesToProcess = array_keys($this->data);
+        }
+
+        $coverageData = $this->data;
+        $this->data = [];
+
+        foreach ($filesToProcess as $file) {
+
+            if (!file_exists($file)) {
+                continue;
+            }
+
+            $isCoveredFile = isset($this->data[$file]);
+            $data = [];
+
+            // If we have coverage data, or we are allowed to process uncovered files
+            if ($isCoveredFile || $this->processUncoveredFilesFromWhitelist) {
+                $this->driver->start();
+                include_once($file);
+                $data = $this->driver->stop();
+
+            } else {
+                $lines = count(file($file));
+
+                for ($i = 1; $i <= $lines; $i++) {
+                    $data[$file][$i] = PHP_CodeCoverage_Driver::LINE_NOT_EXECUTED;
+                }
+            }
 
             $this->initializeFilesThatAreSeenTheFirstTime($data);
+
+            if (!$isCoveredFile) {
+                // If it is an uncovered file, just append the data
+                $this->append($data, 'UNCOVERED_FILES_FROM_WHITELIST');
+            }
         }
 
-        foreach (array_keys($this->data) as $file) {
-            $this->uncoveredFiles[$file] = 1;
+        foreach ($coverageData as $file => $lines) {
+            foreach ($lines as $k => $v) {
+                $this->data[$file][$k] = $v;
+            }
+        }
+
+        foreach ($this->data as $file => $lines) {
+            foreach ($this->getLinesToBeIgnored($file) as $line) {
+                unset($this->data[$file][$line]);
+            }
         }
     }
 }