Configuration::createMapNode() - 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-19 13:06 UTC

Configuration::createMapNode() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	8
nc	1
nop	0

<?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			public function getConfigTreeBuilder()
28			{
29			$treeBuilder = $this->createTreeBuilder();
30			$children = $treeBuilder->root('ivory_google_map')
31			->children()
32			->append($this->createMapNode())
33			->append($this->createStaticMapNode());
34
35			$services = [
36			'direction' => true,
37			'distance_matrix' => true,
38			'elevation' => true,
39			'geocoder' => true,
40			'place_autocomplete' => true,
41			'place_detail' => true,
42			'place_photo' => false,
43			'place_search' => true,
44			'time_zone' => true,
45			];
46
47			foreach ($services as $service => $http) {
48			$children->append($this->createServiceNode($service, $http));
49			}
50
51			return $treeBuilder;
52			}
53
54			/**
55			* @return ArrayNodeDefinition
56			*/
57			private function createMapNode()
58			{
59			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			->addDefaultsIfNotSet()
61			->children()
62			->booleanNode('debug')->defaultValue('%kernel.debug%')->end()
63			->scalarNode('language')->defaultValue('%locale%')->end()
64			->scalarNode('api_key')->end()
65			->end();
66			}
67
68			/**
69			* @return ArrayNodeDefinition
70			*/
71			private function createStaticMapNode()
72			{
73			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			->addDefaultsIfNotSet()
75			->children()
76			->scalarNode('api_key')->end()
77			->append($this->createBusinessAccountNode(false))
78			->end();
79			}
80
81			/**
82			* @param string $service
83			* @param bool $http
84			*
85			* @return ArrayNodeDefinition
86			*/
87			private function createServiceNode($service, $http)
88			{
89			$node = $this->createNode($service);
90			$children = $node
91			->children()
92			->scalarNode('api_key')->end()
93			->append($this->createBusinessAccountNode(true));
94
95			if ($http) {
96			$children
97			->scalarNode('client')
98			->isRequired()
99			->cannotBeEmpty()
100			->end()
101			->scalarNode('message_factory')
102			->isRequired()
103			->cannotBeEmpty()
104			->end()
105			->scalarNode('format')->end();
106			} else {
107			$node
108			->beforeNormalization()
109			->ifNull()
110			->then(function () { return []; })
111			->end();
112			}
113
114			return $node;
115			}
116
117			/**
118			* @param bool $service
119			*
120			* @return ArrayNodeDefinition
121			*/
122			private function createBusinessAccountNode($service)
123			{
124			$node = $this->createNode('business_account');
125			$clientIdNode = $node->children()
126			->scalarNode('secret')
127			->isRequired()
128			->cannotBeEmpty()
129			->end()
130			->scalarNode('channel')->end()
131			->scalarNode('client_id');
132
133			if ($service) {
134			$clientIdNode
135			->isRequired()
136			->cannotBeEmpty();
137			};
138
139			return $node;
140			}
141
142			/**
143			* @param string $name
144			* @param string $type
145			*
146			* @return ArrayNodeDefinition\|NodeDefinition
147			*/
148			private function createNode($name, $type = 'array')
149			{
150			return $this->createTreeBuilder()->root($name, $type);
151			}
152
153			/**
154			* @return TreeBuilder
155			*/
156			private function createTreeBuilder()
157			{
158			return new TreeBuilder();
159			}
160			}
161

egeloen / IvoryGoogleMapBundle

GitHub Access Token became invalid

Pull Request — master (#202)

Configuration::createMapNode() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like