Issues in ComposerToolHandler.php - All Issues - Inspection of "Merge pull request #117 from mmarynich/feature/php..." - bruli/php-git-hooks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2c2534...8be39a )

by Pablo

created 2018-10-23 07:41 UTC

Composer/Contract/Command/ComposerToolHandler.php (2 issues)

Labels

Bug 2

Severity

Minor 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace PhpGitHooks\Module\Composer\Contract\Command;

use Bruli\EventBusBundle\CommandBus\CommandHandlerInterface;
use Bruli\EventBusBundle\CommandBus\CommandInterface;
use Bruli\EventBusBundle\QueryBus\QueryBus;
use PhpGitHooks\Module\Composer\Contract\Exception\ComposerFilesNotFoundException;
use PhpGitHooks\Module\Files\Contract\Query\ComposerFilesExtractor;
use PhpGitHooks\Module\Files\Contract\Response\ComposerFilesResponse;
use PhpGitHooks\Module\Git\Contract\Response\BadJobLogoResponse;
use PhpGitHooks\Module\Git\Service\PreCommitOutputWriter;
use Symfony\Component\Console\Output\OutputInterface;

class ComposerToolHandler implements CommandHandlerInterface
{
    const CHECKING_MESSAGE = 'Checking composer files';
    /**
     * @var PreCommitOutputWriter
     */
    private $outputMessage;
    /**
     * @var OutputInterface
     */
    private $output;
    /**
     * @var QueryBus
     */
    private $queryBus;
    /**
     * ComposerTool constructor.
     *
     * @param QueryBus        $queryBus
     * @param OutputInterface $output
     */
    public function __construct(
        QueryBus $queryBus,
        OutputInterface $output
    ) {
        $this->output = $output;
        $this->queryBus = $queryBus;
    }

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

    /**
     * @param array  $files
     * @param string $errorMessage
     *
     * @throws ComposerFilesNotFoundException
     */
    private function execute(array $files, $errorMessage)
    {
        $composerFilesResponse = $this->getComposerFilesResponse($files);

        $this->outputMessage = new PreCommitOutputWriter(self::CHECKING_MESSAGE);
        if (true === $composerFilesResponse->isExists()) {
            $this->output->write($this->outputMessage->getMessage());

            $this->executeTool(
                $composerFilesResponse->isJsonFile(),
                $composerFilesResponse->isLockFile(),
                $errorMessage
            );
            $this->output->writeln($this->outputMessage->getSuccessfulMessage());
        }
    }

    /**
     * @param bool   $jsonFile
     * @param bool   $lockFile
     * @param string $errorMessage
     *
     * @throws ComposerFilesNotFoundException *
     */
    private function executeTool($jsonFile, $lockFile, $errorMessage)
    {
        if (true === $jsonFile && false === $lockFile) {
            $this->output->writeln($this->outputMessage->getFailMessage());
            $this->output->writeln(BadJobLogoResponse::paint($errorMessage));
            throw new ComposerFilesNotFoundException();
        }
    }

    /**
     * @param array $files
     *
     * @return ComposerFilesResponse
     */
    private function getComposerFilesResponse(array $files)
    {
        return $this->queryBus->handle(new ComposerFilesExtractor($files));
    }
}


Push — master ( 2c2534...8be39a )

Composer/Contract/Command/ComposerToolHandler.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

1		<?php
2
3		namespace PhpGitHooks\Module\Composer\Contract\Command;
4
5		use Bruli\EventBusBundle\CommandBus\CommandHandlerInterface;
6		use Bruli\EventBusBundle\CommandBus\CommandInterface;
7		use Bruli\EventBusBundle\QueryBus\QueryBus;
8		use PhpGitHooks\Module\Composer\Contract\Exception\ComposerFilesNotFoundException;
9		use PhpGitHooks\Module\Files\Contract\Query\ComposerFilesExtractor;
10		use PhpGitHooks\Module\Files\Contract\Response\ComposerFilesResponse;
11		use PhpGitHooks\Module\Git\Contract\Response\BadJobLogoResponse;
12		use PhpGitHooks\Module\Git\Service\PreCommitOutputWriter;
13		use Symfony\Component\Console\Output\OutputInterface;
14
15		class ComposerToolHandler implements CommandHandlerInterface
16		{
17		const CHECKING_MESSAGE = 'Checking composer files';
18		/**
19		* @var PreCommitOutputWriter
20		*/
21		private $outputMessage;
22		/**
23		* @var OutputInterface
24		*/
25		private $output;
26		/**
27		* @var QueryBus
28		*/
29		private $queryBus;
30		/**
31		* ComposerTool constructor.
32		*
33		* @param QueryBus $queryBus
34		* @param OutputInterface $output
35		*/
36	3	public function __construct(
37		QueryBus $queryBus,
38		OutputInterface $output
39		) {
40	3	$this->output = $output;
41	3	$this->queryBus = $queryBus;
42	3	}
43
44		/**
45		* @param CommandInterface\|ComposerTool $command
46		*/
47	3	public function handle(CommandInterface $command)
48		{
49	3	$this->execute($command->getFiles(), $command->getErrorMessage());
		0 ignored issues – show Bug introduced 2017-06-18 17:50 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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 Show Similar Issues like this 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...
50	2	}
51
52		/**
53		* @param array $files
54		* @param string $errorMessage
55		*
56		* @throws ComposerFilesNotFoundException
57		*/
58	3	private function execute(array $files, $errorMessage)
59		{
60	3	$composerFilesResponse = $this->getComposerFilesResponse($files);
61
62	3	$this->outputMessage = new PreCommitOutputWriter(self::CHECKING_MESSAGE);
63	3	if (true === $composerFilesResponse->isExists()) {
64	2	$this->output->write($this->outputMessage->getMessage());
65
66	2	$this->executeTool(
67	2	$composerFilesResponse->isJsonFile(),
68	2	$composerFilesResponse->isLockFile(),
69	2	$errorMessage
70		);
71	1	$this->output->writeln($this->outputMessage->getSuccessfulMessage());
72		}
73	2	}
74
75		/**
76		* @param bool $jsonFile
77		* @param bool $lockFile
78		* @param string $errorMessage
79		*
80		* @throws ComposerFilesNotFoundException *
81		*/
82	2	private function executeTool($jsonFile, $lockFile, $errorMessage)
83		{
84	2	if (true === $jsonFile && false === $lockFile) {
85	1	$this->output->writeln($this->outputMessage->getFailMessage());
86	1	$this->output->writeln(BadJobLogoResponse::paint($errorMessage));
87	1	throw new ComposerFilesNotFoundException();
88		}
89	1	}
90
91		/**
92		* @param array $files
93		*
94		* @return ComposerFilesResponse
95		*/
96	3	private function getComposerFilesResponse(array $files)
97		{
98	3	return $this->queryBus->handle(new ComposerFilesExtractor($files));
99		}
100		}
101

bruli / php-git-hooks

Push — master ( 2c2534...8be39a )

Composer/Contract/Command/ComposerToolHandler.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like