PragmaDefinitionDelegate - Code Metrics - Inspection of "upd" - railt/compiler - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( db8578...85f9c3 )

by Kirill

created 2018-06-26 11:19 UTC

PragmaDefinitionDelegate A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

Importance

Changes

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

3 Methods

Rating	Name	Size	Complexity
A	getDefinition()	4	1
A	getPragmaName()	4	1
A	getPragmaValue()	4	1

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\Compiler\Grammar\PP2\Delegate;

use Railt\Parser\Ast\LeafInterface;
use Railt\Parser\Ast\NodeInterface;
use Railt\Parser\Ast\Rule;

/**
 * Class PragmaDelegate
 */
class PragmaDefinitionDelegate extends Rule
{
    /**
     * @return LeafInterface|NodeInterface
     */
    private function getDefinition(): LeafInterface
    {
        return $this->getChild(0);
    }

    /**
     * @return string
     */
    public function getPragmaName(): string
    {
        return $this->getDefinition()->getValue(1);
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.
    }
}
    }

    /**
     * @return string
     */
    public function getPragmaValue(): string
    {
        return $this->getDefinition()->getValue(2);
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.
    }
}
    }
}


Push — master ( db8578...85f9c3 )

PragmaDefinitionDelegate A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Available Fixes

1			<?php
2			/**
3			* This file is part of Railt package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8			declare(strict_types=1);
9
10			namespace Railt\Compiler\Grammar\PP2\Delegate;
11
12			use Railt\Parser\Ast\LeafInterface;
13			use Railt\Parser\Ast\NodeInterface;
14			use Railt\Parser\Ast\Rule;
15
16			/**
17			* Class PragmaDelegate
18			*/
19			class PragmaDefinitionDelegate extends Rule
20			{
21			/**
22			* @return LeafInterface\|NodeInterface
23			*/
24			private function getDefinition(): LeafInterface
25			{
26			return $this->getChild(0);
27			}
28
29			/**
30			* @return string
31			*/
32			public function getPragmaName(): string
33			{
34			return $this->getDefinition()->getValue(1);
			0 ignored issues – show Bug introduced 2018-06-26 11:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\NodeInterface` as the method `getValue()` does only exist in the following implementations of said interface: `Railt\Parser\Ast\Leaf`. 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...
35			}
36
37			/**
38			* @return string
39			*/
40			public function getPragmaValue(): string
41			{
42			return $this->getDefinition()->getValue(2);
			0 ignored issues – show Bug introduced 2018-06-26 11:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\NodeInterface` as the method `getValue()` does only exist in the following implementations of said interface: `Railt\Parser\Ast\Leaf`. 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...
43			}
44			}
45

railt / compiler

Push — master ( db8578...85f9c3 )

PragmaDefinitionDelegate A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like