CodeCoverageListener::afterSuite() - Code Metrics - Inspection of "Avoid start stop driver on each spec" - leanphp/phpspec-code-coverage - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#39)

by Stéphane

created 2020-01-08 11:32 UTC

CodeCoverageListener::afterSuite() B

↳ Parent: CodeCoverageListener

Complexity

Conditions	10
Paths	12

Size

Total Lines	25
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	14
nc	12
nop	1
dl	0
loc	25
rs	7.6666
c	1
b	0
f	0

How to fix Complexity

<?php

/**
 * This file is part of the friends-of-phpspec/phpspec-code-coverage package.
 *
 * @author  ek9 <[email protected]>
 * @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\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 afterSuite(SuiteEvent $event): void
    public function afterSuite(/** @scrutinizer ignore-unused */ 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]);
            }
        }
    }

    /**
     * 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
    public function beforeSuite(/** @scrutinizer ignore-unused */ 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 [
            'beforeSuite' => ['beforeSuite', -10],
            'afterSuite' => ['afterSuite', -10],
        ];
    }

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


leanphp / phpspec-code-coverage

Pull Request — master (#39)

CodeCoverageListener::afterSuite() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like