Completed
Branch module_structure (3116d9)
by Pablo
02:56
created

PrePushToolCommandHandler::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 4
rs 10
ccs 3
cts 3
cp 1
cc 1
eloc 2
nc 1
nop 1
crap 1
1
<?php
2
3
namespace PhpGitHooks\Module\Git\Contract\CommandHandler;
4
5
use CommandBus\CommandBus\CommandHandlerInterface;
6
use CommandBus\CommandBus\CommandInterface;
7
use PhpGitHooks\Module\Git\Contract\Command\PrePushToolCommand;
8
use PhpGitHooks\Module\Git\Service\PrePushTool;
9
10
class PrePushToolCommandHandler implements CommandHandlerInterface
11
{
12
    /**
13
     * @var PrePushTool
14
     */
15
    private $prePushTool;
16
17
    /**
18
     * PrePushToolCommandHandler constructor.
19
     *
20
     * @param PrePushTool $prePushTool
21
     */
22 3
    public function __construct(PrePushTool $prePushTool)
23
    {
24 3
        $this->prePushTool = $prePushTool;
25 3
    }
26
27
    /**
28
     * @param CommandInterface|PrePushToolCommand $command
29
     */
30 3
    public function handle(CommandInterface $command)
31
    {
32 3
        $this->prePushTool->execute($command->getRemote(), $command->getUrl());
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface CommandBus\CommandBus\CommandInterface as the method getRemote() does only exist in the following implementations of said interface: PhpGitHooks\Module\Git\C...mand\PrePushToolCommand.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
Bug introduced by
It seems like you code against a concrete implementation and not the interface CommandBus\CommandBus\CommandInterface as the method getUrl() does only exist in the following implementations of said interface: PhpGitHooks\Module\Git\C...mand\PrePushToolCommand.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
33 2
    }
34
}
35