v2.1.0 - Final PhpSpec2 Release + phpdbg support + PHP7 support (backported henrikbjorn/phpspec-code-coverage v2.1.0 release)

Author: ek9

.travis.yml

@@ -3,6 +3,8 @@ php:
   - '5.4'
   - '5.5'
   - '5.6'
+  - '7.0'
+
 script:
   - composer validate
   - composer update

CHANGELOG.md

@@ -6,14 +6,21 @@ documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.0] - 2017-02-12 (backported v2.1.0, original release on 2016-05-05)
+
+**Note!** v2.1.0 is final release to support PhpSpec2.
+
+- Added PHP 7 support
+- Added `phpdbg` extension support (alternative to `xdebug`)
+- Updated `blacklist` to include `test` directory by default
+- Updated `text` output to use coloring by default.
+
 ## [1.0.1] - 2017-02-11 (backported v1.0.1, original release on 2014-12-11)
 
 **Note!** This version is a direct backport of `1.0.1` of
 [henrikbjorn/phpspec-code-coverage][1] package with updated namespaces to work
 as [leanphp/phpspec-code-coverage][0].
 
-This is last release to support PHP `5.3`
-
 - PHP `>=5.3`
 - PhpSpec `~2.0`
 - Xdebug `>=2.1.4`
@@ -33,7 +40,8 @@ This is last release to support PHP `5.3`
 - Support configuring a blacklist of files to be excluded from code coverage
   reports (`blaclist_files` option).
 
-[1.0.1]: https://github.com/leanphp/phpspec-code-coverage/releases/tag/1.0.1
+[2.1.0]: https://github.com/leanphp/phpspec-code-coverage/releases/tag/v2.1.0
+[1.0.1]: https://github.com/leanphp/phpspec-code-coverage/releases/tag/v1.0.1
 
 [0]: https://github.com/leanphp/phpspec-code-coverage
 [1]: https://github.com/henrikbjorn/PhpSpecCodeCoverageExtension

README.md

@@ -14,12 +14,12 @@ used as a single metric defining how good your tests are.
 
 **Note!** This is a maintained fork of [henrikbjorn/phpspec-code-coverage][1]
 package with compatible version numbers for stable releases. This is
-a **backported v1.0.1 release**.
+a **backported v2.1.0 release**.
 
 ## Requirements
 
-- PHP 5.3
-- PHP [Xdebug][3] extension
+- PHP 5.3.3+ (**PHP 7** is supported)
+- [Xdebug][3] or [phpdbg][4] extension enabled
 - [PhpSpec v2][2]
 
 ## Install
@@ -36,11 +36,22 @@ extensions:
 ```
 
 This will sufficient to enable Code Coverage generation by using defaults
-provided by the extension. If you execute `phpspec run` command, you will see
-code coverage generated in `coverage` directory (in `html` format). This
-extension supports various [configuration options](#Configuration Options). For
-a fully annotated example configuration file check [Configuration
-section](#Configuration).
+provided by the extension. This extension supports various [configuration
+options](#Configuration Options). For a fully annotated example configuration
+file check [Configuration section](#Configuration).
+
+## Usage
+
+If you execute `phpspec run` command, you will see code coverage generated in `coverage` directory (in `html` format):
+
+    $ bin/phpspec run
+
+### Running with phpdbg
+
+This extension now supports [phpdbg][4], which results in faster execution when
+using more recent versions of PHP. Run `phpspec` via [phpdbg][4]:
+
+    $ phpdbg -qrr phpspec run
 
 ## Configuration
 
@@ -152,3 +163,4 @@ Licensed under [MIT License](LICENSE).
 
 [travis-image]: https://travis-ci.org/leanphp/phpspec-code-coverage.svg
 [travis-url]: https://travis-ci.org/leanphp/phpspec-code-coverage
+

composer.json

@@ -23,14 +23,16 @@
         "source": "https://github.com/leanphp/phpspec-code-coverage",
         "docs": "https://github.com/leanphp/phpspec-code-coverage#phpspec-code-coverage"
     },
-    "require" : {
-        "php": ">=5.3.3",
-        "phpspec/phpspec": "~2.0",
-        "phpunit/php-code-coverage": "~2.0"
+    "require": {
+        "php": "~5.3,^5.3.3||~7.0",
+        "phpspec/phpspec": "^2.0",
+        "phpunit/php-code-coverage": "^2.2.4||^3"
     },
     "require-dev": {
-        "ext-xdebug": ">=2.1.4",
-        "bossa/phpspec2-expect": "~1.0"
+        "bossa/phpspec2-expect": "^1.0"
+    },
+    "suggest": {
+        "ext-xdebug": "Install Xdebug to generate phpspec code coverage if you are not using phpdbg"
     },
     "minimum-stability": "stable",
     "config": {

spec/Listener/CodeCoverageListenerSpec.php

@@ -51,7 +51,7 @@ function it_should_run_all_reports(
         $this->afterSuite($event);
     }
 
-    function it_should_output_text_report(
+    function it_should_color_output_text_report_by_default(
         \PHP_CodeCoverage $coverage,
         \PHP_CodeCoverage_Report_Text $text,
         SuiteEvent $event,
@@ -67,6 +67,7 @@ function it_should_output_text_report(
         ));
 
         $io->isVerbose()->willReturn(false);
+        $io->isDecorated()->willReturn(true);
         $this->setIO($io);
 
         $text->process($coverage, true)->willReturn('report');
@@ -75,6 +76,31 @@ function it_should_output_text_report(
         $this->afterSuite($event);
     }
 
+    function it_should_not_color_output_text_report_unless_specified(
+        \PHP_CodeCoverage $coverage,
+        \PHP_CodeCoverage_Report_Text $text,
+        SuiteEvent $event,
+        IO $io
+    ) {
+        $reports = array(
+            'text' => $text
+        );
+
+        $this->beConstructedWith($coverage, $reports);
+        $this->setOptions(array(
+            'format' => 'text'
+        ));
+
+        $io->isVerbose()->willReturn(false);
+        $io->isDecorated()->willReturn(false);
+        $this->setIO($io);
+
+        $text->process($coverage, false)->willReturn('report');
+        $io->writeln('report')->shouldBeCalled();
+
+        $this->afterSuite($event);
+    }
+
     function it_should_output_html_report(
         \PHP_CodeCoverage $coverage,
         \PHP_CodeCoverage_Report_HTML $html,
@@ -144,12 +170,10 @@ function it_should_correctly_handle_black_listed_files_and_directories(
             'blacklist_files' => array('src/filtered_file')
         ));
 
-        $filter->addDirectoryToWhitelist('src')->willReturn(null);
-        $filter->removeDirectoryFromWhitelist('src/filter')->willReturn(null);
-        $filter->addDirectoryToBlacklist('src/filter')->willReturn(null);
-        $filter->addFileToWhitelist('src/filter/whilelisted_file')->willReturn(null);
-        $filter->removeFileFromWhitelist('src/filtered_file')->willReturn(null);
-        $filter->addFileToBlacklist('src/filtered_file')->willReturn(null);
+        $filter->addDirectoryToWhitelist('src')->shouldBeCalled();
+        $filter->removeDirectoryFromWhitelist('src/filter')->shouldBeCalled();
+        $filter->addFileToWhitelist('src/filter/whilelisted_file')->shouldBeCalled();
+        $filter->removeFileFromWhitelist('src/filtered_file')->shouldBeCalled();
 
         $this->beforeSuite($event);
     }

src/Listener/CodeCoverageListener.php

@@ -16,35 +16,44 @@ class CodeCoverageListener implements EventSubscriberInterface
     private $reports;
     private $io;
     private $options;
+    private $enabled;
 
     public function __construct(\PHP_CodeCoverage $coverage, array $reports)
     {
         $this->coverage = $coverage;
         $this->reports  = $reports;
         $this->options  = array(
             'whitelist' => array('src', 'lib'),
-            'blacklist' => array('vendor', 'spec'),
+            'blacklist' => array('test', 'vendor', 'spec'),
             'whitelist_files' => array(),
             'blacklist_files' => array(),
             'output'    => array('html' => 'coverage'),
             'format'    => array('html'),
         );
+
+        $this->enabled = extension_loaded('xdebug') || (PHP_SAPI === 'phpdbg');
     }
 
     public function beforeSuite(SuiteEvent $event)
     {
+        if (!$this->enabled) {
+            return;
+        }
+
         $filter = $this->coverage->filter();
 
         array_map(array($filter, 'addDirectoryToWhitelist'), $this->options['whitelist']);
         array_map(array($filter, 'removeDirectoryFromWhitelist'), $this->options['blacklist']);
-        array_map(array($filter, 'addDirectoryToBlacklist'), $this->options['blacklist']);
         array_map(array($filter, 'addFileToWhitelist'), $this->options['whitelist_files']);
         array_map(array($filter, 'removeFileFromWhitelist'), $this->options['blacklist_files']);
-        array_map(array($filter, 'addFileToBlacklist'), $this->options['blacklist_files']);
     }
 
     public function beforeExample(ExampleEvent $event)
     {
+        if (!$this->enabled) {
+            return;
+        }
+
         $example = $event->getExample();
 
         $name = strtr('%spec%::%example%', array(
@@ -57,11 +66,23 @@ public function beforeExample(ExampleEvent $event)
 
     public function afterExample(ExampleEvent $event)
     {
+        if (!$this->enabled) {
+            return;
+        }
+
         $this->coverage->stop();
     }
 
     public function afterSuite(SuiteEvent $event)
     {
+        if (!$this->enabled) {
+            if ($this->io && $this->io->isVerbose()) {
+                $this->io->writeln('Did not detect Xdebug extension or phpdbg. No code coverage will be generated.');
+            }
+
+            return;
+        }
+
         if ($this->io && $this->io->isVerbose()) {
             $this->io->writeln('');
         }
@@ -72,7 +93,7 @@ public function afterSuite(SuiteEvent $event)
             }
 
             if ($report instanceof \PHP_CodeCoverage_Report_Text) {
-                $output = $report->process($this->coverage, /* showColors */ true);
+                $output = $report->process($this->coverage, /* showColors */ $this->io->isDecorated());
                 $this->io->writeln($output);
             } else {
                 $report->process($this->coverage, $this->options['output'][$format]);