Completed
Push — master ( 7510c8...82c7bd )
by Kirill
08:19
created

InputFieldBuilder   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 28
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 3

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
dl 0
loc 28
ccs 0
cts 14
cp 0
rs 10
c 0
b 0
f 0
wmc 3
lcom 0
cbo 3

1 Method

Rating   Name   Duplication   Size   Complexity  
A build() 0 19 3
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\Builder\Dependent;
11
12
use Railt\Parser\Ast\RuleInterface;
13
use Railt\Reflection\Contracts\Definition;
14
use Railt\Reflection\Definition\Dependent\InputFieldDefinition;
15
use Railt\SDL\Compiler\Ast\Dependent\InputFieldDefinitionNode;
16
use Railt\SDL\Compiler\Builder\Builder;
17
18
/**
19
 * Class InputFieldBuilder
20
 */
21
class InputFieldBuilder extends Builder
22
{
23
    /**
24
     * @param RuleInterface|InputFieldDefinitionNode $rule
25
     * @param Definition $parent
26
     * @return Definition
27
     * @throws \Railt\Io\Exception\ExternalFileException
28
     */
29
    public function build(RuleInterface $rule, Definition $parent): Definition
30
    {
31
        $hint = $rule->getTypeHint();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Railt\Parser\Ast\RuleInterface as the method getTypeHint() does only exist in the following implementations of said interface: Railt\SDL\Compiler\Ast\D...\ArgumentDefinitionNode, Railt\SDL\Compiler\Ast\D...EnumValueDefinitionNode, Railt\SDL\Compiler\Ast\D...ent\FieldDefinitionNode, Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode, Railt\SDL\Compiler\Ast\D...hemaFieldDefinitionNode.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
32
33
        $field = new InputFieldDefinition($parent, $rule->getFieldName(), $hint->getTypeName());
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Railt\Parser\Ast\RuleInterface as the method getFieldName() does only exist in the following implementations of said interface: Railt\SDL\Compiler\Ast\D...ent\FieldDefinitionNode, Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode, Railt\SDL\Compiler\Ast\D...hemaFieldDefinitionNode.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
Compatibility introduced by
$parent of type object<Railt\Reflection\Contracts\Definition> is not a sub-type of object<Railt\Reflection\...inition\TypeDefinition>. It seems like you assume a child interface of the interface Railt\Reflection\Contracts\Definition 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...
34
        $field->withOffset($rule->getOffset());
35
        $field->withDescription($rule->getDescription());
0 ignored issues
show
Bug introduced by
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, Railt\SDL\Compiler\Ast\D...\ArgumentDefinitionNode, Railt\SDL\Compiler\Ast\D...EnumValueDefinitionNode, Railt\SDL\Compiler\Ast\D...ent\FieldDefinitionNode, Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
36
        $field->withModifiers($hint->getModifiers());
37
38
        if ($default = $rule->getDefaultValue()) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Railt\Parser\Ast\RuleInterface as the method getDefaultValue() does only exist in the following implementations of said interface: Railt\SDL\Compiler\Ast\D...\ArgumentDefinitionNode, Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
Unused Code introduced by
$default is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
Unused Code introduced by
This if statement is empty and can be removed.

This check looks for the bodies of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These if bodies can be removed. If you have an empty if but statements in the else branch, consider inverting the condition.

if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

could be turned into

if (rand(1, 6) <= 3) {
    print "Check succeeded";
}

This is much more concise to read.

Loading history...
39
            // TODO Default value
40
        }
41
42
        foreach ($rule->getDirectives() as $ast) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Railt\Parser\Ast\RuleInterface as the method getDirectives() 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\D...\ArgumentDefinitionNode, Railt\SDL\Compiler\Ast\D...EnumValueDefinitionNode, Railt\SDL\Compiler\Ast\D...ent\FieldDefinitionNode, Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
43
            $field->withDirective($this->dependent($ast, $field));
44
        }
45
46
        return $field;
47
    }
48
}
49