Chris@0: <?php
Chris@0: /*
Chris@0:  * This file is part of the PHP_CodeCoverage package.
Chris@0:  *
Chris@0:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Factory for PHP_CodeCoverage_Report_Node_* object graphs.
Chris@0:  *
Chris@0:  * @since Class available since Release 1.1.0
Chris@0:  */
Chris@0: class PHP_CodeCoverage_Report_Factory
Chris@0: {
Chris@0:     /**
Chris@0:      * @param  PHP_CodeCoverage                       $coverage
Chris@0:      * @return PHP_CodeCoverage_Report_Node_Directory
Chris@0:      */
Chris@0:     public function create(PHP_CodeCoverage $coverage)
Chris@0:     {
Chris@0:         $files      = $coverage->getData();
Chris@0:         $commonPath = $this->reducePaths($files);
Chris@0:         $root       = new PHP_CodeCoverage_Report_Node_Directory(
Chris@0:             $commonPath,
Chris@0:             null
Chris@0:         );
Chris@0: 
Chris@0:         $this->addItems(
Chris@0:             $root,
Chris@0:             $this->buildDirectoryStructure($files),
Chris@0:             $coverage->getTests(),
Chris@0:             $coverage->getCacheTokens()
Chris@0:         );
Chris@0: 
Chris@0:         return $root;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param PHP_CodeCoverage_Report_Node_Directory $root
Chris@0:      * @param array                                  $items
Chris@0:      * @param array                                  $tests
Chris@0:      * @param bool                                   $cacheTokens
Chris@0:      */
Chris@0:     private function addItems(PHP_CodeCoverage_Report_Node_Directory $root, array $items, array $tests, $cacheTokens)
Chris@0:     {
Chris@0:         foreach ($items as $key => $value) {
Chris@0:             if (substr($key, -2) == '/f') {
Chris@0:                 $key = substr($key, 0, -2);
Chris@0: 
Chris@0:                 if (file_exists($root->getPath() . DIRECTORY_SEPARATOR . $key)) {
Chris@0:                     $root->addFile($key, $value, $tests, $cacheTokens);
Chris@0:                 }
Chris@0:             } else {
Chris@0:                 $child = $root->addDirectory($key);
Chris@0:                 $this->addItems($child, $value, $tests, $cacheTokens);
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Builds an array representation of the directory structure.
Chris@0:      *
Chris@0:      * For instance,
Chris@0:      *
Chris@0:      * <code>
Chris@0:      * Array
Chris@0:      * (
Chris@0:      *     [Money.php] => Array
Chris@0:      *         (
Chris@0:      *             ...
Chris@0:      *         )
Chris@0:      *
Chris@0:      *     [MoneyBag.php] => Array
Chris@0:      *         (
Chris@0:      *             ...
Chris@0:      *         )
Chris@0:      * )
Chris@0:      * </code>
Chris@0:      *
Chris@0:      * is transformed into
Chris@0:      *
Chris@0:      * <code>
Chris@0:      * Array
Chris@0:      * (
Chris@0:      *     [.] => Array
Chris@0:      *         (
Chris@0:      *             [Money.php] => Array
Chris@0:      *                 (
Chris@0:      *                     ...
Chris@0:      *                 )
Chris@0:      *
Chris@0:      *             [MoneyBag.php] => Array
Chris@0:      *                 (
Chris@0:      *                     ...
Chris@0:      *                 )
Chris@0:      *         )
Chris@0:      * )
Chris@0:      * </code>
Chris@0:      *
Chris@0:      * @param  array $files
Chris@0:      * @return array
Chris@0:      */
Chris@0:     private function buildDirectoryStructure($files)
Chris@0:     {
Chris@0:         $result = array();
Chris@0: 
Chris@0:         foreach ($files as $path => $file) {
Chris@0:             $path    = explode('/', $path);
Chris@0:             $pointer = &$result;
Chris@0:             $max     = count($path);
Chris@0: 
Chris@0:             for ($i = 0; $i < $max; $i++) {
Chris@0:                 if ($i == ($max - 1)) {
Chris@0:                     $type = '/f';
Chris@0:                 } else {
Chris@0:                     $type = '';
Chris@0:                 }
Chris@0: 
Chris@0:                 $pointer = &$pointer[$path[$i] . $type];
Chris@0:             }
Chris@0: 
Chris@0:             $pointer = $file;
Chris@0:         }
Chris@0: 
Chris@0:         return $result;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Reduces the paths by cutting the longest common start path.
Chris@0:      *
Chris@0:      * For instance,
Chris@0:      *
Chris@0:      * <code>
Chris@0:      * Array
Chris@0:      * (
Chris@0:      *     [/home/sb/Money/Money.php] => Array
Chris@0:      *         (
Chris@0:      *             ...
Chris@0:      *         )
Chris@0:      *
Chris@0:      *     [/home/sb/Money/MoneyBag.php] => Array
Chris@0:      *         (
Chris@0:      *             ...
Chris@0:      *         )
Chris@0:      * )
Chris@0:      * </code>
Chris@0:      *
Chris@0:      * is reduced to
Chris@0:      *
Chris@0:      * <code>
Chris@0:      * Array
Chris@0:      * (
Chris@0:      *     [Money.php] => Array
Chris@0:      *         (
Chris@0:      *             ...
Chris@0:      *         )
Chris@0:      *
Chris@0:      *     [MoneyBag.php] => Array
Chris@0:      *         (
Chris@0:      *             ...
Chris@0:      *         )
Chris@0:      * )
Chris@0:      * </code>
Chris@0:      *
Chris@0:      * @param  array  $files
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function reducePaths(&$files)
Chris@0:     {
Chris@0:         if (empty($files)) {
Chris@0:             return '.';
Chris@0:         }
Chris@0: 
Chris@0:         $commonPath = '';
Chris@0:         $paths      = array_keys($files);
Chris@0: 
Chris@0:         if (count($files) == 1) {
Chris@0:             $commonPath                 = dirname($paths[0]) . '/';
Chris@0:             $files[basename($paths[0])] = $files[$paths[0]];
Chris@0: 
Chris@0:             unset($files[$paths[0]]);
Chris@0: 
Chris@0:             return $commonPath;
Chris@0:         }
Chris@0: 
Chris@0:         $max = count($paths);
Chris@0: 
Chris@0:         for ($i = 0; $i < $max; $i++) {
Chris@0:             // strip phar:// prefixes
Chris@0:             if (strpos($paths[$i], 'phar://') === 0) {
Chris@0:                 $paths[$i] = substr($paths[$i], 7);
Chris@0:                 $paths[$i] = strtr($paths[$i], '/', DIRECTORY_SEPARATOR);
Chris@0:             }
Chris@0:             $paths[$i] = explode(DIRECTORY_SEPARATOR, $paths[$i]);
Chris@0: 
Chris@0:             if (empty($paths[$i][0])) {
Chris@0:                 $paths[$i][0] = DIRECTORY_SEPARATOR;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $done = false;
Chris@0:         $max  = count($paths);
Chris@0: 
Chris@0:         while (!$done) {
Chris@0:             for ($i = 0; $i < $max - 1; $i++) {
Chris@0:                 if (!isset($paths[$i][0]) ||
Chris@0:                     !isset($paths[$i+1][0]) ||
Chris@0:                     $paths[$i][0] != $paths[$i+1][0]) {
Chris@0:                     $done = true;
Chris@0:                     break;
Chris@0:                 }
Chris@0:             }
Chris@0: 
Chris@0:             if (!$done) {
Chris@0:                 $commonPath .= $paths[0][0];
Chris@0: 
Chris@0:                 if ($paths[0][0] != DIRECTORY_SEPARATOR) {
Chris@0:                     $commonPath .= DIRECTORY_SEPARATOR;
Chris@0:                 }
Chris@0: 
Chris@0:                 for ($i = 0; $i < $max; $i++) {
Chris@0:                     array_shift($paths[$i]);
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $original = array_keys($files);
Chris@0:         $max      = count($original);
Chris@0: 
Chris@0:         for ($i = 0; $i < $max; $i++) {
Chris@0:             $files[implode('/', $paths[$i])] = $files[$original[$i]];
Chris@0:             unset($files[$original[$i]]);
Chris@0:         }
Chris@0: 
Chris@0:         ksort($files);
Chris@0: 
Chris@0:         return substr($commonPath, 0, -1);
Chris@0:     }
Chris@0: }