Completed
Pull Request — master (#85)
by
unknown
02:27
created

ConfigurationProcessorCommandHandler   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 25
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Test Coverage

Coverage 83.33%

Importance

Changes 0
Metric Value
wmc 2
lcom 1
cbo 1
dl 0
loc 25
ccs 5
cts 6
cp 0.8333
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A handle() 0 4 1
1
<?php
2
3
namespace PhpGitHooks\Module\Configuration\Contract\CommandHandler;
4
5
use Bruli\EventBusBundle\CommandBus\CommandHandlerInterface;
6
use Bruli\EventBusBundle\CommandBus\CommandInterface;
7
use PhpGitHooks\Module\Configuration\Contract\Command\ConfigurationProcessorCommand;
8
use PhpGitHooks\Module\Configuration\Service\ConfigurationProcessor;
9
10
class ConfigurationProcessorCommandHandler implements CommandHandlerInterface
11
{
12
    /**
13
     * @var ConfigurationProcessor
14
     */
15
    private $configurationProcessor;
16
17
    /**
18
     * ConfigurationProcessorCommandHandler constructor.
19
     *
20
     * @param ConfigurationProcessor $configurationProcessor
21
     */
22 2
    public function __construct(ConfigurationProcessor $configurationProcessor)
23
    {
24 2
        $this->configurationProcessor = $configurationProcessor;
25 2
    }
26
27
    /**
28
     * @param CommandInterface|ConfigurationProcessorCommand $command
29
     */
30 1
    public function handle(CommandInterface $command)
31
    {
32 1
        $this->configurationProcessor->process($command->getInput());
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Bruli\EventBusBundle\CommandBus\CommandInterface as the method getInput() does only exist in the following implementations of said interface: PhpGitHooks\Module\Confi...urationProcessorCommand, PhpGitHooks\Module\Git\C...ommand\CommitMsgCommand.

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
    }
34
}
35