DeprecatedDirective::isBuiltin() - Code Metrics - Inspection of "Add isBuiltin method for type definitions" - railt/reflection - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( d820d2...d59132 )

by Kirill

created 2018-08-18 14:04 UTC

DeprecatedDirective::isBuiltin() A

↳ Parent: DeprecatedDirective

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	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\Reflection\Stdlib\Directive;

use Railt\Reflection\Definition\Dependent\ArgumentDefinition;
use Railt\Reflection\Definition\Dependent\DirectiveLocation;
use Railt\Reflection\Definition\DirectiveDefinition;
use Railt\Reflection\Document;

/**
 * Class DeprecatedDirective
 */
final class DeprecatedDirective extends DirectiveDefinition
{
    /**
     * @var string[]
     */
    private const LOCATIONS = [
        DirectiveLocation::OBJECT,
        DirectiveLocation::INTERFACE,
        DirectiveLocation::FIELD_DEFINITION,
        DirectiveLocation::SCALAR,
        DirectiveLocation::UNION,
        DirectiveLocation::ENUM,
        DirectiveLocation::ENUM_VALUE,
        DirectiveLocation::INPUT_OBJECT,
        DirectiveLocation::INPUT_UNION,
        DirectiveLocation::INPUT_FIELD_DEFINITION,
    ];

    /**
     * @var string
     */
    public const TYPE_NAME = 'deprecated';

    /**
     * @var string
     */
    public const TYPE_DESCRIPTION = <<<Description
The @deprecated directive is used within the type system definition language to
indicate deprecated portions of a GraphQL service’s schema, such as deprecated
fields on a type or deprecated enum values.
Description;

    /**
     * BooleanScalar constructor.
     * @param Document $document
     */
    public function __construct(Document $document)
    {
        parent::__construct($document, self::TYPE_NAME);

        $this->withDescription(self::TYPE_DESCRIPTION)
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.
    }
}
            ->withArgument((new ArgumentDefinition($this, 'reason', 'String'))
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.
    }
}
                ->withLine(39)
                ->withDefaultValue('No longer supported'))
            ->withLocation(...\array_map(function (string $location) use ($document): DirectiveLocation {
                return new DirectiveLocation($this, $location);
            }, self::LOCATIONS));
    }

    /**
     * @return int
     */
    public function getLine(): int
    {
        return 39;
    }

    /**
     * @return bool
     */
    public function isBuiltin(): bool
    {
        return true;
    }
}


Push — master ( d820d2...d59132 )

DeprecatedDirective::isBuiltin() 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\Reflection\Stdlib\Directive;
11
12			use Railt\Reflection\Definition\Dependent\ArgumentDefinition;
13			use Railt\Reflection\Definition\Dependent\DirectiveLocation;
14			use Railt\Reflection\Definition\DirectiveDefinition;
15			use Railt\Reflection\Document;
16
17			/**
18			* Class DeprecatedDirective
19			*/
20			final class DeprecatedDirective extends DirectiveDefinition
21			{
22			/**
23			* @var string[]
24			*/
25			private const LOCATIONS = [
26			DirectiveLocation::OBJECT,
27			DirectiveLocation::INTERFACE,
28			DirectiveLocation::FIELD_DEFINITION,
29			DirectiveLocation::SCALAR,
30			DirectiveLocation::UNION,
31			DirectiveLocation::ENUM,
32			DirectiveLocation::ENUM_VALUE,
33			DirectiveLocation::INPUT_OBJECT,
34			DirectiveLocation::INPUT_UNION,
35			DirectiveLocation::INPUT_FIELD_DEFINITION,
36			];
37
38			/**
39			* @var string
40			*/
41			public const TYPE_NAME = 'deprecated';
42
43			/**
44			* @var string
45			*/
46			public const TYPE_DESCRIPTION = <<<Description
47			The @deprecated directive is used within the type system definition language to
48			indicate deprecated portions of a GraphQL service’s schema, such as deprecated
49			fields on a type or deprecated enum values.
50			Description;
51
52			/**
53			* BooleanScalar constructor.
54			* @param Document $document
55			*/
56			public function __construct(Document $document)
57			{
58			parent::__construct($document, self::TYPE_NAME);
59
60			$this->withDescription(self::TYPE_DESCRIPTION)
			0 ignored issues – show Bug introduced 2018-07-20 01:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Reflection\Contrac...finition\TypeDefinition` as the method `withArgument()` does only exist in the following implementations of said interface: `Railt\Reflection\Definit...pendent\FieldDefinition`, `Railt\Reflection\Definition\DirectiveDefinition`, `Railt\Reflection\Stdlib\...ive\DeprecatedDirective`, `Railt\Reflection\Stdlib\Directive\IncludeDirective`, `Railt\Reflection\Stdlib\Directive\SkipDirective`. 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...
61			->withArgument((new ArgumentDefinition($this, 'reason', 'String'))
			0 ignored issues – show Bug introduced 2018-07-21 02:36 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Reflection\Contracts\Definition` as the method `withDefaultValue()` does only exist in the following implementations of said interface: `Railt\Reflection\Definit...dent\ArgumentDefinition`, `Railt\Reflection\Definit...nt\InputFieldDefinition`. 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...
62			->withLine(39)
63			->withDefaultValue('No longer supported'))
64			->withLocation(...\array_map(function (string $location) use ($document): DirectiveLocation {
65			return new DirectiveLocation($this, $location);
66			}, self::LOCATIONS));
67			}
68
69			/**
70			* @return int
71			*/
72			public function getLine(): int
73			{
74			return 39;
75			}
76
77			/**
78			* @return bool
79			*/
80			public function isBuiltin(): bool
81			{
82			return true;
83			}
84			}
85

railt / reflection

Push — master ( d820d2...d59132 )

DeprecatedDirective::isBuiltin() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like