PhpCsToolHandler - Code Metrics - Inspection of "Remove services for phpunit and rename commands an..." - bruli/php-git-hooks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 835840...ce2316 )

by Pablo

created 2017-06-18 17:48 UTC

PhpCsToolHandler A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	66
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	5
dl	66
loc	66
ccs	25
cts	25
cp	1
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	5	5	1
A	execute()	20	20	3
A	handle()	9	9	1

How to fix Duplicated Code

<?php

namespace PhpGitHooks\Module\PhpCs\Contract\Command;

use Bruli\EventBusBundle\CommandBus\CommandHandlerInterface;
use Bruli\EventBusBundle\CommandBus\CommandInterface;
use PhpGitHooks\Module\Git\Contract\Response\BadJobLogoResponse;
use PhpGitHooks\Module\Git\Service\PreCommitOutputWriter;
use PhpGitHooks\Module\PhpCs\Contract\Exception\PhpCsViolationException;
use PhpGitHooks\Module\PhpCs\Model\PhpCsToolProcessorInterface;
use Symfony\Component\Console\Output\OutputInterface;

class PhpCsToolHandler implements CommandHandlerInterface

{
    const EXECUTE_MESSAGE = 'Checking code style with PHPCS';
    /**
     * @var OutputInterface
     */
    private $output;
    /**
     * @var PhpCsToolProcessorInterface
     */
    private $phpCsToolProcessor;

    /**
     * PhpCsTool constructor.
     *
     * @param OutputInterface $output
     * @param PhpCsToolProcessorInterface $phpCsToolProcessor
     */
    public function __construct(OutputInterface $output, PhpCsToolProcessorInterface $phpCsToolProcessor)
    {
        $this->output = $output;
        $this->phpCsToolProcessor = $phpCsToolProcessor;
    }

    /**
     * @param array $files
     * @param string $standard
     * @param string $errorMessage
     * @param string $ignore
     *
     * @throws PhpCsViolationException
     */
    private function execute(array $files, $standard, $errorMessage, $ignore)
    {
        $outputMessage = new PreCommitOutputWriter(self::EXECUTE_MESSAGE);
        $this->output->write($outputMessage->getMessage());

        $errors = [];
        foreach ($files as $file) {
            $errors[] = $this->phpCsToolProcessor->process($file, $standard, $ignore);
        }

        $errors = array_filter($errors);

        if (!empty($errors)) {
            $this->output->writeln($outputMessage->getFailMessage());
            $this->output->writeln($outputMessage->setError(implode('', $errors)));
            $this->output->writeln(BadJobLogoResponse::paint($errorMessage));
            throw new PhpCsViolationException();
        }
        $this->output->writeln($outputMessage->getSuccessfulMessage());
    }

    /**
     * @param CommandInterface|PhpCsTool $command
     */
    public function handle(CommandInterface $command)
    {
        $this->execute(
            $command->getFiles(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $command->getStandard(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $command->getErrorMessage(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $command->getIgnore()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        );
    }
}


Push — master ( 835840...ce2316 )

PhpCsToolHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace PhpGitHooks\Module\PhpCs\Contract\Command;
4
5			use Bruli\EventBusBundle\CommandBus\CommandHandlerInterface;
6			use Bruli\EventBusBundle\CommandBus\CommandInterface;
7			use PhpGitHooks\Module\Git\Contract\Response\BadJobLogoResponse;
8			use PhpGitHooks\Module\Git\Service\PreCommitOutputWriter;
9			use PhpGitHooks\Module\PhpCs\Contract\Exception\PhpCsViolationException;
10			use PhpGitHooks\Module\PhpCs\Model\PhpCsToolProcessorInterface;
11			use Symfony\Component\Console\Output\OutputInterface;
12
13		View Code Duplication	class PhpCsToolHandler implements CommandHandlerInterface
			0 ignored issues – show Duplication introduced 2017-06-18 17:50 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
14			{
15			const EXECUTE_MESSAGE = 'Checking code style with PHPCS';
16			/**
17			* @var OutputInterface
18			*/
19			private $output;
20			/**
21			* @var PhpCsToolProcessorInterface
22			*/
23			private $phpCsToolProcessor;
24
25			/**
26			* PhpCsTool constructor.
27			*
28			* @param OutputInterface $output
29			* @param PhpCsToolProcessorInterface $phpCsToolProcessor
30			*/
31	2		public function __construct(OutputInterface $output, PhpCsToolProcessorInterface $phpCsToolProcessor)
32			{
33	2		$this->output = $output;
34	2		$this->phpCsToolProcessor = $phpCsToolProcessor;
35	2		}
36
37			/**
38			* @param array $files
39			* @param string $standard
40			* @param string $errorMessage
41			* @param string $ignore
42			*
43			* @throws PhpCsViolationException
44			*/
45	2		private function execute(array $files, $standard, $errorMessage, $ignore)
46			{
47	2		$outputMessage = new PreCommitOutputWriter(self::EXECUTE_MESSAGE);
48	2		$this->output->write($outputMessage->getMessage());
49
50	2		$errors = [];
51	2		foreach ($files as $file) {
52	2		$errors[] = $this->phpCsToolProcessor->process($file, $standard, $ignore);
53			}
54
55	2		$errors = array_filter($errors);
56
57	2		if (!empty($errors)) {
58	1		$this->output->writeln($outputMessage->getFailMessage());
59	1		$this->output->writeln($outputMessage->setError(implode('', $errors)));
60	1		$this->output->writeln(BadJobLogoResponse::paint($errorMessage));
61	1		throw new PhpCsViolationException();
62			}
63	1		$this->output->writeln($outputMessage->getSuccessfulMessage());
64	1		}
65
66			/**
67			* @param CommandInterface\|PhpCsTool $command
68			*/
69	2		public function handle(CommandInterface $command)
70			{
71	2		$this->execute(
72	2		$command->getFiles(),
			0 ignored issues – show Bug introduced 2017-06-18 17:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Bruli\EventBusBundle\CommandBus\CommandInterface` as the method `getFiles()` does only exist in the following implementations of said interface: `PhpGitHooks\Module\Compo...ct\Command\ComposerTool`, `PhpGitHooks\Module\JsonL...ct\Command\JsonLintTool`, `PhpGitHooks\Module\PhpCs...\Command\PhpCsFixerTool`, `PhpGitHooks\Module\PhpCs...tract\Command\PhpCsTool`, `PhpGitHooks\Module\PhpLi...act\Command\PhpLintTool`, `PhpGitHooks\Module\PhpMd...tract\Command\PhpMdTool`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
73	2		$command->getStandard(),
			0 ignored issues – show Bug introduced 2017-06-18 17:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Bruli\EventBusBundle\CommandBus\CommandInterface` as the method `getStandard()` does only exist in the following implementations of said interface: `PhpGitHooks\Module\PhpCs...tract\Command\PhpCsTool`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
74	2		$command->getErrorMessage(),
			0 ignored issues – show Bug introduced 2017-06-18 17:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Bruli\EventBusBundle\CommandBus\CommandInterface` as the method `getErrorMessage()` does only exist in the following implementations of said interface: `PhpGitHooks\Module\Compo...ct\Command\ComposerTool`, `PhpGitHooks\Module\JsonL...ct\Command\JsonLintTool`, `PhpGitHooks\Module\PhpCs...\Command\PhpCsFixerTool`, `PhpGitHooks\Module\PhpCs...tract\Command\PhpCsTool`, `PhpGitHooks\Module\PhpLi...act\Command\PhpLintTool`, `PhpGitHooks\Module\PhpMd...tract\Command\PhpMdTool`, `PhpGitHooks\Module\PhpUn...act\Command\PhpUnitTool`, `PhpGitHooks\Module\PhpUn...\Command\StrictCoverage`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
75	2		$command->getIgnore()
			0 ignored issues – show Bug introduced 2017-06-18 17:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Bruli\EventBusBundle\CommandBus\CommandInterface` as the method `getIgnore()` does only exist in the following implementations of said interface: `PhpGitHooks\Module\PhpCs...tract\Command\PhpCsTool`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
76			);
77	1		}
78			}
79

bruli / php-git-hooks

Push — master ( 835840...ce2316 )

PhpCsToolHandler A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like