DirectiveBuilder::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

DirectiveBuilder::build() A

↳ Parent: DirectiveBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
nc	2
nop	2
dl	0
loc	11
ccs	0
cts	9
cp	0
crap	6
rs	9.9
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\DirectiveInvocation;
use Railt\SDL\Compiler\Ast\Invocation\DirectiveNode;
use Railt\SDL\Compiler\Builder\Builder;

/**
 * Class DirectiveInvocationBuilder
 */
class DirectiveBuilder extends Builder
{
    /**
     * @param RuleInterface|DirectiveNode $rule
     * @param Definition $parent
     * @return Definition
     * @throws \Railt\Io\Exception\ExternalFileException
     */
    public function build(RuleInterface $rule, Definition $parent): Definition
    {
        $directive = new DirectiveInvocation($parent->getDocument(), $rule->getDirectiveName());
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.
    }
}
        $directive->withOffset($rule->getOffset());

        foreach ($rule->getDirectiveArguments() as $ast) {
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.
    }
}
            $directive->withArgument($this->dependent($ast, $directive));
        }

        return $directive;
    }
}


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

DirectiveBuilder::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\DirectiveInvocation;
15			use Railt\SDL\Compiler\Ast\Invocation\DirectiveNode;
16			use Railt\SDL\Compiler\Builder\Builder;
17
18			/**
19			* Class DirectiveInvocationBuilder
20			*/
21			class DirectiveBuilder extends Builder
22			{
23			/**
24			* @param RuleInterface\|DirectiveNode $rule
25			* @param Definition $parent
26			* @return Definition
27			* @throws \Railt\Io\Exception\ExternalFileException
28			*/
29			public function build(RuleInterface $rule, Definition $parent): Definition
30			{
31			$directive = new DirectiveInvocation($parent->getDocument(), $rule->getDirectiveName());
			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 `getDirectiveName()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\Invocation\DirectiveNode`. 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... Compatibility introduced 2018-08-06 05:18 UTC by Report Bug Copy Issue Report `$parent->getDocument()` of type `object<Railt\Reflection\Contracts\Document>` is not a sub-type of `object<Railt\Reflection\Document>`. It seems like you assume a concrete implementation of the interface `Railt\Reflection\Contracts\Document` 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...
32			$directive->withOffset($rule->getOffset());
33
34			foreach ($rule->getDirectiveArguments() as $ast) {
			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 `getDirectiveArguments()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\Invocation\DirectiveNode`. 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			$directive->withArgument($this->dependent($ast, $directive));
36			}
37
38			return $directive;
39			}
40			}
41

railt / sdl

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

DirectiveBuilder::build() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like