ObjectProcessor - Code Metrics - Inspection of "Merge" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1e8320...6a42b9 )

by Kirill

created 2018-08-05 17:36 UTC

ObjectProcessor A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	18
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

80%

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	4
cts	5
cp	0.8
rs	10
c	0
b	0
f	0
wmc	2
lcom	1
cbo	2

1 Method

Rating	Name	Duplication	Size	Complexity
A	resolve()	0	10	2

<?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;
use Railt\Reflection\Definition\ObjectDefinition;
use Railt\SDL\Compiler\Ast\Definition\ObjectDefinitionNode;
use Railt\SDL\Compiler\Processor\DefinitionProcessor;

/**
 * Class ObjectProcessor
 */
class ObjectProcessor extends DefinitionProcessor
{
    /**
     * @param RuleInterface|ObjectDefinitionNode $rule
     * @return Definition
     * @throws \Railt\Io\Exception\ExternalFileException
     */
    public function resolve(RuleInterface $rule): Definition
    {
        $object = new ObjectDefinition($this->document, $rule->getTypeName());
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.
    }
}

        foreach ($rule->getFields() as $field) {
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.
    }
}
            $object->withField($this->build($field));
        }

        return $object;
    }
}


Push — master ( 1e8320...6a42b9 )

ObjectProcessor A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

1 Method

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;
14		use Railt\Reflection\Definition\ObjectDefinition;
15		use Railt\SDL\Compiler\Ast\Definition\ObjectDefinitionNode;
16		use Railt\SDL\Compiler\Processor\DefinitionProcessor;
17
18		/**
19		* Class ObjectProcessor
20		*/
21		class ObjectProcessor extends DefinitionProcessor
22		{
23		/**
24		* @param RuleInterface\|ObjectDefinitionNode $rule
25		* @return Definition
26		* @throws \Railt\Io\Exception\ExternalFileException
27		*/
28	1	public function resolve(RuleInterface $rule): Definition
29		{
30	1	$object = new ObjectDefinition($this->document, $rule->getTypeName());
		0 ignored issues – show Bug introduced 2018-08-05 17:39 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 `getTypeName()` 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`, `Railt\SDL\Compiler\Ast\TypeHintNode`, `Railt\SDL\Compiler\Ast\TypeNameNode`. 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-05 17:39 UTC by Report Bug Copy Issue Report It seems like `$this->document` can also be of type `object<Railt\Reflection\Contracts\Document>`; however, `Railt\Reflection\Abstrac...finition::__construct()` does only seem to accept `object<Railt\Reflection\Document>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /* * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
31
32	1	foreach ($rule->getFields() as $field) {
		0 ignored issues – show Bug introduced 2018-08-05 17:39 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 `getFields()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\D...InterfaceDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ObjectDefinitionNode`. 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		$object->withField($this->build($field));
34		}
35
36	1	return $object;
37		}
38		}
39

railt / sdl

Push — master ( 1e8320...6a42b9 )

ObjectProcessor A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

1 Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like