EnumProcessor::process() - Code Metrics - Inspection of "Rewrite building pipeline" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 332a4c...198c54 )

by Kirill

created 2018-08-03 00:24 UTC

EnumProcessor::process() A

↳ Parent: EnumProcessor

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	12
rs	9.8666
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\Processor\Definition;

use Railt\Parser\Ast\RuleInterface;
use Railt\Reflection\Contracts\Definition\TypeDefinition;
use Railt\Reflection\Definition\EnumDefinition;
use Railt\SDL\Compiler\Ast\Definition\EnumDefinitionNode;
use Railt\SDL\Compiler\Processor\BaseProcessor;

/**
 * Class EnumProcessor
 */
class EnumProcessor extends BaseProcessor
{
    /**
     * @param RuleInterface|EnumDefinitionNode $ast
     * @return null|TypeDefinition
     */
    public function process(RuleInterface $ast): ?TypeDefinition
    {
        /** @var EnumDefinition $enum */
        $enum = $ast->getTypeDefinition();
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.
    }
}

        $this->immediately(function () use ($ast, $enum) {
            $enum->withOffset($ast->getOffset());
            $enum->withDescription($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 $enum;
    }
}


Push — master ( 332a4c...198c54 )

EnumProcessor::process() 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\Compiler\Processor\Definition;
11
12			use Railt\Parser\Ast\RuleInterface;
13			use Railt\Reflection\Contracts\Definition\TypeDefinition;
14			use Railt\Reflection\Definition\EnumDefinition;
15			use Railt\SDL\Compiler\Ast\Definition\EnumDefinitionNode;
16			use Railt\SDL\Compiler\Processor\BaseProcessor;
17
18			/**
19			* Class EnumProcessor
20			*/
21			class EnumProcessor extends BaseProcessor
22			{
23			/**
24			* @param RuleInterface\|EnumDefinitionNode $ast
25			* @return null\|TypeDefinition
26			*/
27			public function process(RuleInterface $ast): ?TypeDefinition
28			{
29			/** @var EnumDefinition $enum */
30			$enum = $ast->getTypeDefinition();
			0 ignored issues – show Bug introduced 2018-08-03 00:26 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 `getTypeDefinition()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\D...DirectiveDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\EnumDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ion\InputDefinitionNode`, `Railt\SDL\Compiler\Ast\D...nputUnionDefinitionNode`, `Railt\SDL\Compiler\Ast\D...InterfaceDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ObjectDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ScalarDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\SchemaDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\TypeDefinitionNode`, `Railt\SDL\Compiler\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...
31
32			$this->immediately(function () use ($ast, $enum) {
33			$enum->withOffset($ast->getOffset());
34			$enum->withDescription($ast->getDescription());
			0 ignored issues – show Bug introduced 2018-08-03 00:26 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\Compiler\Ast\D...DirectiveDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\EnumDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ion\InputDefinitionNode`, `Railt\SDL\Compiler\Ast\D...nputUnionDefinitionNode`, `Railt\SDL\Compiler\Ast\D...InterfaceDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ObjectDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ScalarDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\SchemaDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\TypeDefinitionNode`, `Railt\SDL\Compiler\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...
35			});
36
37			return $enum;
38			}
39			}
40

railt / sdl

Push — master ( 332a4c...198c54 )

EnumProcessor::process() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like