DirectiveArgumentBuilder::build() - Code Metrics - Inspection of "Improve building logic" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 22fff6...9c0de7 )

by Kirill

created 2018-08-06 05:14 UTC

DirectiveArgumentBuilder::build() A

↳ Parent: DirectiveArgumentBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
dl	0
loc	9
ccs	0
cts	7
cp	0
crap	2
rs	9.9666
c	0
b	0
f	0

<?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\SDL\Compiler\Builder\Invocation;

use Railt\Parser\Ast\RuleInterface;
use Railt\Reflection\Contracts\Definition;
use Railt\Reflection\Invocation\Dependent\ArgumentInvocation;
use Railt\Reflection\Invocation\DirectiveInvocation;
use Railt\SDL\Compiler\Ast\Invocation\DirectiveArgumentNode;
use Railt\SDL\Compiler\Builder\Builder;

/**
 * Class DirectiveArgumentBuilder
 */
class DirectiveArgumentBuilder extends Builder
{
    /**
     * @param RuleInterface|DirectiveArgumentNode $rule
     * @param Definition|DirectiveInvocation $parent
     * @return Definition
     */
    public function build(RuleInterface $rule, Definition $parent): Definition
    {
        $value = $rule->getArgumentValue();
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.
    }
}

        $argument = new ArgumentInvocation($parent, $rule->getArgumentName(), $value->toPrimitive());
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.
    }
}
        $argument->withOffset($rule->getOffset());

        return $argument;
    }
}


Push — master ( 22fff6...9c0de7 )

DirectiveArgumentBuilder::build() A

Complexity

Size

Duplication

Code Coverage

Importance

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\SDL\Compiler\Builder\Invocation;
11
12			use Railt\Parser\Ast\RuleInterface;
13			use Railt\Reflection\Contracts\Definition;
14			use Railt\Reflection\Invocation\Dependent\ArgumentInvocation;
15			use Railt\Reflection\Invocation\DirectiveInvocation;
16			use Railt\SDL\Compiler\Ast\Invocation\DirectiveArgumentNode;
17			use Railt\SDL\Compiler\Builder\Builder;
18
19			/**
20			* Class DirectiveArgumentBuilder
21			*/
22			class DirectiveArgumentBuilder extends Builder
23			{
24			/**
25			* @param RuleInterface\|DirectiveArgumentNode $rule
26			* @param Definition\|DirectiveInvocation $parent
27			* @return Definition
28			*/
29			public function build(RuleInterface $rule, Definition $parent): Definition
30			{
31			$value = $rule->getArgumentValue();
			0 ignored issues – show Bug introduced 2018-08-06 05:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\RuleInterface` as the method `getArgumentValue()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\I...n\DirectiveArgumentNode`. 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...
32
33			$argument = new ArgumentInvocation($parent, $rule->getArgumentName(), $value->toPrimitive());
			0 ignored issues – show Bug introduced 2018-08-06 05:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\RuleInterface` as the method `getArgumentName()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\D...\ArgumentDefinitionNode`, `Railt\SDL\Compiler\Ast\I...n\DirectiveArgumentNode`. 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... Bug introduced 2018-08-06 05:18 UTC by Report Bug Copy Issue Report The call to `ArgumentInvocation::__construct()` misses a required argument `$value`. This check looks for function calls that miss required arguments. Loading history... Compatibility introduced 2018-08-06 05:18 UTC by Report Bug Copy Issue Report `$parent` of type `object<Railt\Reflection\Contracts\Definition>` is not a sub-type of `object<Railt\Reflection\...ocation\TypeInvocation>`. It seems like you assume a child interface of the interface `Railt\Reflection\Contracts\Definition` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
34			$argument->withOffset($rule->getOffset());
35
36			return $argument;
37			}
38			}
39

railt / sdl

Push — master ( 22fff6...9c0de7 )

DirectiveArgumentBuilder::build() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like