Use function or method name in PHP_CodeCoverage_UnintentionallyCoveredCodeException messages

Author: sebastianbergmann

ChangeLog-3.2.md

@@ -8,5 +8,9 @@ All notable changes of the PHP_CodeCoverage 3.2 release series are documented in
 
 * Added optional check for missing `@covers` annotation when the usage of `@covers` annotations is forced
 
+### Changed
+
+* Improved `PHP_CodeCoverage_UnintentionallyCoveredCodeException` message
+
 [3.2.0]: https://github.com/sebastianbergmann/php-code-coverage/compare/3.1...3.2.0
 

composer.json

@@ -20,11 +20,14 @@
         "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues",
         "irc": "irc://irc.freenode.net/phpunit"
     },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "require": {
         "php": ">=5.6",
         "phpunit/php-file-iterator": "~1.3",
         "phpunit/php-token-stream": "~1.3",
         "phpunit/php-text-template": "~1.2",
+        "sebastian/code-unit-reverse-lookup": "~1.0",
         "sebastian/environment": "^1.3.2",
         "sebastian/version": "~1.0|~2.0"
     },

src/CodeCoverage.php

@@ -8,6 +8,7 @@
  * file that was distributed with this source code.
  */
 
+use SebastianBergmann\CodeUnitReverseLookup\Wizard;
 use SebastianBergmann\Environment\Runtime;
 
 /**
@@ -27,6 +28,11 @@ class PHP_CodeCoverage
      */
     private $filter;
 
+    /**
+     * @var Wizard
+     */
+    private $wizard;
+
     /**
      * @var bool
      */
@@ -115,6 +121,8 @@ public function __construct(PHP_CodeCoverage_Driver $driver = null, PHP_CodeCove
 
         $this->driver = $driver;
         $this->filter = $filter;
+
+        $this->wizard = new Wizard;
     }
 
     /**
@@ -887,23 +895,32 @@ private function performUnintentionallyCoveredCodeCheck(array &$data, array $lin
             $linesToBeUsed
         );
 
-        $message = '';
+        $unintentionallyCoveredUnits = [];
 
         foreach ($data as $file => $_data) {
             foreach ($_data as $line => $flag) {
                 if ($flag == 1 &&
                     (!isset($allowedLines[$file]) ||
                         !isset($allowedLines[$file][$line]))) {
-                    $message .= sprintf(
-                        '- %s:%d' . PHP_EOL,
-                        $file,
-                        $line
-                    );
+                    if ($this->wizard->lookup($file, $line)) {
+                        $unintentionallyCoveredUnits[] = $this->wizard->lookup($file, $line);
+                    } else {
+                        $unintentionallyCoveredUnits[] = $file . ':' . $line;
+                    }
                 }
             }
         }
 
-        if (!empty($message)) {
+        if (!empty($unintentionallyCoveredUnits)) {
+            $message = '';
+
+            $unintentionallyCoveredUnits = array_unique($unintentionallyCoveredUnits);
+            sort($unintentionallyCoveredUnits);
+
+            foreach ($unintentionallyCoveredUnits as $unit) {
+                $message .= '- ' . $unit . "\n";
+            }
+
             throw new PHP_CodeCoverage_UnintentionallyCoveredCodeException(
                 $message
             );