EnumBuilder::loadEnumValues() - 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

EnumBuilder::loadEnumValues() A

↳ Parent: EnumBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	8
Ratio	100 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	2
dl	8
loc	8
rs	10
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\EnumDefinitionNode;
use Railt\SDL\Frontend\Builder\DefinitionBuilder;
use Railt\SDL\IR\Type;
use Railt\SDL\IR\TypeDefinition;

/**
 * Class EnumBuilder
 */
class EnumBuilder extends DefinitionBuilder

{
    /**
     * @param Readable $file
     * @param RuleInterface|EnumDefinitionNode $ast
     * @return \Generator|mixed
     */
    public function build(Readable $file, RuleInterface $ast)
    {
        $enum = 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.
    }
}
        $enum->in($file, $ast->getOffset());

        $enum->type = Type::ENUM;
        $enum->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.
    }
}

        yield from $this->loadEnumValues($ast, $enum);


        return $enum;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @param EnumDefinitionNode $ast
     * @param TypeDefinition $enum
     * @return \Generator
     */
    protected function loadEnumValues(EnumDefinitionNode $ast, TypeDefinition $enum): \Generator
    {
        $enum->values = [];

        foreach ($ast->getEnumValueNodes() as $values) {
            $enum->values[] = yield $values;
        }
    }
}


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\EnumDefinitionNode;
15		use Railt\SDL\Frontend\Builder\DefinitionBuilder;
16		use Railt\SDL\IR\Type;
17		use Railt\SDL\IR\TypeDefinition;
18
19		/**
20		* Class EnumBuilder
21		*/
22	View Code Duplication	class EnumBuilder extends DefinitionBuilder
		0 ignored issues – show Duplication introduced 2018-09-10 22:47 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
23		{
24		/**
25		* @param Readable $file
26		* @param RuleInterface\|EnumDefinitionNode $ast
27		* @return \Generator\|mixed
28		*/
29		public function build(Readable $file, RuleInterface $ast)
30		{
31		$enum = 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...
32		$enum->in($file, $ast->getOffset());
33
34		$enum->type = Type::ENUM;
35		$enum->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...
36
37		yield from $this->loadEnumValues($ast, $enum);
		0 ignored issues – show Compatibility introduced 2018-09-10 22:47 UTC by Report Bug Copy Issue Report `$ast` of type `object<Railt\Parser\Ast\RuleInterface>` is not a sub-type of `object<Railt\SDL\Fronten...ion\EnumDefinitionNode>`. It seems like you assume a concrete implementation of the interface `Railt\Parser\Ast\RuleInterface` 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...
38
39		return $enum;
		0 ignored issues – show Bug Best Practice introduced 2018-09-10 22:47 UTC by Report Bug Copy Issue Report The return type of `return $enum;` (`Railt\SDL\IR\TypeDefinition`) is incompatible with the return type documented by `Railt\SDL\Frontend\Build...tion\EnumBuilder::build` of type `Generator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
40		}
41
42		/**
43		* @param EnumDefinitionNode $ast
44		* @param TypeDefinition $enum
45		* @return \Generator
46		*/
47		protected function loadEnumValues(EnumDefinitionNode $ast, TypeDefinition $enum): \Generator
48		{
49		$enum->values = [];
50
51		foreach ($ast->getEnumValueNodes() as $values) {
52		$enum->values[] = yield $values;
53		}
54		}
55		}
56

railt / sdl

Push — master ( 690100...f55788 )

EnumBuilder::loadEnumValues() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like