EnumTypeDefinition::getDefinition() - Code Metrics - Inspection of "Optimized types mapping configuration" - overblog/GraphQLBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#40)

by Jérémiah

created 2016-05-16 09:43 UTC

EnumTypeDefinition::getDefinition() B

↳ Parent: EnumTypeDefinition

Complexity

Conditions	2
Paths	1

Size

Total Lines	30
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	23
CRAP Score	2

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	30
ccs	23
cts	23
cp	1
rs	8.8571
cc	2
eloc	26
nc	1
nop	0
crap	2

<?php

/*
 * This file is part of the OverblogGraphQLBundle package.
 *
 * (c) Overblog <http://github.com/overblog/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Overblog\GraphQLBundle\Config;

use Symfony\Component\Config\Definition\Builder\TreeBuilder;

class EnumTypeDefinition extends TypeDefinition
{
    public function getDefinition()
    {
        $builder = new TreeBuilder();
        $node = $builder->root('_enum_config');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            ->children()
                ->append($this->nameSection())
                ->arrayNode('values')
                    ->useAttributeAsKey('name')
                    ->prototype('array')
                        ->beforeNormalization()
                            ->ifTrue(function ($v) { return !is_null($v) && !is_array($v); })
                            ->then(function ($v) { return ['value' => $v]; })
                        ->end()
                        ->isRequired()
                        ->children()
                            ->scalarNode('value')->end()
                            ->append($this->descriptionSection())
                            ->append($this->deprecationReasonSelection())
                        ->end()
                    ->end()
                    ->isRequired()
                    ->requiresAtLeastOneElement()
                ->end()
                ->append($this->descriptionSection())
            ->end();

        return $node;
    }
}


1		<?php
2
3		/*
4		* This file is part of the OverblogGraphQLBundle package.
5		*
6		* (c) Overblog <http://github.com/overblog/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Overblog\GraphQLBundle\Config;
13
14		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
15
16		class EnumTypeDefinition extends TypeDefinition
17		{
18	15	public function getDefinition()
19		{
20	15	$builder = new TreeBuilder();
21	15	$node = $builder->root('_enum_config');
22
23		$node
		0 ignored issues – show Bug introduced 2016-05-16 09:56 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Config...\Builder\NodeDefinition` as the method `children()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\ArrayNodeDefinition`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
24	15	->children()
25	15	->append($this->nameSection())
26	15	->arrayNode('values')
27	15	->useAttributeAsKey('name')
28	15	->prototype('array')
29	15	->beforeNormalization()
30		->ifTrue(function ($v) { return !is_null($v) && !is_array($v); })
31		->then(function ($v) { return ['value' => $v]; })
32	15	->end()
33	15	->isRequired()
34	15	->children()
35	15	->scalarNode('value')->end()
36	15	->append($this->descriptionSection())
37	15	->append($this->deprecationReasonSelection())
38	15	->end()
39	15	->end()
40	15	->isRequired()
41	15	->requiresAtLeastOneElement()
42	15	->end()
43	15	->append($this->descriptionSection())
44	15	->end();
45
46	15	return $node;
47		}
48		}
49

overblog / GraphQLBundle

Scrutinizer GitHub App not installed

Pull Request — master (#40)

EnumTypeDefinition::getDefinition() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like