Passed
Push — nln-php7 ( 5c4f20...6ce259 )
by Nicolas
03:34
created

Generate   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 22
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 3
lcom 2
cbo 1
dl 0
loc 22
ccs 12
cts 12
cp 1
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 9 1
A getProcessor() 0 4 1
A launchConfigurationAction() 0 4 1
1
<?php
2
3
declare(strict_types = 1);
4
5
namespace Karma\Console;
6
7
use Karma\ConfigurableProcessor;
8
use Karma\Application;
9
10
class Generate extends ConfigureActionCommand
11
{
12 36
    public function __construct(Application $app)
13
    {
14 36
        parent::__construct(
15 36
            $app,
16 36
            'generate',
17 36
            'Generate configuration files for given environment',
18 36
            'Generate configuration files in'
19
        );
20 36
    }
21
22 7
    protected function getProcessor(): ConfigurableProcessor
23
    {
24 7
        return $this->app['configurationFilesGenerator'];
25
    }
26
27 7
    protected function launchConfigurationAction(ConfigurableProcessor $processor): void
28
    {
29 7
        $processor->generate($this->environment);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Karma\ConfigurableProcessor as the method generate() does only exist in the following implementations of said interface: Karma\Generator\Configur...s\AbstractFileGenerator, Karma\Generator\Configur...enerators\YamlGenerator.

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...
30 7
    }
31
}
32