Completed
Push — dev ( a8234e...9312cf )
by Zach
04:40
created

SignatureParser   A

Complexity

Total Complexity 6

Size/Duplication

Total Lines 67
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Importance

Changes 0
Metric Value
dl 0
loc 67
rs 10
c 0
b 0
f 0
wmc 6
lcom 1
cbo 3

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A parse() 0 16 3
A setName() 0 4 1
A extractArgumentsOptions() 0 8 1
1
<?php
2
3
namespace Yarak\Console;
4
5
use Yarak\Console\Input\Option;
6
use Yarak\Console\Input\Argument;
7
use Symfony\Component\Console\Command\Command;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Yarak\Console\Command.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
8
9
class SignatureParser
10
{
11
    /**
12
     * The command to build.
13
     *
14
     * @var Command
15
     */
16
    protected $command;
17
18
    /**
19
     * Construct.
20
     *
21
     * @param Command $command
22
     */
23
    public function __construct(Command $command)
24
    {
25
        $this->command = $command;
26
    }
27
28
    /**
29
     * Parse the command signature.
30
     *
31
     * @param string $signature
32
     */
33
    public function parse($signature)
34
    {
35
        $this->setName($signature);
36
37
        $argumentsOptions = $this->extractArgumentsOptions($signature);
38
39
        foreach ($argumentsOptions as $value) {
40
            if (substr($value, 0, 2) !== '--') {
41
                $input = new Argument($value);
42
            } else {
43
                $input = new Option(trim($value, '--'));
44
            }
45
46
            $this->command->addInput($input->parse());
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Symfony\Component\Console\Command\Command as the method addInput() does only exist in the following sub-classes of Symfony\Component\Console\Command\Command: Yarak\Commands\ConsoleGenerate, Yarak\Commands\DBGenerate, Yarak\Commands\DBSeed, Yarak\Commands\MakeCommand, Yarak\Commands\MakeMigration, Yarak\Commands\MakeSeeder, Yarak\Commands\Migrate, Yarak\Commands\MigrateRefresh, Yarak\Commands\MigrateReset, Yarak\Commands\MigrateRollback, Yarak\Console\Command, Yarak\Console\Stubs\NullCommand, Yarak\Console\YarakCommand. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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 sub-classes 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 parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
47
        }
48
    }
49
50
    /**
51
     * Set the command name.
52
     *
53
     * @param string $signature
54
     */
55
    protected function setName($signature)
56
    {
57
        $this->command->setName(preg_split('/\s+/', $signature)[0]);
58
    }
59
60
    /**
61
     * Extract arguments and options from signature.
62
     *
63
     * @param string $signature
64
     *
65
     * @return array
66
     */
67
    protected function extractArgumentsOptions($signature)
68
    {
69
        preg_match_all('/{(.*?)}/', $signature, $argumentsOption);
70
71
        return array_map(function ($item) {
72
            return trim($item, '{}');
73
        }, $argumentsOption[1]);
74
    }
75
}
76