TypesConfiguration::getConfigTreeBuilder() - Code Metrics - Inspection of "Add support of inheritance for relay-mutation-inpu..." - overblog/GraphQLBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#423)

unknown

created 2018-11-23 10:17 UTC

TypesConfiguration::getConfigTreeBuilder() C

↳ Parent: TypesConfiguration

Complexity

Conditions	8
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	66
CRAP Score	8

Importance

Changes

Metric	Value
dl	0
loc	96
ccs	66
cts	66
cp	1
rs	6.8428
c	0
b	0
f	0
cc	8
nc	1
nop	0
crap	8

How to fix Long Method

<?php

namespace Overblog\GraphQLBundle\DependencyInjection;

use Overblog\GraphQLBundle\Config;
use Overblog\GraphQLBundle\Config\Processor\InheritanceProcessor;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class TypesConfiguration implements ConfigurationInterface
{
    private static $types = [
        'object',
        'enum',
        'interface',
        'union',
        'input-object',
        'custom-scalar',
    ];

    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('overblog_graphql_types');

        $configTypeKeys = \array_map(
            function ($type) {
                return $this->normalizedConfigTypeKey($type);
            },
            self::$types
        );

        $this->addBeforeNormalization($rootNode);

        $rootNode
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.
    }
}
            ->useAttributeAsKey('name')
            ->prototype('array')
                // config is the unique config entry allowed
                ->beforeNormalization()
                    ->ifTrue(function ($v) use ($configTypeKeys) {
                        if (!empty($v) && \is_array($v)) {
                            $keys = \array_keys($v);
                            foreach ($configTypeKeys as $configTypeKey) {
                                if (\in_array($configTypeKey, $keys)) {
                                    return true;
                                }
                            }
                        }

                        return  false;
                    })
                        ->thenInvalid(
                            \sprintf(
                                'Don\'t use internal config keys %s, replace it by "config" instead.',
                                \implode(', ', $configTypeKeys)
                            )
                        )
                ->end()
                // config is renamed _{TYPE}_config
                ->beforeNormalization()
                    ->ifTrue(function ($v) {
                        return isset($v['type']) && \is_string($v['type']);
                    })
                    ->then(function ($v) {
                        $key = $this->normalizedConfigTypeKey($v['type']);

                        if (empty($v[$key])) {
                            $v[$key] = isset($v['config']) ? $v['config'] : [];
                        }
                        unset($v['config']);

                        return $v;
                    })
                ->end()
                ->cannotBeOverwritten()
                ->children()
                    ->scalarNode('class_name')
                        ->isRequired()
                        ->validate()
                            ->ifTrue(function ($name) {
                                return !\preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $name);
                            })
                            ->thenInvalid('A valid class name starts with a letter or underscore, followed by any number of letters, numbers, or underscores.')
                        ->end()
                    ->end()
                    ->enumNode('type')->values(self::$types)->isRequired()->end()
                    ->arrayNode(InheritanceProcessor::INHERITS_KEY)
                        ->prototype('scalar')->info('Types to inherit of.')->end()
                    ->end()
                    ->booleanNode('decorator')->info('Decorator will not be generated.')->defaultFalse()->end()
                    ->append(Config\ObjectTypeDefinition::create()->getDefinition())
                    ->append(Config\EnumTypeDefinition::create()->getDefinition())
                    ->append(Config\InterfaceTypeDefinition::create()->getDefinition())
                    ->append(Config\UnionTypeDefinition::create()->getDefinition())
                    ->append(Config\InputObjectTypeDefinition::create()->getDefinition())
                    ->append(Config\CustomScalarTypeDefinition::create()->getDefinition())
                    ->variableNode('config')->end()
                ->end()
                // _{TYPE}_config is renamed config
                ->validate()
                    ->ifTrue(function ($v) {
                        return isset($v[$this->normalizedConfigTypeKey($v['type'])]);
                    })
                    ->then(function ($v) {
                        $key = $this->normalizedConfigTypeKey($v['type']);
                        $v['config'] = $v[$key];
                        unset($v[$key]);

                        return $v;
                    })
                ->end()

            ->end();

        return $treeBuilder;
    }

    private function addBeforeNormalization(ArrayNodeDefinition $node)
    {
        $node
            // process beforeNormalization (should be execute after relay normalization)
            ->beforeNormalization()
                ->ifTrue(function ($types) {
                    return \is_array($types);
                })
                ->then(function ($types) {
                    return Config\Processor::process($types, Config\Processor::BEFORE_NORMALIZATION);
                })
            ->end()
            ;
    }

    private function normalizedConfigTypeKey($type)
    {
        return '_'.\str_replace('-', '_', $type).'_config';
    }
}


1		<?php
2
3		namespace Overblog\GraphQLBundle\DependencyInjection;
4
5		use Overblog\GraphQLBundle\Config;
6		use Overblog\GraphQLBundle\Config\Processor\InheritanceProcessor;
7		use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
8		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
9		use Symfony\Component\Config\Definition\ConfigurationInterface;
10
11		class TypesConfiguration implements ConfigurationInterface
12		{
13		private static $types = [
14		'object',
15		'enum',
16		'interface',
17		'union',
18		'input-object',
19		'custom-scalar',
20		];
21
22		public function getConfigTreeBuilder()
23		{
24	37	$treeBuilder = new TreeBuilder();
25		$rootNode = $treeBuilder->root('overblog_graphql_types');
26	37
27	37	$configTypeKeys = \array_map(
28		function ($type) {
29	37	return $this->normalizedConfigTypeKey($type);
30		},
31	37	self::$types
32	37	);
33	37
34		$this->addBeforeNormalization($rootNode);
35
36	37	$rootNode
		0 ignored issues – show Bug introduced 2016-03-07 13:30 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...
37		->useAttributeAsKey('name')
38		->prototype('array')
39	37	// config is the unique config entry allowed
40	37	->beforeNormalization()
41		->ifTrue(function ($v) use ($configTypeKeys) {
42	37	if (!empty($v) && \is_array($v)) {
43		$keys = \array_keys($v);
44	37	foreach ($configTypeKeys as $configTypeKey) {
45	37	if (\in_array($configTypeKey, $keys)) {
46	37	return true;
47	37	}
48	37	}
49		}
50
51		return false;
52		})
53	32	->thenInvalid(
54	37	\sprintf(
55	37	'Don\'t use internal config keys %s, replace it by "config" instead.',
56	37	\implode(', ', $configTypeKeys)
57	37	)
58	37	)
59		->end()
60		// config is renamed _{TYPE}_config
61	37	->beforeNormalization()
62		->ifTrue(function ($v) {
63	37	return isset($v['type']) && \is_string($v['type']);
64		})
65	32	->then(function ($v) {
66	37	$key = $this->normalizedConfigTypeKey($v['type']);
67
68	32	if (empty($v[$key])) {
69		$v[$key] = isset($v['config']) ? $v['config'] : [];
70	32	}
71	32	unset($v['config']);
72
73	32	return $v;
74		})
75	32	->end()
76	37	->cannotBeOverwritten()
77	37	->children()
78	37	->scalarNode('class_name')
79	37	->isRequired()
80	37	->validate()
81	37	->ifTrue(function ($name) {
82	37	return !\preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $name);
83		})
84	32	->thenInvalid('A valid class name starts with a letter or underscore, followed by any number of letters, numbers, or underscores.')
85	37	->end()
86	37	->end()
87	37	->enumNode('type')->values(self::$types)->isRequired()->end()
88	37	->arrayNode(InheritanceProcessor::INHERITS_KEY)
89	37	->prototype('scalar')->info('Types to inherit of.')->end()
90	37	->end()
91	37	->booleanNode('decorator')->info('Decorator will not be generated.')->defaultFalse()->end()
92	37	->append(Config\ObjectTypeDefinition::create()->getDefinition())
93	37	->append(Config\EnumTypeDefinition::create()->getDefinition())
94	37	->append(Config\InterfaceTypeDefinition::create()->getDefinition())
95	37	->append(Config\UnionTypeDefinition::create()->getDefinition())
96	37	->append(Config\InputObjectTypeDefinition::create()->getDefinition())
97	37	->append(Config\CustomScalarTypeDefinition::create()->getDefinition())
98	37	->variableNode('config')->end()
99	37	->end()
100	37	// _{TYPE}_config is renamed config
101	37	->validate()
102		->ifTrue(function ($v) {
103	37	return isset($v[$this->normalizedConfigTypeKey($v['type'])]);
104		})
105	32	->then(function ($v) {
106	37	$key = $this->normalizedConfigTypeKey($v['type']);
107		$v['config'] = $v[$key];
108	32	unset($v[$key]);
109	32
110	32	return $v;
111		})
112	32	->end()
113	37
114	37	->end();
115
116	37	return $treeBuilder;
117		}
118	37
119		private function addBeforeNormalization(ArrayNodeDefinition $node)
120		{
121	37	$node
122		// process beforeNormalization (should be execute after relay normalization)
123		->beforeNormalization()
124		->ifTrue(function ($types) {
125	37	return \is_array($types);
126		})
127	37	->then(function ($types) {
128	37	return Config\Processor::process($types, Config\Processor::BEFORE_NORMALIZATION);
129		})
130	37	->end()
131	37	;
132	37	}
133
134	37	private function normalizedConfigTypeKey($type)
135		{
136	37	return '_'.\str_replace('-', '_', $type).'_config';
137		}
138		}
139

overblog / GraphQLBundle

Scrutinizer GitHub App not installed

Pull Request — master (#423)

TypesConfiguration::getConfigTreeBuilder() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like