Merge pull request #9 from datashaman/feature/2-coverage

Add coverage

.gitignore

@@ -1,3 +1,4 @@
+/build/
 /composer.lock
 /.phpcheck/
 /php_errors.log

Makefile

@@ -1,6 +1,12 @@
 phpcheck:
 	@phpcheck
 
+phpcheck-coverage-html:
+	@phpcheck --coverage-html build/coverage
+
+phpcheck-coverage-text:
+	@phpcheck --coverage-text
+
 phpcheck-no-defects:
 	@phpcheck -d
 

checks/GenCheck.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Checks;
 
 use Datashaman\PHPCheck\Check;

composer.json

@@ -33,7 +33,8 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.14",
-        "phpmd/phpmd": "^2.6"
+        "phpmd/phpmd": "^2.6",
+        "phpunit/php-code-coverage": "^7.0"
     },
     "config": {
         "platform": {

src/ArgumentFactory.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 use Exception;

src/Check.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 class Check

src/CheckCommand.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 use Symfony\Component\Console\Command\Command;
@@ -27,11 +26,13 @@ class CheckCommand extends Command
     protected function configure(): void
     {
         $this
-            ->setDescription('Runs checks.')
-            ->addOption('bootstrap', null, InputOption::VALUE_OPTIONAL, 'A PHP script that is included before the tests run')
+            ->setDescription('Run checks.')
+            ->addOption('bootstrap', null, InputOption::VALUE_OPTIONAL, 'A PHP script that is included before the checks run')
+            ->addOption('coverage-html', null, InputOption::VALUE_OPTIONAL, 'Generate code coverage report in HTML', false)
+            ->addOption('coverage-text', null, InputOption::VALUE_OPTIONAL, 'Generate code coverage report in text', false)
             ->addOption('filter', 'f', InputOption::VALUE_OPTIONAL, 'Filter the checks that will be run')
             ->addOption('iterations', 'i', InputOption::VALUE_REQUIRED, 'How many times each check will be run', Runner::MAX_ITERATIONS)
-            ->addOption('log-junit', 'j', InputOption::VALUE_OPTIONAL, 'Log test execution in JUnit XML format to file')
+            ->addOption('log-junit', 'j', InputOption::VALUE_OPTIONAL, 'Log check execution in JUnit XML format to file')
             ->addOption('no-defects', 'd', InputOption::VALUE_OPTIONAL, 'Ignore previous defects', false)
             ->addOption('seed', 's', InputOption::VALUE_OPTIONAL, 'Seed the random number generator to get repeatable runs')
             ->addArgument('path', InputArgument::OPTIONAL, 'File or folder with checks', 'checks');

src/CheckEvents.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 final class CheckEvents

src/Events/EndAllEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 class EndAllEvent extends Event

src/Events/EndEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 use ReflectionMethod;

src/Events/ErrorEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 class ErrorEvent extends ResultEvent

src/Events/Event.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 abstract class Event extends \Symfony\Component\EventDispatcher\Event

src/Events/FailureEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 class FailureEvent extends ResultEvent

src/Events/ResultEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 use ReflectionMethod;

src/Events/StartAllEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 class StartAllEvent extends Event

src/Events/StartEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 use ReflectionMethod;

src/Events/SuccessEvent.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Events;
 
 class SuccessEvent extends ResultEvent

src/ExecutionError.php

@@ -7,7 +7,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 use Exception;

src/ExecutionFailure.php

@@ -7,7 +7,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 use Exception;

src/Gen.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 use Faker\Factory;

src/Reporters/ConsoleReporter.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Reporters;
 
 use Datashaman\PHPCheck\CheckCommand;

src/Reporters/HtmlCoverageReporter.php

@@ -0,0 +1,57 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of the phpcheck package.
+ *
+ * ©Marlin Forbes <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace Datashaman\PHPCheck\Reporters;
+
+use Datashaman\PHPCheck\CheckEvents;
+use Datashaman\PHPCheck\Events;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\Report\Html\Facade as HtmlFacade;
+
+class HtmlCoverageReporter extends Reporter
+{
+    protected $coverage;
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            CheckEvents::END       => 'onEnd',
+            CheckEvents::END_ALL   => 'onEndAll',
+            CheckEvents::START     => 'onStart',
+            CheckEvents::START_ALL => 'onStartAll',
+        ];
+    }
+
+    public function onEnd(Events\EndEvent $event): void
+    {
+        $this->coverage->stop();
+    }
+
+    public function onEndAll(Events\EndAllEvent $event): void
+    {
+        $writer = new HtmlFacade();
+        $writer->process($this->coverage, $this->input->getOption('coverage-html'));
+    }
+
+    public function onStart(Events\StartEvent $event): void
+    {
+        $this->coverage->start($event->method->getName());
+    }
+
+    public function onStartAll(Events\StartAllEvent $event): void
+    {
+        if (!$this->input->getOption('coverage-html')) {
+            $this->output->writeln('<error>You must specify a folder with --coverage-html</error>');
+            exit(1);
+        }
+
+        $this->coverage = new CodeCoverage();
+        $this->coverage->filter()->addDirectoryToWhitelist('./src');
+    }
+}

src/Reporters/JUnitReporter.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Reporters;
 
 use Datashaman\PHPCheck\CheckEvents;

src/Reporters/Reporter.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck\Reporters;
 
 use Datashaman\PHPCheck\Runner;

src/Reporters/TextCoverageReporter.php

@@ -0,0 +1,61 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of the phpcheck package.
+ *
+ * ©Marlin Forbes <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace Datashaman\PHPCheck\Reporters;
+
+use Datashaman\PHPCheck\CheckEvents;
+use Datashaman\PHPCheck\Events;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\Report\Text;
+
+class TextCoverageReporter extends Reporter
+{
+    protected $coverage;
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            CheckEvents::END       => 'onEnd',
+            CheckEvents::END_ALL   => 'onEndAll',
+            CheckEvents::START     => 'onStart',
+            CheckEvents::START_ALL => 'onStartAll',
+        ];
+    }
+
+    public function onEnd(Events\EndEvent $event): void
+    {
+        $this->coverage->stop();
+    }
+
+    public function onEndAll(Events\EndAllEvent $event): void
+    {
+        $writer = new Text();
+
+
+        if ($this->input->getOption('coverage-text')) {
+            $output = $writer->process($this->coverage, false);
+            file_put_contents($this->input->getOption('coverage-text'), $output);
+
+            return;
+        }
+
+        print $writer->process($this->coverage, true);
+    }
+
+    public function onStart(Events\StartEvent $event): void
+    {
+        $this->coverage->start($event->method->getName());
+    }
+
+    public function onStartAll(Events\StartAllEvent $event): void
+    {
+        $this->coverage = new CodeCoverage();
+        $this->coverage->filter()->addDirectoryToWhitelist('./src');
+    }
+}

src/RunState.php

@@ -7,7 +7,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 use ReflectionMethod;

src/Runner.php

@@ -9,7 +9,6 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-
 namespace Datashaman\PHPCheck;
 
 use InvalidArgumentException;
@@ -148,6 +147,14 @@ public function execute(InputInterface $input, OutputInterface $output): void
 
         $this->dispatcher->addSubscriber(new Reporters\ConsoleReporter($this));
 
+        if ($input->getOption('coverage-html') !== false) {
+            $this->dispatcher->addSubscriber(new Reporters\HtmlCoverageReporter($this));
+        }
+
+        if ($input->getOption('coverage-text') !== false) {
+            $this->dispatcher->addSubscriber(new Reporters\TextCoverageReporter($this));
+        }
+
         if ($input->getOption('log-junit')) {
             $reporter = new Reporters\JUnitReporter($this);
             $this->dispatcher->addSubscriber($reporter);