FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener\CodeCoverageListener

Complexity

Total Complexity

33

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Test Coverage

Coverage

8.77%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	afterExample()	0	7	2
A	setOptions()	0	3	1
A	getSubscribedEvents()	0	7	1
B	checkMinimumCoveragePercent()	0	43	9
A	beforeExample()	0	20	3
B	afterSuite()	0	29	10
A	beforeSuite()	0	22	6

<?php

/**
 * This file is part of the friends-of-phpspec/phpspec-code-coverage package.
 *
 * @author  ek9 <dev@ek9.co>
 * @license MIT
 *
 * For the full copyright and license information, please see the LICENSE file
 * that was distributed with this source code.
 */

declare(strict_types=1);

namespace FriendsOfPhpSpec\PhpSpec\CodeCoverage\Listener;

use PhpSpec\Console\ConsoleIO;
use PhpSpec\Event\ExampleEvent;
use PhpSpec\Event\SuiteEvent;
use SebastianBergmann\CodeCoverage\CodeCoverage;
use SebastianBergmann\CodeCoverage\Report;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * @author Henrik Bjornskov
 */
class CodeCoverageListener implements EventSubscriberInterface
{
    private $coverage;

    private $io;

    private $options;

    private $reports;

    private $skipCoverage;

    public function __construct(ConsoleIO $io, CodeCoverage $coverage, array $reports, bool $skipCoverage = false)
    {
        $this->io = $io;
        $this->coverage = $coverage;
        $this->reports = $reports;
        $this->options = [
            'whitelist' => ['src', 'lib'],
            'blacklist' => ['test', 'vendor', 'spec'],
            'whitelist_files' => [],
            'blacklist_files' => [],
            'output' => ['html' => 'coverage'],
            'format' => ['html'],
        ];

        $this->skipCoverage = $skipCoverage;
    }

    public function afterExample(ExampleEvent $event): void
    {
        if ($this->skipCoverage) {
            return;
        }

        $this->coverage->stop();
    }

    public function afterSuite(SuiteEvent $event): void
    {
        if ($this->skipCoverage) {
            if ($this->io && $this->io->isVerbose()) {
                $this->io->writeln('Skipping code coverage generation');
            }

            return;
        }

        if ($this->io && $this->io->isVerbose()) {
            $this->io->writeln();
        }

        foreach ($this->reports as $format => $report) {
            if ($this->io && $this->io->isVerbose()) {
                $this->io->writeln(sprintf('Generating code coverage report in %s format ...', $format));
            }

            if ($report instanceof Report\Text) {
                $this->io->writeln(
                    $report->process($this->coverage, $this->io->isDecorated())
                );
            } else {
                $report->process($this->coverage, $this->options['output'][$format]);
            }
        }

        $this->checkMinimumCoveragePercent();
    }

    public function beforeExample(ExampleEvent $event): void
    {
        if ($this->skipCoverage) {
            return;
        }

        $example = $event->getExample();

        $name = null;

        if (null !== $spec = $example->getSpecification()) {
            $name = $spec->getClassReflection()->getName();
        }

        $name = strtr('%spec%::%example%', [
            '%spec%' => $name,
            '%example%' => $example->getFunctionReflection()->getName(),
        ]);

        $this->coverage->start($name);
    }

    /**
     * Note: We use array_map() instead of array_walk() because the latter expects
     * the callback to take the value as the first and the index as the seconds parameter.
     *
     * @param SuiteEvent $event
     */
    public function beforeSuite(SuiteEvent $event): void
    {
        if ($this->skipCoverage) {
            return;
        }

        $filter = $this->coverage->filter();

        foreach ($this->options['whitelist'] as $option) {
            $filter->addDirectoryToWhitelist($option);
        }

        foreach ($this->options['blacklist'] as $option) {
            $filter->removeDirectoryFromWhitelist($option);
        }

        foreach ($this->options['whitelist_files'] as $option) {
            $filter->addFilesToWhitelist($option);
        }

        foreach ($this->options['blacklist_files'] as $option) {
            $filter->removeFileFromWhitelist($option);
        }
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents(): array
    {
        return [
            'beforeExample' => ['beforeExample', -10],
            'afterExample' => ['afterExample', -10],
            'beforeSuite' => ['beforeSuite', -10],
            'afterSuite' => ['afterSuite', -10],
        ];
    }

    public function setOptions(array $options): void
    {
        $this->options = $options + $this->options;
    }

    /**
     * @throws \Exception
     */
    private function checkMinimumCoveragePercent(): void
    {
        $report = $this->coverage->getReport();

        $coverageMessage = '%s coverage is too low as specified by minimum configuration: %.2f%% expected, %.2f covered.';

        $lineMinimum = $this->options['minimum']['lines'] ?? false;
        if ($lineMinimum !== false && (string) $lineMinimum > $report->getLineExecutedPercent()) {
            throw new \Exception(sprintf(
                $coverageMessage,
                'Line',
                $lineMinimum,
                $report->getLineExecutedPercent()
            ));
        }

        $classMinimum = $this->options['minimum']['classes'] ?? false;
        if ($classMinimum !== false && (string) $classMinimum > $report->getTestedClassesPercent()) {
            throw new \Exception(sprintf(
                $coverageMessage,
                'Class',
                $classMinimum,
                $report->getTestedClassesPercent()
            ));
        }

        $methodMinimum = $this->options['minimum']['methods'] ?? false;
        if ($methodMinimum !== false && (string) $methodMinimum > $report->getTestedMethodsPercent()) {
            throw new \Exception(sprintf(
                $coverageMessage,
                'Methods',
                $methodMinimum,
                $report->getTestedMethodsPercent()
            ));
        }

        $functionsMinimum = $this->options['minimum']['functions'] ?? false;
        if ($functionsMinimum !== false && (string) $functionsMinimum > $report->getTestedFunctionsPercent()) {
            throw new \Exception(sprintf(
                $coverageMessage,
                'Functions',
                $functionsMinimum,
                $report->getTestedFunctionsPercent()
            ));
        }
    }
}