Configuration::getConfigTreeBuilder() - Code Metrics - Inspection of "[Helper] Add static map support" - egeloen/IvoryGoogleMapBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#202)

by Eric

created 2017-02-26 18:52 UTC

Configuration::getConfigTreeBuilder() B

↳ Parent: Configuration

Complexity

Conditions	2
Paths	2

Size

Total Lines	26
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	2

Importance

Changes

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

<?php

/*
 * This file is part of the Ivory Google Map bundle package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Ivory\GoogleMapBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * @author GeLo <[email protected]>
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = $this->createTreeBuilder();
        $children = $treeBuilder->root('ivory_google_map')
            ->children()
            ->append($this->createMapNode())
            ->append($this->createStaticMapNode());

        $services = [
            'direction'          => true,
            'distance_matrix'    => true,
            'elevation'          => true,
            'geocoder'           => true,
            'place_autocomplete' => true,
            'place_detail'       => true,
            'place_photo'        => false,
            'place_search'       => true,
            'time_zone'          => true,
        ];

        foreach ($services as $service => $http) {
            $children->append($this->createServiceNode($service, $http));
        }

        return $treeBuilder;
    }

    /**
     * @return ArrayNodeDefinition
     */
    private function createMapNode()
    {
        return $this->createNode('map')
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.
    }
}
            ->addDefaultsIfNotSet()
            ->children()
                ->booleanNode('debug')->defaultValue('%kernel.debug%')->end()
                ->scalarNode('language')->defaultValue('%locale%')->end()
                ->scalarNode('api_key')->end()
            ->end();
    }

    /**
     * @return ArrayNodeDefinition
     */
    private function createStaticMapNode()
    {
        return $this->createNode('static_map')
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.
    }
}
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('api_key')->end()
                ->append($this->createBusinessAccountNode(false))
            ->end();
    }

    /**
     * @param string $service
     * @param bool   $http
     *
     * @return ArrayNodeDefinition
     */
    private function createServiceNode($service, $http)
    {
        $node = $this->createNode($service);
        $children = $node
            ->children()
            ->scalarNode('api_key')->end()
            ->append($this->createBusinessAccountNode(true));

        if ($http) {
            $children
                ->scalarNode('client')
                    ->isRequired()
                    ->cannotBeEmpty()
                ->end()
                ->scalarNode('message_factory')
                    ->isRequired()
                    ->cannotBeEmpty()
                ->end()
                ->scalarNode('format')->end();
        } else {
            $node
                ->beforeNormalization()
                    ->ifNull()
                    ->then(function () {
                        return [];
                    })
                ->end();
        }

        return $node;
    }

    /**
     * @param bool $service
     *
     * @return ArrayNodeDefinition
     */
    private function createBusinessAccountNode($service)
    {
        $node = $this->createNode('business_account');
        $clientIdNode = $node->children()
            ->scalarNode('secret')
                ->isRequired()
                ->cannotBeEmpty()
            ->end()
            ->scalarNode('channel')->end()
            ->scalarNode('client_id');

        if ($service) {
            $clientIdNode
                ->isRequired()
                ->cannotBeEmpty();
        }

        return $node;
    }

    /**
     * @param string $name
     * @param string $type
     *
     * @return ArrayNodeDefinition|NodeDefinition
     */
    private function createNode($name, $type = 'array')
    {
        return $this->createTreeBuilder()->root($name, $type);
    }

    /**
     * @return TreeBuilder
     */
    private function createTreeBuilder()
    {
        return new TreeBuilder();
    }
}


1		<?php
2
3		/*
4		* This file is part of the Ivory Google Map bundle package.
5		*
6		* (c) Eric GELOEN <[email protected]>
7		*
8		* For the full copyright and license information, please read the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Ivory\GoogleMapBundle\DependencyInjection;
13
14		use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
15		use Symfony\Component\Config\Definition\Builder\NodeDefinition;
16		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
17		use Symfony\Component\Config\Definition\ConfigurationInterface;
18
19		/**
20		* @author GeLo <[email protected]>
21		*/
22		class Configuration implements ConfigurationInterface
23		{
24		/**
25		* {@inheritdoc}
26		*/
27	684	public function getConfigTreeBuilder()
28		{
29	684	$treeBuilder = $this->createTreeBuilder();
30	684	$children = $treeBuilder->root('ivory_google_map')
31	684	->children()
32	684	->append($this->createMapNode())
33	684	->append($this->createStaticMapNode());
34
35		$services = [
36	684	'direction' => true,
37	532	'distance_matrix' => true,
38	532	'elevation' => true,
39	532	'geocoder' => true,
40	532	'place_autocomplete' => true,
41	532	'place_detail' => true,
42	532	'place_photo' => false,
43	532	'place_search' => true,
44	532	'time_zone' => true,
45	532	];
46
47	684	foreach ($services as $service => $http) {
48	684	$children->append($this->createServiceNode($service, $http));
49	532	}
50
51	684	return $treeBuilder;
52		}
53
54		/**
55		* @return ArrayNodeDefinition
56		*/
57	684	private function createMapNode()
58		{
59	684	return $this->createNode('map')
		0 ignored issues – show Bug introduced 2017-02-19 14:10 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 `addDefaultsIfNotSet()` 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...
60	684	->addDefaultsIfNotSet()
61	684	->children()
62	684	->booleanNode('debug')->defaultValue('%kernel.debug%')->end()
63	684	->scalarNode('language')->defaultValue('%locale%')->end()
64	684	->scalarNode('api_key')->end()
65	684	->end();
66		}
67
68		/**
69		* @return ArrayNodeDefinition
70		*/
71	684	private function createStaticMapNode()
72		{
73	684	return $this->createNode('static_map')
		0 ignored issues – show Bug introduced 2017-02-19 14:10 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 `addDefaultsIfNotSet()` 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...
74	684	->addDefaultsIfNotSet()
75	684	->children()
76	684	->scalarNode('api_key')->end()
77	684	->append($this->createBusinessAccountNode(false))
78	684	->end();
79		}
80
81		/**
82		* @param string $service
83		* @param bool $http
84		*
85		* @return ArrayNodeDefinition
86		*/
87	684	private function createServiceNode($service, $http)
88		{
89	684	$node = $this->createNode($service);
90		$children = $node
91	684	->children()
92	684	->scalarNode('api_key')->end()
93	684	->append($this->createBusinessAccountNode(true));
94
95	684	if ($http) {
96		$children
97	684	->scalarNode('client')
98	684	->isRequired()
99	684	->cannotBeEmpty()
100	684	->end()
101	684	->scalarNode('message_factory')
102	684	->isRequired()
103	684	->cannotBeEmpty()
104	684	->end()
105	684	->scalarNode('format')->end();
106	532	} else {
107		$node
108	684	->beforeNormalization()
109	684	->ifNull()
110	684	->then(function () {
111	9	return [];
112	684	})
113	684	->end();
114		}
115
116	684	return $node;
117		}
118
119		/**
120		* @param bool $service
121		*
122		* @return ArrayNodeDefinition
123		*/
124	684	private function createBusinessAccountNode($service)
125		{
126	684	$node = $this->createNode('business_account');
127	684	$clientIdNode = $node->children()
128	684	->scalarNode('secret')
129	684	->isRequired()
130	684	->cannotBeEmpty()
131	684	->end()
132	684	->scalarNode('channel')->end()
133	684	->scalarNode('client_id');
134
135	684	if ($service) {
136		$clientIdNode
137	684	->isRequired()
138	684	->cannotBeEmpty();
139	532	}
140
141	684	return $node;
142		}
143
144		/**
145		* @param string $name
146		* @param string $type
147		*
148		* @return ArrayNodeDefinition\|NodeDefinition
149		*/
150	684	private function createNode($name, $type = 'array')
151		{
152	684	return $this->createTreeBuilder()->root($name, $type);
153		}
154
155		/**
156		* @return TreeBuilder
157		*/
158	684	private function createTreeBuilder()
159		{
160	684	return new TreeBuilder();
161		}
162		}
163

egeloen / IvoryGoogleMapBundle

GitHub Access Token became invalid

Pull Request — master (#202)

Configuration::getConfigTreeBuilder() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like