Fix CS/WS issues

sebastianbergmann · sebastianbergmann · commit 29f31e51f6aa · 2017-12-29T08:05:16.000+01:00
diff --git a/composer.json b/composer.json
@@ -41,7 +41,7 @@
         "phpunit/phpunit": "^7.0"
     },
     "suggest": {
-        "ext-xdebug": "^2.5.5"
+        "ext-xdebug": "^2.6.0"
     },
     "autoload": {
         "classmap": [
diff --git a/src/CodeCoverage.php b/src/CodeCoverage.php
@@ -12,6 +12,7 @@
 
 use PHPUnit\Framework\TestCase;
 use PHPUnit\Runner\PhptTestCase;
+use PHPUnit\Util\Test;
 use SebastianBergmann\CodeCoverage\Driver\Driver;
 use SebastianBergmann\CodeCoverage\Driver\PHPDBG;
 use SebastianBergmann\CodeCoverage\Driver\Xdebug;
@@ -364,11 +365,11 @@ public function append(array $data, $id = null, $append = true, $linesToBeCovere
         if ($id instanceof TestCase) {
             $_size = $id->getSize();
 
-            if ($_size === \PHPUnit\Util\Test::SMALL) {
+            if ($_size === Test::SMALL) {
                 $size = 'small';
-            } elseif ($_size === \PHPUnit\Util\Test::MEDIUM) {
+            } elseif ($_size === Test::MEDIUM) {
                 $size = 'medium';
-            } elseif ($_size === \PHPUnit\Util\Test::LARGE) {
+            } elseif ($_size === Test::LARGE) {
                 $size = 'large';
             }
 
@@ -1113,7 +1114,7 @@ private function initializeData()
 
             foreach ($this->filter->getWhitelist() as $file) {
                 if ($this->filter->isFile($file)) {
-                    include_once($file);
+                    include_once $file;
                 }
             }
 
diff --git a/src/Driver/Driver.php b/src/Driver/Driver.php
@@ -20,21 +20,21 @@ interface Driver
      *
      * @see http://xdebug.org/docs/code_coverage
      */
-    const LINE_EXECUTED = 1;
+    public const LINE_EXECUTED = 1;
 
     /**
      * @var int
      *
      * @see http://xdebug.org/docs/code_coverage
      */
-    const LINE_NOT_EXECUTED = -1;
+    public const LINE_NOT_EXECUTED = -1;
 
     /**
      * @var int
      *
      * @see http://xdebug.org/docs/code_coverage
      */
-    const LINE_NOT_EXECUTABLE = -2;
+    public const LINE_NOT_EXECUTABLE = -2;
 
     /**
      * Start collection of code coverage information.
diff --git a/src/Driver/PHPDBG.php b/src/Driver/PHPDBG.php
@@ -66,12 +66,12 @@ public function stop()
                 \array_keys($fetchedLines)
             );
 
+            $sourceLines = [];
+
             if ($newFiles) {
                 $sourceLines = phpdbg_get_executable(
                     ['files' => $newFiles]
                 );
-            } else {
-                $sourceLines = [];
             }
         }
 
diff --git a/src/Driver/Xdebug.php b/src/Driver/Xdebug.php
@@ -27,19 +27,16 @@ final class Xdebug implements Driver
     private $cacheNumLines = [];
 
     /**
-     * Constructor.
+     * @throws RuntimeException
      */
     public function __construct()
     {
         if (!\extension_loaded('xdebug')) {
             throw new RuntimeException('This driver requires Xdebug');
         }
 
-        if (\version_compare(\phpversion('xdebug'), '2.2.1', '>=') &&
-            !\ini_get('xdebug.coverage_enable')) {
-            throw new RuntimeException(
-                'xdebug.coverage_enable=On has to be set in php.ini'
-            );
+        if (!\ini_get('xdebug.coverage_enable')) {
+            throw new RuntimeException('xdebug.coverage_enable=On has to be set in php.ini');
         }
     }
 
@@ -65,6 +62,7 @@ public function start($determineUnusedAndDead = true)
     public function stop()
     {
         $data = \xdebug_get_code_coverage();
+
         \xdebug_stop_code_coverage();
 
         return $this->cleanup($data);
diff --git a/src/Node/Builder.php b/src/Node/Builder.php
@@ -114,10 +114,10 @@ private function buildDirectoryStructure($files)
             $max     = \count($path);
 
             for ($i = 0; $i < $max; $i++) {
+                $type = '';
+
                 if ($i == ($max - 1)) {
                     $type = '/f';
-                } else {
-                    $type = '';
                 }
 
                 $pointer = &$pointer[$path[$i] . $type];
@@ -194,7 +194,7 @@ private function reducePaths(&$files)
             // strip phar:// prefixes
             if (\strpos($paths[$i], 'phar://') === 0) {
                 $paths[$i] = \substr($paths[$i], 7);
-                $paths[$i] = \strtr($paths[$i], '/', DIRECTORY_SEPARATOR);
+                $paths[$i] = \str_replace('/', DIRECTORY_SEPARATOR, $paths[$i]);
             }
             $paths[$i] = \explode(DIRECTORY_SEPARATOR, $paths[$i]);
 
diff --git a/src/Report/Clover.php b/src/Report/Clover.php
@@ -45,7 +45,6 @@ public function process(CodeCoverage $coverage, $target = null, $name = null)
 
         $packages = [];
         $report   = $coverage->getReport();
-        unset($coverage);
 
         foreach ($report as $item) {
             if (!$item instanceof File) {
@@ -57,10 +56,10 @@ public function process(CodeCoverage $coverage, $target = null, $name = null)
             $xmlFile = $xmlDocument->createElement('file');
             $xmlFile->setAttribute('name', $item->getPath());
 
-            $classes   = $item->getClassesAndTraits();
-            $coverage  = $item->getCoverageData();
-            $lines     = [];
-            $namespace = 'global';
+            $classes      = $item->getClassesAndTraits();
+            $coverageData = $item->getCoverageData();
+            $lines        = [];
+            $namespace    = 'global';
 
             foreach ($classes as $className => $class) {
                 $classStatements        = 0;
@@ -84,8 +83,8 @@ public function process(CodeCoverage $coverage, $target = null, $name = null)
                     $methodCount = 0;
 
                     foreach (\range($method['startLine'], $method['endLine']) as $line) {
-                        if (isset($coverage[$line]) && ($coverage[$line] !== null)) {
-                            $methodCount = \max($methodCount, \count($coverage[$line]));
+                        if (isset($coverageData[$line]) && ($coverageData[$line] !== null)) {
+                            $methodCount = \max($methodCount, \count($coverageData[$line]));
                         }
                     }
 
@@ -150,7 +149,7 @@ public function process(CodeCoverage $coverage, $target = null, $name = null)
                 $xmlClass->appendChild($xmlMetrics);
             }
 
-            foreach ($coverage as $line => $data) {
+            foreach ($coverageData as $line => $data) {
                 if ($data === null || isset($lines[$line])) {
                     continue;
                 }
diff --git a/src/Report/Crap4j.php b/src/Report/Crap4j.php
@@ -117,10 +117,10 @@ public function process(CodeCoverage $coverage, $target = null, $name = null)
         $stats->appendChild($document->createElement('crapLoad', \round($fullCrapLoad)));
         $stats->appendChild($document->createElement('totalCrap', $fullCrap));
 
+        $crapMethodPercent = 0;
+
         if ($fullMethodCount > 0) {
             $crapMethodPercent = $this->roundValue((100 * $fullCrapMethodCount) / $fullMethodCount);
-        } else {
-            $crapMethodPercent = 0;
         }
 
         $stats->appendChild($document->createElement('crapMethodPercent', $crapMethodPercent));
@@ -131,8 +131,8 @@ public function process(CodeCoverage $coverage, $target = null, $name = null)
         $buffer = $document->saveXML();
 
         if ($target !== null) {
-            if (!\is_dir(\dirname($target))) {
-                \mkdir(\dirname($target), 0777, true);
+            if (!\mkdir(\dirname($target)) && !\is_dir(\dirname($target))) {
+                throw new \RuntimeException(\sprintf('Directory "%s" was not created', \dirname($target)));
             }
 
             \file_put_contents($target, $buffer);
diff --git a/src/Report/Html/Renderer/Dashboard.php b/src/Report/Html/Renderer/Dashboard.php
@@ -248,12 +248,11 @@ protected function projectRisks(array $classes, $baseLink)
 
         foreach ($classes as $className => $class) {
             foreach ($class['methods'] as $methodName => $method) {
-                if ($method['coverage'] < $this->highLowerBound &&
-                    $method['ccn'] > 1) {
+                if ($method['coverage'] < $this->highLowerBound && $method['ccn'] > 1) {
+                    $key = $methodName;
+
                     if ($className !== '*') {
                         $key = $className . '::' . $methodName;
-                    } else {
-                        $key = $methodName;
                     }
 
                     $methodRisks[$key] = $method['crap'];
diff --git a/src/Report/Html/Renderer/File.php b/src/Report/Html/Renderer/File.php
@@ -394,14 +394,14 @@ protected function renderSource(FileNode $node)
                 }
             }
 
+            $popover = '';
+
             if (!empty($popoverTitle)) {
                 $popover = \sprintf(
                     ' data-title="%s" data-content="%s" data-placement="bottom" data-html="true"',
                     $popoverTitle,
                     \htmlspecialchars($popoverContent)
                 );
-            } else {
-                $popover = '';
             }
 
             $lines .= \sprintf(
diff --git a/src/Report/Text.php b/src/Report/Text.php
@@ -21,19 +21,55 @@
  */
 final class Text
 {
+    /**
+     * @var string
+     */
+    private const COLOR_GREEN = "\x1b[30;42m";
+
+    /**
+     * @var string
+     */
+    private const COLOR_YELLOW = "\x1b[30;43m";
+
+    /**
+     * @var string
+     */
+    private const COLOR_RED = "\x1b[37;41m";
+
+    /**
+     * @var string
+     */
+    private const COLOR_HEADER = "\x1b[1;37;40m";
+
+    /**
+     * @var string
+     */
+    private const COLOR_RESET = "\x1b[0m";
+
+    /**
+     * @var string
+     */
+    private const COLOR_EOL = "\x1b[2K";
+
+    /**
+     * @var int
+     */
     private $lowUpperBound;
+
+    /**
+     * @var int
+     */
     private $highLowerBound;
+
+    /**
+     * @var bool
+     */
     private $showUncoveredFiles;
-    private $showOnlySummary;
 
-    private $colors = [
-        'green'  => "\x1b[30;42m",
-        'yellow' => "\x1b[30;43m",
-        'red'    => "\x1b[37;41m",
-        'header' => "\x1b[1;37;40m",
-        'reset'  => "\x1b[0m",
-        'eol'    => "\x1b[2K",
-    ];
+    /**
+     * @var bool
+     */
+    private $showOnlySummary;
 
     /**
      * @param int  $lowUpperBound
@@ -59,7 +95,6 @@ public function process(CodeCoverage $coverage, $showColors = false)
     {
         $output = PHP_EOL . PHP_EOL;
         $report = $coverage->getReport();
-        unset($coverage);
 
         $colors = [
             'header'  => '',
@@ -75,17 +110,20 @@ public function process(CodeCoverage $coverage, $showColors = false)
                 $report->getNumTestedClassesAndTraits(),
                 $report->getNumClassesAndTraits()
             );
+
             $colors['methods'] = $this->getCoverageColor(
                 $report->getNumTestedMethods(),
                 $report->getNumMethods()
             );
+
             $colors['lines']   = $this->getCoverageColor(
                 $report->getNumExecutedLines(),
                 $report->getNumExecutableLines()
             );
-            $colors['reset']   = $this->colors['reset'];
-            $colors['header']  = $this->colors['header'];
-            $colors['eol']     = $this->colors['eol'];
+
+            $colors['reset']  = self::COLOR_RESET;
+            $colors['header'] = self::COLOR_HEADER;
+            $colors['eol']    = self::COLOR_EOL;
         }
 
         $classes = \sprintf(
@@ -169,17 +207,18 @@ public function process(CodeCoverage $coverage, $showColors = false)
                     $classMethods++;
                     $classStatements += $method['executableLines'];
                     $coveredClassStatements += $method['executedLines'];
+
                     if ($method['coverage'] == 100) {
                         $coveredMethods++;
                     }
                 }
 
+                $namespace = '';
+
                 if (!empty($class['package']['namespace'])) {
                     $namespace = '\\' . $class['package']['namespace'] . '::';
                 } elseif (!empty($class['package']['fullPackage'])) {
                     $namespace = '@' . $class['package']['fullPackage'] . '::';
-                } else {
-                    $namespace = '';
                 }
 
                 $classCoverage[$namespace . $className] = [
@@ -200,8 +239,7 @@ public function process(CodeCoverage $coverage, $showColors = false)
         $resetColor  = '';
 
         foreach ($classCoverage as $fullQualifiedPath => $classInfo) {
-            if ($classInfo['statementsCovered'] != 0 ||
-                $this->showUncoveredFiles) {
+            if ($this->showUncoveredFiles || $classInfo['statementsCovered'] != 0) {
                 if ($showColors) {
                     $methodColor = $this->getCoverageColor($classInfo['methodsCovered'], $classInfo['methodCount']);
                     $linesColor  = $this->getCoverageColor($classInfo['statementsCovered'], $classInfo['statementCount']);
@@ -226,13 +264,14 @@ private function getCoverageColor($numberOfCoveredElements, $totalNumberOfElemen
         );
 
         if ($coverage >= $this->highLowerBound) {
-            return $this->colors['green'];
+            return self::COLOR_GREEN;
         }
+
         if ($coverage > $this->lowUpperBound) {
-            return $this->colors['yellow'];
+            return self::COLOR_YELLOW;
         }
 
-        return $this->colors['red'];
+        return self::COLOR_RED;
     }
 
     private function printCoverageCounts($numberOfCoveredElements, $totalNumberOfElements, $precision)
@@ -251,7 +290,7 @@ private function printCoverageCounts($numberOfCoveredElements, $totalNumberOfEle
 
     private function format($color, $padding, $string)
     {
-        $reset = $color ? $this->colors['reset'] : '';
+        $reset = $color ? self::COLOR_RESET : '';
 
         return $color . \str_pad($string, $padding) . $reset . PHP_EOL;
     }
diff --git a/src/Report/Xml/Coverage.php b/src/Report/Xml/Coverage.php
@@ -35,7 +35,7 @@ public function __construct(\DOMElement $context, $line)
 
         $this->writer = new \XMLWriter();
         $this->writer->openMemory();
-        $this->writer->startElementNs(null, $context->nodeName, 'http://schema.phpunit.de/coverage/1.0');
+        $this->writer->startElementNS(null, $context->nodeName, 'http://schema.phpunit.de/coverage/1.0');
         $this->writer->writeAttribute('nr', $line);
     }
 
diff --git a/tests/tests/XmlTest.php b/tests/tests/XmlTest.php

Original file line number	Diff line number	Diff line change
`@@ -66,12 +66,12 @@ public function stop()`
`66`	`66`	`\array_keys($fetchedLines)`
`67`	`67`	`);`
`68`	`68`
	`69`	`+ $sourceLines = [];`
	`70`	`+`
`69`	`71`	`if ($newFiles) {`
`70`	`72`	`$sourceLines = phpdbg_get_executable(`
`71`	`73`	`['files' => $newFiles]`
`72`	`74`	`);`
`73`		`- } else {`
`74`		`- $sourceLines = [];`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`
Original file line number	Diff line number	Diff line change
`@@ -27,19 +27,16 @@ final class Xdebug implements Driver`
`27`	`27`	`private $cacheNumLines = [];`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * Constructor.`
	`30`	`+ * @throws RuntimeException`
`31`	`31`	`*/`
`32`	`32`	`public function __construct()`
`33`	`33`	`{`
`34`	`34`	`if (!\extension_loaded('xdebug')) {`
`35`	`35`	`throw new RuntimeException('This driver requires Xdebug');`
`36`	`36`	`}`
`37`	`37`
`38`		`- if (\version_compare(\phpversion('xdebug'), '2.2.1', '>=') &&`
`39`		`- !\ini_get('xdebug.coverage_enable')) {`
`40`		`- throw new RuntimeException(`
`41`		`- 'xdebug.coverage_enable=On has to be set in php.ini'`
`42`		`- );`
	`38`	`+ if (!\ini_get('xdebug.coverage_enable')) {`
	`39`	`+ throw new RuntimeException('xdebug.coverage_enable=On has to be set in php.ini');`
`43`	`40`	`}`
`44`	`41`	`}`
`45`	`42`
`@@ -65,6 +62,7 @@ public function start($determineUnusedAndDead = true)`
`65`	`62`	`public function stop()`
`66`	`63`	`{`
`67`	`64`	`$data = \xdebug_get_code_coverage();`
	`65`	`+`
`68`	`66`	`\xdebug_stop_code_coverage();`
`69`	`67`
`70`	`68`	`return $this->cleanup($data);`
Original file line number	Diff line number	Diff line change
`@@ -394,14 +394,14 @@ protected function renderSource(FileNode $node)`
`394`	`394`	`}`
`395`	`395`	`}`
`396`	`396`
	`397`	`+ $popover = '';`
	`398`	`+`
`397`	`399`	`if (!empty($popoverTitle)) {`
`398`	`400`	`$popover = \sprintf(`
`399`	`401`	`' data-title="%s" data-content="%s" data-placement="bottom" data-html="true"',`
`400`	`402`	`$popoverTitle,`
`401`	`403`	`\htmlspecialchars($popoverContent)`
`402`	`404`	`);`
`403`		`- } else {`
`404`		`- $popover = '';`
`405`	`405`	`}`
`406`	`406`
`407`	`407`	`$lines .= \sprintf(`