PhpMdToolHandler::__construct() - 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

PhpMdToolHandler::__construct() A

↳ Parent: PhpMdToolHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	5
Ratio	100 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	5
loc	5
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2
crap	1

<?php

namespace PhpGitHooks\Module\PhpMd\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\PhpMd\Contract\Exception\PhpMdViolationsException;
use PhpGitHooks\Module\PhpMd\Model\PhpMdToolProcessorInterface;
use Symfony\Component\Console\Output\OutputInterface;

class PhpMdToolHandler implements CommandHandlerInterface

{
    const CHECKING_MESSAGE = 'Checking code mess with PHPMD';
    /**
     * @var OutputInterface
     */
    private $output;
    /**
     * @var PhpMdToolProcessorInterface
     */
    private $phpMdToolProcessor;

    /**
     * PhpMdTool constructor.
     *
     * @param OutputInterface             $output
     * @param PhpMdToolProcessorInterface $phpMdToolProcessor
     */
    public function __construct(OutputInterface $output, PhpMdToolProcessorInterface $phpMdToolProcessor)
    {
        $this->output = $output;
        $this->phpMdToolProcessor = $phpMdToolProcessor;
    }

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

        $errors = [];
        foreach ($files as $file) {
            $errors[] = $this->phpMdToolProcessor->process($file, $options);
        }

        $errors = array_filter($errors);

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

        $this->output->writeln($outputMessage->getSuccessfulMessage());
    }

    /**
     * @param CommandInterface|PhpMdTool $command
     */
    public function handle(CommandInterface $command)
    {
        $this->execute($command->getFiles(), $command->getOptions(), $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.
    }
}
    }
}


Push — master ( 835840...ce2316 )

PhpMdToolHandler::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace PhpGitHooks\Module\PhpMd\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\PhpMd\Contract\Exception\PhpMdViolationsException;
10			use PhpGitHooks\Module\PhpMd\Model\PhpMdToolProcessorInterface;
11			use Symfony\Component\Console\Output\OutputInterface;
12
13		View Code Duplication	class PhpMdToolHandler 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 CHECKING_MESSAGE = 'Checking code mess with PHPMD';
16			/**
17			* @var OutputInterface
18			*/
19			private $output;
20			/**
21			* @var PhpMdToolProcessorInterface
22			*/
23			private $phpMdToolProcessor;
24
25			/**
26			* PhpMdTool constructor.
27			*
28			* @param OutputInterface $output
29			* @param PhpMdToolProcessorInterface $phpMdToolProcessor
30			*/
31	2		public function __construct(OutputInterface $output, PhpMdToolProcessorInterface $phpMdToolProcessor)
32			{
33	2		$this->output = $output;
34	2		$this->phpMdToolProcessor = $phpMdToolProcessor;
35	2		}
36
37			/**
38			* @param array $files
39			* @param string $options
40			* @param string $errorMessage
41			*
42			* @throws PhpMdViolationsException
43			*/
44	2		private function execute(array $files, $options, $errorMessage)
45			{
46	2		$outputMessage = new PreCommitOutputWriter(self::CHECKING_MESSAGE);
47	2		$this->output->write($outputMessage->getMessage());
48
49	2		$errors = [];
50	2		foreach ($files as $file) {
51	2		$errors[] = $this->phpMdToolProcessor->process($file, $options);
52			}
53
54	2		$errors = array_filter($errors);
55
56	2		if (!empty($errors)) {
57	1		$outputText = $outputMessage->setError(implode('', $errors));
58	1		$this->output->writeln($outputMessage->getFailMessage());
59	1		$this->output->writeln($outputText);
60	1		$this->output->writeln(BadJobLogoResponse::paint($errorMessage));
61	1		throw new PhpMdViolationsException();
62			}
63
64	1		$this->output->writeln($outputMessage->getSuccessfulMessage());
65	1		}
66
67			/**
68			* @param CommandInterface\|PhpMdTool $command
69			*/
70	2		public function handle(CommandInterface $command)
71			{
72	2		$this->execute($command->getFiles(), $command->getOptions(), $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 `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... 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 `getOptions()` does only exist in the following implementations of said interface: `PhpGitHooks\Module\PhpCs...\Command\PhpCsFixerTool`, `PhpGitHooks\Module\PhpMd...tract\Command\PhpMdTool`, `PhpGitHooks\Module\PhpUn...act\Command\PhpUnitTool`. 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... 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...
73	1		}
74			}
75

bruli / php-git-hooks

Push — master ( 835840...ce2316 )

PhpMdToolHandler::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like