Merge branch 'master' into report-refactoring

Author: sebastianbergmann

ChangeLog.markdown

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

PHP/CodeCoverage.php

@@ -67,6 +67,11 @@ class PHP_CodeCoverage
      */
     protected $filter;
 
+    /**
+     * @var boolean
+     */
+    protected $cacheTokens = TRUE;
+
     /**
      * @var boolean
      */
@@ -333,6 +338,30 @@ public function merge(PHP_CodeCoverage $that)
         $this->tests = array_merge($this->tests, $that->getTests());
     }
 
+    /**
+     * @param  boolean $flag
+     * @throws InvalidArgumentException
+     * @since  Method available since Release 1.1.0
+     */
+    public function setCacheTokens($flag)
+    {
+        if (!is_bool($flag)) {
+            throw new InvalidArgumentException;
+        }
+
+        $this->cacheTokens = $flag;
+    }
+
+    /**
+     * @param  boolean $flag
+     * @throws InvalidArgumentException
+     * @since  Method available since Release 1.1.0
+     */
+    public function getCacheTokens()
+    {
+        return $this->cacheTokens;
+    }
+
     /**
      * @param  boolean $flag
      * @throws InvalidArgumentException
@@ -461,7 +490,12 @@ protected function processUncoveredFilesFromWhitelist()
         );
 
         foreach ($uncoveredFiles as $uncoveredFile) {
-            $tokens     = PHP_Token_Stream_CachingFactory::get($uncoveredFile);
+            if ($this->cacheTokens) {
+                $tokens = PHP_Token_Stream_CachingFactory::get($uncoveredFile);
+            } else {
+                $tokens = new PHP_Token_Stream($uncoveredFile);
+            }
+
             $classes    = $tokens->getClasses();
             $interfaces = $tokens->getInterfaces();
             $functions  = $tokens->getFunctions();

PHP/CodeCoverage/Report/Factory.php

@@ -71,7 +71,8 @@ public static function create(PHP_CodeCoverage $coverage)
         self::addItems(
           $root,
           PHP_CodeCoverage_Util::buildDirectoryStructure($files),
-          $coverage->getTests()
+          $coverage->getTests(),
+          $coverage->getCacheTokens()
         );
 
         return $root;
@@ -81,16 +82,17 @@ public static function create(PHP_CodeCoverage $coverage)
      * @param PHP_CodeCoverage_Report_Node_Directory $root
      * @param array                                  $items
      * @param array                                  $tests
+     * @param boolean                                $cacheTokens
      */
-    protected static function addItems(PHP_CodeCoverage_Report_Node_Directory $root, array $items, array $tests)
+    protected static function addItems(PHP_CodeCoverage_Report_Node_Directory $root, array $items, array $tests, $cacheTokens)
     {
         foreach ($items as $key => $value) {
             if (substr($key, -2) == '/f') {
                 $key = substr($key, 0, -2);
-                $root->addFile($key, $value, $tests);
+                $root->addFile($key, $value, $tests, $cacheTokens);
             } else {
                 $child = $root->addDirectory($key);
-                self::addItems($child, $value, $tests);
+                self::addItems($child, $value, $tests, $cacheTokens);
             }
         }
     }

PHP/CodeCoverage/Report/Node/Directory.php

@@ -197,16 +197,17 @@ public function addDirectory($name)
     /**
      * Adds a new file.
      *
-     * @param  string $name
-     * @param  array  $coverageData
-     * @param  array  $testData
+     * @param  string  $name
+     * @param  array   $coverageData
+     * @param  array   $testData
+     * @param  boolean $cacheTokens
      * @return PHP_CodeCoverage_Report_Node_File
      * @throws PHP_CodeCoverage_Exception
      */
-    public function addFile($name, array $coverageData, array $testData)
+    public function addFile($name, array $coverageData, array $testData, $cacheTokens)
     {
         $file = new PHP_CodeCoverage_Report_Node_File(
-          $name, $this, $coverageData, $testData
+          $name, $this, $coverageData, $testData, $cacheTokens
         );
 
         $this->children[] = $file;

PHP/CodeCoverage/Report/Node/File.php

@@ -136,23 +136,34 @@ class PHP_CodeCoverage_Report_Node_File extends PHP_CodeCoverage_Report_Node
      */
     protected $endLines = array();
 
+    /**
+     * @var boolean
+     */
+    protected $cacheTokens;
+
     /**
      * Constructor.
      *
      * @param  string                       $name
      * @param  PHP_CodeCoverage_Report_Node $parent
      * @param  array                        $coverageData
      * @param  array                        $testData
+     * @param  boolean                      $cacheTokens
      */
-    public function __construct($name, PHP_CodeCoverage_Report_Node $parent, array $coverageData, array $testData)
+    public function __construct($name, PHP_CodeCoverage_Report_Node $parent, array $coverageData, array $testData, $cacheTokens)
     {
+        if (!is_bool($cacheTokens)) {
+            throw new InvalidArgumentException;
+        }
+
         parent::__construct($name, $parent);
 
         $this->coverageData = $coverageData;
         $this->testData     = $testData;
         $this->ignoredLines = PHP_CodeCoverage_Util::getLinesToBeIgnored(
-                                $this->getPath()
+                                $this->getPath(), $cacheTokens
                               );
+        $this->cacheTokens  = $cacheTokens;
 
         $this->calculateStatistics();
     }
@@ -383,7 +394,11 @@ public function getNumTestedFunctions()
      */
     protected function calculateStatistics()
     {
-        $tokens = PHP_Token_Stream_CachingFactory::get($this->getPath());
+        if ($this->cacheTokens) {
+            $tokens = PHP_Token_Stream_CachingFactory::get($this->getPath());
+        } else {
+            $tokens = new PHP_Token_Stream($this->getPath());
+        }
 
         $this->processClasses($tokens);
         $this->processTraits($tokens);

PHP/CodeCoverage/Util.php

@@ -270,20 +270,30 @@ public static function getLinesToBeCovered($className, $methodName)
     /**
      * Returns the lines of a source file that should be ignored.
      *
-     * @param  string $filename
+     * @param  string  $filename
+     * @param  boolean $cacheTokens
      * @return array
+     * @throws InvalidArgumentException
      */
-    public static function getLinesToBeIgnored($filename)
+    public static function getLinesToBeIgnored($filename, $cacheTokens = TRUE)
     {
+        if (!is_bool($cacheTokens)) {
+            throw new InvalidArgumentException;
+        }
+
         if (!isset(self::$ignoredLines[$filename])) {
             self::$ignoredLines[$filename] = array();
+            $ignore                        = FALSE;
+            $stop                          = FALSE;
+
+            if ($cacheTokens) {
+                $tokens = PHP_Token_Stream_CachingFactory::get($filename);
+            } else {
+                $tokens = new PHP_Token_Stream($filename);
+            }
 
-            $ignore  = FALSE;
-            $stop    = FALSE;
-            $stream  = PHP_Token_Stream_CachingFactory::get($filename);
-            $tokens  = $stream->tokens();
-            $classes = $stream->getClasses();
-            unset($stream);
+            $classes = $tokens->getClasses();
+            $tokens  = $tokens->tokens();
 
             foreach ($tokens as $token) {
                 switch (get_class($token)) {