DirectiveBuilder::build() - Code Metrics - Inspection of "Implement definitions data transfer objects" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 690100...f55788 )

by Kirill

created 2018-09-10 22:38 UTC

DirectiveBuilder::build() A

↳ Parent: DirectiveBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
dl	0
loc	10
rs	9.9332
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\Frontend\Builder\Definition;

use Railt\Io\Readable;
use Railt\Parser\Ast\RuleInterface;
use Railt\SDL\Frontend\Ast\Definition\DirectiveDefinitionNode;
use Railt\SDL\Frontend\Ast\Definition\ObjectDefinitionNode;
use Railt\SDL\Frontend\Builder\DefinitionBuilder;
use Railt\SDL\IR\Type;
use Railt\SDL\IR\TypeDefinition;

/**
 * Class DirectiveBuilder
 */
class DirectiveBuilder extends DefinitionBuilder
{
    /**
     * @param Readable $file
     * @param RuleInterface|DirectiveDefinitionNode $ast
     * @return \Generator|mixed
     */
    public function build(Readable $file, RuleInterface $ast)
    {
        $directive = new TypeDefinition($ast->getFullName());
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->in($file, $ast->getOffset());

        $directive->type = Type::DIRECTIVE;
        $directive->description = $ast->getDescription();
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 $directive;
    }
}


Push — master ( 690100...f55788 )

DirectiveBuilder::build() A

Complexity

Size

Duplication

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\Frontend\Builder\Definition;
11
12			use Railt\Io\Readable;
13			use Railt\Parser\Ast\RuleInterface;
14			use Railt\SDL\Frontend\Ast\Definition\DirectiveDefinitionNode;
15			use Railt\SDL\Frontend\Ast\Definition\ObjectDefinitionNode;
16			use Railt\SDL\Frontend\Builder\DefinitionBuilder;
17			use Railt\SDL\IR\Type;
18			use Railt\SDL\IR\TypeDefinition;
19
20			/**
21			* Class DirectiveBuilder
22			*/
23			class DirectiveBuilder extends DefinitionBuilder
24			{
25			/**
26			* @param Readable $file
27			* @param RuleInterface\|DirectiveDefinitionNode $ast
28			* @return \Generator\|mixed
29			*/
30			public function build(Readable $file, RuleInterface $ast)
31			{
32			$directive = new TypeDefinition($ast->getFullName());
			0 ignored issues – show Bug introduced 2018-09-10 22:47 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 `getFullName()` does only exist in the following implementations of said interface: `Railt\SDL\Frontend\Ast\D...\ArgumentDefinitionNode`, `Railt\SDL\Frontend\Ast\D...DirectiveDefinitionNode`, `Railt\SDL\Frontend\Ast\D...tion\EnumDefinitionNode`, `Railt\SDL\Frontend\Ast\D...EnumValueDefinitionNode`, `Railt\SDL\Frontend\Ast\D...ion\FieldDefinitionNode`, `Railt\SDL\Frontend\Ast\D...ion\InputDefinitionNode`, `Railt\SDL\Frontend\Ast\D...nputFieldDefinitionNode`, `Railt\SDL\Frontend\Ast\D...InterfaceDefinitionNode`, `Railt\SDL\Frontend\Ast\D...on\ObjectDefinitionNode`, `Railt\SDL\Frontend\Ast\D...on\ScalarDefinitionNode`, `Railt\SDL\Frontend\Ast\D...on\SchemaDefinitionNode`, `Railt\SDL\Frontend\Ast\D...hemaFieldDefinitionNode`, `Railt\SDL\Frontend\Ast\D...tion\TypeDefinitionNode`, `Railt\SDL\Frontend\Ast\D...ion\UnionDefinitionNode`. 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...
33			$directive->in($file, $ast->getOffset());
34
35			$directive->type = Type::DIRECTIVE;
36			$directive->description = $ast->getDescription();
			0 ignored issues – show Bug introduced 2018-09-10 22:47 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 `getDescription()` does only exist in the following implementations of said interface: `Railt\SDL\Frontend\Ast\D...\ArgumentDefinitionNode`, `Railt\SDL\Frontend\Ast\D...DirectiveDefinitionNode`, `Railt\SDL\Frontend\Ast\D...tion\EnumDefinitionNode`, `Railt\SDL\Frontend\Ast\D...EnumValueDefinitionNode`, `Railt\SDL\Frontend\Ast\D...ion\FieldDefinitionNode`, `Railt\SDL\Frontend\Ast\D...ion\InputDefinitionNode`, `Railt\SDL\Frontend\Ast\D...nputFieldDefinitionNode`, `Railt\SDL\Frontend\Ast\D...InterfaceDefinitionNode`, `Railt\SDL\Frontend\Ast\D...on\ObjectDefinitionNode`, `Railt\SDL\Frontend\Ast\D...on\ScalarDefinitionNode`, `Railt\SDL\Frontend\Ast\D...on\SchemaDefinitionNode`, `Railt\SDL\Frontend\Ast\D...hemaFieldDefinitionNode`, `Railt\SDL\Frontend\Ast\D...tion\TypeDefinitionNode`, `Railt\SDL\Frontend\Ast\D...ion\UnionDefinitionNode`. 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...
37
38			return $directive;
39			}
40			}
41

railt / sdl

Push — master ( 690100...f55788 )

DirectiveBuilder::build() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like