Configuration - Code Metrics - Inspection of "Support php definition" - overblog/GraphQLBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#137)

by Jérémiah

created 2017-05-02 13:54 UTC

Configuration A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	215
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

98.85%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	12
lcom	1
cbo	7
dl	0
loc	215
ccs	172
cts	174
cp	0.9885
rs	10
c	1
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
B	getConfigTreeBuilder()	140	6
B	addBuilderSection()	32	4
B	addSecurityQuerySection()	26	1

<?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\DependencyInjection;

use GraphQL\Validator\Rules\QueryComplexity;
use GraphQL\Validator\Rules\QueryDepth;
use Overblog\GraphQLBundle\Error\ErrorHandler;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * @todo fix xml
 */
class Configuration implements ConfigurationInterface
{
    private $debug;

    /**
     * Constructor.
     *
     * @param bool $debug Whether to use the debug mode
     */
    public function __construct($debug)
    {
        $this->debug = (bool) $debug;
    }

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

        $rootNode
            ->children()
                ->arrayNode('definitions')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('internal_error_message')->defaultNull()->end()
                        ->booleanNode('show_debug_info')->defaultValue(false)->end()
                        ->booleanNode('config_validation')->defaultValue($this->debug)->end()
                        ->arrayNode('schema')
                            ->beforeNormalization()
                                ->ifTrue(function ($v) {
                                    $needNormalization = isset($v['query']) && is_string($v['query']) ||
                                        isset($v['mutation']) && is_string($v['mutation']) ||
                                        isset($v['subscription']) && is_string($v['subscription']);

                                    return $needNormalization;
                                })
                                ->then(function ($v) {
                                    return ['default' => $v];
                                })
                            ->end()
                            ->useAttributeAsKey('name')
                            ->prototype('array')
                                ->addDefaultsIfNotSet()
                                ->children()
                                    ->scalarNode('query')->defaultNull()->end()
                                    ->scalarNode('mutation')->defaultNull()->end()
                                    ->scalarNode('subscription')->defaultNull()->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('auto_mapping')
                            ->treatFalseLike(['enabled' => false])
                            ->treatTrueLike(['enabled' => true])
                            ->treatNullLike(['enabled' => true])
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->booleanNode('enabled')->defaultValue(true)->end()
                                ->arrayNode('directories')
                                    ->info('List of directories containing GraphQL classes.')
                                    ->prototype('scalar')->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('mappings')
                            ->children()
                                ->arrayNode('types')
                                    ->prototype('array')
                                        ->addDefaultsIfNotSet()
                                        ->children()
                                            ->enumNode('type')->isRequired()->values(['yml', 'xml'])->end()
                                            ->scalarNode('dir')->defaultNull()->end()
                                        ->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('exceptions')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('warnings')
                                    ->treatNullLike([])
                                    ->prototype('scalar')->end()
                                ->end()
                                ->arrayNode('errors')
                                    ->treatNullLike([])
                                    ->prototype('scalar')->end()
                                ->end()
                                ->arrayNode('types')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('warnings')
                                            ->defaultValue(ErrorHandler::DEFAULT_USER_WARNING_CLASS)
                                        ->end()
                                        ->scalarNode('errors')
                                            ->defaultValue(ErrorHandler::DEFAULT_USER_ERROR_CLASS)
                                        ->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()

                        ->arrayNode('builders')
                            ->children()
                                ->append($this->addBuilderSection('field'))
                                ->append($this->addBuilderSection('args'))
                            ->end()
                        ->end()

                    ->end()
                ->end()
                ->arrayNode('templates')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('graphiql')
                            ->defaultValue('OverblogGraphQLBundle:GraphiQL:index.html.twig')
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('services')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('executor')
                            ->defaultValue('overblog_graphql.executor.default')
                        ->end()
                        ->scalarNode('promise_adapter')
                            ->defaultValue('overblog_graphql.promise_adapter.default')
                        ->end()
                        ->scalarNode('expression_language')
                            ->defaultValue('overblog_graphql.expression_language.default')
                        ->end()
                        ->scalarNode('cache_expression_language_parser')
                            ->defaultValue('overblog_graphql.cache_expression_language_parser.default')
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('security')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->append($this->addSecurityQuerySection('query_max_depth', QueryDepth::DISABLED))
                        ->append($this->addSecurityQuerySection('query_max_complexity', QueryComplexity::DISABLED))
                    ->end()
                ->end()
                ->arrayNode('versions')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('graphiql')->defaultValue('0.9')->end()
                        ->scalarNode('react')->defaultValue('15.4')->end()
                        ->scalarNode('fetch')->defaultValue('2.0')->end()
                    ->end()
                ->end()
            ->end();

        return $treeBuilder;
    }

    private function addBuilderSection($name)
    {
        $builder = new TreeBuilder();
        $node = $builder->root($name);
        $node->beforeNormalization()
            ->ifTrue(function ($v) {
                return is_array($v) && !empty($v);
            })
            ->then(function ($v) {
                foreach ($v as $key => &$config) {
                    if (is_string($config)) {
                        $config = [
                            'alias' => $key,
                            'class' => $config,
                        ];
                    }
                }

                return $v;
            })
        ->end();

        $node->prototype('array')
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()
                ->scalarNode('alias')->isRequired()->end()
                ->scalarNode('class')->isRequired()->end()
            ->end()
        ->end()
        ;

        return $node;
    }

    private function addSecurityQuerySection($name, $disabledValue)
    {
        $builder = new TreeBuilder();
        $node = $builder->root($name, 'integer');

        $node
            ->info('Disabled if equal to false.')
            ->beforeNormalization()
                ->ifTrue(function ($v) {
                    return false === $v;
                })
                ->then(function () use ($disabledValue) {
                    return $disabledValue;
                })
            ->end()
            ->defaultFalse()
            ->validate()
                ->ifTrue(function ($v) {
                    return $v < 0;
                })
                ->thenInvalid('"overblog_graphql.security.'.$name.'" must be greater or equal to 0.')
            ->end()
        ;

        return $node;
    }
}


Scrutinizer GitHub App not installed

Pull Request — master (#137)

Configuration A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Available Fixes

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\DependencyInjection;
13
14		use GraphQL\Validator\Rules\QueryComplexity;
15		use GraphQL\Validator\Rules\QueryDepth;
16		use Overblog\GraphQLBundle\Error\ErrorHandler;
17		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
18		use Symfony\Component\Config\Definition\ConfigurationInterface;
19
20		/**
21		* @todo fix xml
22		*/
23		class Configuration implements ConfigurationInterface
24		{
25		private $debug;
26
27		/**
28		* Constructor.
29		*
30		* @param bool $debug Whether to use the debug mode
31		*/
32	73	public function __construct($debug)
33		{
34	73	$this->debug = (bool) $debug;
35	73	}
36
37	73	public function getConfigTreeBuilder()
38		{
39	73	$treeBuilder = new TreeBuilder();
40	73	$rootNode = $treeBuilder->root('overblog_graphql');
41
42		$rootNode
43	73	->children()
44	73	->arrayNode('definitions')
45	73	->addDefaultsIfNotSet()
46	73	->children()
47	73	->scalarNode('internal_error_message')->defaultNull()->end()
48	73	->booleanNode('show_debug_info')->defaultValue(false)->end()
49	73	->booleanNode('config_validation')->defaultValue($this->debug)->end()
50	73	->arrayNode('schema')
51	73	->beforeNormalization()
52		->ifTrue(function ($v) {
53	61	$needNormalization = isset($v['query']) && is_string($v['query']) \|\|
54		isset($v['mutation']) && is_string($v['mutation']) \|\|
55	61	isset($v['subscription']) && is_string($v['subscription']);
56
57	61	return $needNormalization;
58	73	})
59		->then(function ($v) {
60	61	return ['default' => $v];
61	73	})
62	73	->end()
63	73	->useAttributeAsKey('name')
64	73	->prototype('array')
65	73	->addDefaultsIfNotSet()
66	73	->children()
67	73	->scalarNode('query')->defaultNull()->end()
68	73	->scalarNode('mutation')->defaultNull()->end()
69	73	->scalarNode('subscription')->defaultNull()->end()
70	73	->end()
71	73	->end()
72	73	->end()
73	73	->arrayNode('auto_mapping')
74	73	->treatFalseLike(['enabled' => false])
75	73	->treatTrueLike(['enabled' => true])
76	73	->treatNullLike(['enabled' => true])
77	73	->addDefaultsIfNotSet()
78	73	->children()
79	73	->booleanNode('enabled')->defaultValue(true)->end()
80	73	->arrayNode('directories')
81	73	->info('List of directories containing GraphQL classes.')
82	73	->prototype('scalar')->end()
83	73	->end()
84	73	->end()
85	73	->end()
86	73	->arrayNode('mappings')
87	73	->children()
88	73	->arrayNode('types')
89	73	->prototype('array')
90	73	->addDefaultsIfNotSet()
91	73	->children()
92	73	->enumNode('type')->isRequired()->values(['yml', 'xml'])->end()
93	73	->scalarNode('dir')->defaultNull()->end()
94	73	->end()
95	73	->end()
96	73	->end()
97	73	->end()
98	73	->end()
99	73	->arrayNode('exceptions')
100	73	->addDefaultsIfNotSet()
101	73	->children()
102	73	->arrayNode('warnings')
103	73	->treatNullLike([])
104	73	->prototype('scalar')->end()
105	73	->end()
106	73	->arrayNode('errors')
107	73	->treatNullLike([])
108	73	->prototype('scalar')->end()
109	73	->end()
110	73	->arrayNode('types')
111	73	->addDefaultsIfNotSet()
112	73	->children()
113	73	->scalarNode('warnings')
114	73	->defaultValue(ErrorHandler::DEFAULT_USER_WARNING_CLASS)
115	73	->end()
116	73	->scalarNode('errors')
117	73	->defaultValue(ErrorHandler::DEFAULT_USER_ERROR_CLASS)
118	73	->end()
119	73	->end()
120	73	->end()
121	73	->end()
122	73	->end()
123
124	73	->arrayNode('builders')
125	73	->children()
126	73	->append($this->addBuilderSection('field'))
127	73	->append($this->addBuilderSection('args'))
128	73	->end()
129	73	->end()
130
131	73	->end()
132	73	->end()
133	73	->arrayNode('templates')
134	73	->addDefaultsIfNotSet()
135	73	->children()
136	73	->scalarNode('graphiql')
137	73	->defaultValue('OverblogGraphQLBundle:GraphiQL:index.html.twig')
138	73	->end()
139	73	->end()
140	73	->end()
141	73	->arrayNode('services')
142	73	->addDefaultsIfNotSet()
143	73	->children()
144	73	->scalarNode('executor')
145	73	->defaultValue('overblog_graphql.executor.default')
146	73	->end()
147	73	->scalarNode('promise_adapter')
148	73	->defaultValue('overblog_graphql.promise_adapter.default')
149	73	->end()
150	73	->scalarNode('expression_language')
151	73	->defaultValue('overblog_graphql.expression_language.default')
152	73	->end()
153	73	->scalarNode('cache_expression_language_parser')
154	73	->defaultValue('overblog_graphql.cache_expression_language_parser.default')
155	73	->end()
156	73	->end()
157	73	->end()
158	73	->arrayNode('security')
159	73	->addDefaultsIfNotSet()
160	73	->children()
161	73	->append($this->addSecurityQuerySection('query_max_depth', QueryDepth::DISABLED))
162	73	->append($this->addSecurityQuerySection('query_max_complexity', QueryComplexity::DISABLED))
163	73	->end()
164	73	->end()
165	73	->arrayNode('versions')
166	73	->addDefaultsIfNotSet()
167	73	->children()
168	73	->scalarNode('graphiql')->defaultValue('0.9')->end()
169	73	->scalarNode('react')->defaultValue('15.4')->end()
170	73	->scalarNode('fetch')->defaultValue('2.0')->end()
171	73	->end()
172	73	->end()
173	73	->end();
174
175	73	return $treeBuilder;
176		}
177
178	73	private function addBuilderSection($name)
179		{
180	73	$builder = new TreeBuilder();
181	73	$node = $builder->root($name);
182	73	$node->beforeNormalization()
183		->ifTrue(function ($v) {
184	1	return is_array($v) && !empty($v);
185	73	})
186		->then(function ($v) {
187	1	foreach ($v as $key => &$config) {
188	1	if (is_string($config)) {
189		$config = [
190	1	'alias' => $key,
191	1	'class' => $config,
192	1	];
193	1	}
194	1	}
195
196	1	return $v;
197	73	})
198	73	->end();
199
200	73	$node->prototype('array')
		0 ignored issues – show Bug introduced 2017-02-09 14:51 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...
201	73	->children()
202	73	->scalarNode('alias')->isRequired()->end()
203	73	->scalarNode('class')->isRequired()->end()
204	73	->end()
205	73	->end()
206		;
207
208	73	return $node;
209		}
210
211	73	private function addSecurityQuerySection($name, $disabledValue)
212		{
213	73	$builder = new TreeBuilder();
214	73	$node = $builder->root($name, 'integer');
215
216		$node
217	73	->info('Disabled if equal to false.')
218	73	->beforeNormalization()
219		->ifTrue(function ($v) {
220	2	return false === $v;
221	73	})
222		->then(function () use ($disabledValue) {
223		return $disabledValue;
224	73	})
225	73	->end()
226	73	->defaultFalse()
227	73	->validate()
228	73	->ifTrue(function ($v) {
229	2	return $v < 0;
230	73	})
231	73	->thenInvalid('"overblog_graphql.security.'.$name.'" must be greater or equal to 0.')
232	73	->end()
233		;
234
235	73	return $node;
236		}
237		}
238

overblog / GraphQLBundle

Scrutinizer GitHub App not installed

Pull Request — master (#137)

Configuration A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like