Configuration::getPersistersNode() - Code Metrics - Inspection of "Initial bundle implementation" - as3io/As3ModlrBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

by Jacob

created 2016-03-15 21:02 UTC

Configuration::getPersistersNode() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	26
Code Lines	20

Duplication

Lines	26
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	26
loc	26
rs	8.8571
cc	1
eloc	20
nc	1
nop	0

<?php

namespace As3\Bundle\ModlrBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;

/**
 * Validates and merges configuration for Modlr.
 *
 * @author  Jacob Bare <[email protected]>
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritDoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $treeBuilder->root('as3_modlr')
            ->children()
                ->append($this->getAdapterNode())
                ->append($this->getMetadataNode())
                ->append($this->getPersistersNode())
                ->append($this->getRestNode())
                ->append($this->getSearchClientsNode())
            ->end()
        ;
        return $treeBuilder;
    }

    /**
     * Formats the root REST endpoint.
     *
     * @param   string  $endpoint
     * @return  string
     */
    private function formatRestEndpoint($endpoint)
    {
        return sprintf('%s', trim($endpoint, '/'));
    }

    /**
     * Gets the api adapter configuration node.
     *
     * @return  \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
     */
    private function getAdapterNode()
    {
        $treeBuilder = new TreeBuilder();
        $node = $treeBuilder->root('adapter');
        return $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.
    }
}
            ->isRequired()
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('type')->end()
                ->scalarNode('service')->end()
            ->end()
            ->validate()
                ->always(function($v) {
                    $this->validateAdapter($v);
                    return $v;
                })
            ->end()
        ;
    }

    /**
     * Gets the metadata configuration node.
     *
     * @return  \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
     */
    private function getMetadataNode()
    {
        $treeBuilder = new TreeBuilder();
        $node = $treeBuilder->root('metadata');
        return $node
            ->addDefaultsIfNotSet()
            ->children()
                ->arrayNode('drivers')
                    ->defaultValue(['default' => ['type' => 'yml']])
                    ->useAttributeAsKey('name')
                    ->prototype('array')
                        ->performNoDeepMerging()
                        ->children()

                            ->enumNode('type')->defaultValue('file')
                            ->values(['yml', null])
                            ->end()
                            ->scalarNode('service')->cannotBeEmpty()->end()

                            ->arrayNode('parameters')
                                ->prototype('variable')->end()
                            ->end()

                        ->end()
                    ->end()
                    ->validate()
                        ->always(function($v) {
                            $this->validateMetadataDrivers($v);
                            return $v;
                        })
                    ->end()
                ->end()

                ->arrayNode('cache')
                    ->canBeDisabled()
                    ->children()

                        ->enumNode('type')->defaultValue('file')
                            ->values(['file', 'binary_file', 'redis', null])
                        ->end()
                        ->scalarNode('service')->cannotBeEmpty()->end()

                        ->arrayNode('parameters')
                            ->prototype('variable')->end()
                        ->end()

                    ->end()

                    ->validate()
                        ->always(function($v) {
                            $this->validateMetadataCache($v);
                            return $v;
                        })
                    ->end()
                ->end()
            ->end()
        ;
    }

    /**
     * Gets the persisters configuration node.
     *
     * @return  \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
     */
    private function getPersistersNode()

    {
        $treeBuilder = new TreeBuilder();
        $node = $treeBuilder->root('persisters');
        return $node
            ->isRequired()
            ->useAttributeAsKey('name')
            ->prototype('array')
                ->children()

                    ->scalarNode('type')->cannotBeEmpty()->end()
                    ->scalarNode('service')->cannotBeEmpty()->end()

                    ->arrayNode('parameters')
                        ->prototype('variable')->end()
                    ->end()
                ->end()
            ->end()
            ->validate()
                ->always(function($v) {
                    $this->validatePersisters($v);
                    return $v;
                })
            ->end()
        ;
    }

    /**
     * Gets the rest configuration node.
     *
     * @return  \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
     */
    private function getRestNode()
    {
        $treeBuilder = new TreeBuilder();
        $node = $treeBuilder->root('rest');
        return $node
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('root_endpoint')->isRequired()->cannotBeEmpty()->defaultValue('modlr/api')
                    ->validate()
                        ->always(function($v) {
                            $v = $this->formatRestEndpoint($v);
                            return $v;
                        })
                    ->end()
                ->end()
            ->end()

        ;
    }

    /**
     * Gets the search clients configuration node.
     *
     * @return  \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
     */
    private function getSearchClientsNode()

    {
        $treeBuilder = new TreeBuilder();
        $node = $treeBuilder->root('search_clients');
        return $node
            ->isRequired()
            ->useAttributeAsKey('name')
            ->prototype('array')
                ->children()

                    ->scalarNode('type')->cannotBeEmpty()->end()
                    ->scalarNode('service')->cannotBeEmpty()->end()

                    ->arrayNode('parameters')
                        ->prototype('variable')->end()
                    ->end()
                ->end()
            ->end()
            ->validate()
                ->always(function($v) {
                    $this->validateSearchClients($v);
                    return $v;
                })
            ->end()
        ;
    }

    /**
     * Validates the api adapter config.
     *
     * @param   array   $adapter
     * @return  self
     * @throws  InvalidConfigurationException
     */
    private function validateAdapter(array $adapter)
    {
        $this->validateTypeAndService($adapter, 'as3_modlr.adapter');

        if (isset($adapter['type'])) {
            if ('jsonapiorg' === $adapter['type']) {
                if (false === class_exists('As3\Modlr\Api\JsonApiOrg\Adapter')) {
                    throw new InvalidConfigurationException('The jsonapi.org adapter class was not found for "as3_modlr.adapter.type" - was the library installed?');
                }
            } else {
                throw new InvalidConfigurationException('An unrecognized adapter type was set for "as3_modlr.adapter.type"');
            }
        }
        return $this;
    }

    /**
     * Validates the metadata cache config.
     *
     * @param   array   $config
     * @return  self
     * @throws  InvalidConfigurationException
     */
    private function validateMetadataCache(array $config)
    {
        if (false === $config['enabled']) {
            return $this;
        }

        $this->validateTypeAndService($config, 'as3_modlr.metadata.cache');
        if (isset($config['type']) && 'redis' === $config['type'] && !isset($config['parameters']['handler'])) {
            throw new InvalidConfigurationException('A Redis handler service name must be defined for "as3_modlr.metadata.cache.parameters.handler"');
        }
        return $this;
    }

    /**
     * Validates the metadata drivers config.
     *
     * @param   array   $drivers
     * @return  self
     * @throws  InvalidConfigurationException
     */
    private function validateMetadataDrivers(array $drivers)
    {
        foreach ($drivers as $name => $config) {
            $this->validateTypeAndService($config, sprintf('as3_modlr.metadata.drivers.%s', $name));
        }
        return $this;
    }

    /**
     * Validates the persisters config.
     *
     * @param   array   $persisters
     * @return  self
     * @throws  InvalidConfigurationException
     */
    private function validatePersisters(array $persisters)
    {
        foreach ($persisters as $name => $config) {
            $this->validateTypeAndService($config, sprintf('as3_modlr.persisters.%s', $name));
            if (isset($config['type'])) {
                if ('mongodb' === $config['type']) {
                    if (false === class_exists(Utility::getLibraryClass('Persister\MongoDb\Persister'))) {

                        throw new InvalidConfigurationException(sprintf('The MongoDB persister library class was not found for "as3_modlr.persisters.%s.type" - was the library installed?', $name));
                    }
                    if (!isset($config['parameters']['host'])) {
                        throw new InvalidConfigurationException(sprintf('The MongoDB persister requires a value for "as3_modlr.persisters.%s.parameters.host"', $name));
                    }
                } else {
                    throw new InvalidConfigurationException(sprintf('An unrecognized persister type was set for "as3_modlr.persisters.%s.type"', $name));
                }
            }
        }
    }

    /**
     * Validates the search clients config.
     *
     * @param   array   $clients
     * @return  self
     * @throws  InvalidConfigurationException
     */
    private function validateSearchClients(array $clients)
    {
        foreach ($clients as $name => $config) {
            $this->validateTypeAndService($config, sprintf('as3_modlr.search_clients.%s', $name));
            if (isset($config['type'])) {
                if ('elastic' === $config['type']) {
                    if (false === class_exists(Utility::getLibraryClass('Search\Elastic\Client'))) {

                        throw new InvalidConfigurationException(sprintf('The Elastic persister library class was not found for "as3_modlr.search_clients.%s.type" - was the library installed?', $name));
                    }
                } else {
                    throw new InvalidConfigurationException(sprintf('An unrecognized search type was set for "as3_modlr.search_clients.%s.type"', $name));
                }
            }
        }
    }

    private function validateTypeAndService(array $config, $path)
    {
        if (!isset($config['type']) && !isset($config['service'])) {

            throw new InvalidConfigurationException(sprintf('You must set one of "type" or "service" for "%s"', $path));
        }
        if (isset($config['type']) && isset($config['service'])) {

            throw new InvalidConfigurationException(sprintf('You cannot set both "type" and "service" for "%s" - please choose one.', $path));
        }
    }
}


1		<?php
2
3		namespace As3\Bundle\ModlrBundle\DependencyInjection;
4
5		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
6		use Symfony\Component\Config\Definition\ConfigurationInterface;
7		use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
8
9		/**
10		* Validates and merges configuration for Modlr.
11		*
12		* @author Jacob Bare <[email protected]>
13		*/
14		class Configuration implements ConfigurationInterface
15		{
16		/**
17		* {@inheritDoc}
18		*/
19		public function getConfigTreeBuilder()
20		{
21		$treeBuilder = new TreeBuilder();
22		$treeBuilder->root('as3_modlr')
23		->children()
24		->append($this->getAdapterNode())
25		->append($this->getMetadataNode())
26		->append($this->getPersistersNode())
27		->append($this->getRestNode())
28		->append($this->getSearchClientsNode())
29		->end()
30		;
31		return $treeBuilder;
32		}
33
34		/**
35		* Formats the root REST endpoint.
36		*
37		* @param string $endpoint
38		* @return string
39		*/
40		private function formatRestEndpoint($endpoint)
41		{
42		return sprintf('%s', trim($endpoint, '/'));
43		}
44
45		/**
46		* Gets the api adapter configuration node.
47		*
48		* @return \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
49		*/
50		private function getAdapterNode()
51		{
52		$treeBuilder = new TreeBuilder();
53		$node = $treeBuilder->root('adapter');
54		return $node
		1 ignored issue – show Bug introduced 2016-03-15 20: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 `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...
55		->isRequired()
56		->addDefaultsIfNotSet()
57		->children()
58		->scalarNode('type')->end()
59		->scalarNode('service')->end()
60		->end()
61		->validate()
62		->always(function($v) {
63		$this->validateAdapter($v);
64		return $v;
65		})
66		->end()
67		;
68		}
69
70		/**
71		* Gets the metadata configuration node.
72		*
73		* @return \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
74		*/
75		private function getMetadataNode()
76		{
77		$treeBuilder = new TreeBuilder();
78		$node = $treeBuilder->root('metadata');
79		return $node
80		->addDefaultsIfNotSet()
81		->children()
82		->arrayNode('drivers')
83		->defaultValue(['default' => ['type' => 'yml']])
84		->useAttributeAsKey('name')
85		->prototype('array')
86		->performNoDeepMerging()
87		->children()
88
89		->enumNode('type')->defaultValue('file')
90		->values(['yml', null])
91		->end()
92		->scalarNode('service')->cannotBeEmpty()->end()
93
94		->arrayNode('parameters')
95		->prototype('variable')->end()
96		->end()
97
98		->end()
99		->end()
100		->validate()
101		->always(function($v) {
102		$this->validateMetadataDrivers($v);
103		return $v;
104		})
105		->end()
106		->end()
107
108		->arrayNode('cache')
109		->canBeDisabled()
110		->children()
111
112		->enumNode('type')->defaultValue('file')
113		->values(['file', 'binary_file', 'redis', null])
114		->end()
115		->scalarNode('service')->cannotBeEmpty()->end()
116
117		->arrayNode('parameters')
118		->prototype('variable')->end()
119		->end()
120
121		->end()
122
123		->validate()
124		->always(function($v) {
125		$this->validateMetadataCache($v);
126		return $v;
127		})
128		->end()
129		->end()
130		->end()
131		;
132		}
133
134		/**
135		* Gets the persisters configuration node.
136		*
137		* @return \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
138		*/
139	View Code Duplication	private function getPersistersNode()
		1 ignored issue – show Duplication introduced 2016-03-15 20:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
140		{
141		$treeBuilder = new TreeBuilder();
142		$node = $treeBuilder->root('persisters');
143		return $node
144		->isRequired()
145		->useAttributeAsKey('name')
146		->prototype('array')
147		->children()
148
149		->scalarNode('type')->cannotBeEmpty()->end()
150		->scalarNode('service')->cannotBeEmpty()->end()
151
152		->arrayNode('parameters')
153		->prototype('variable')->end()
154		->end()
155		->end()
156		->end()
157		->validate()
158		->always(function($v) {
159		$this->validatePersisters($v);
160		return $v;
161		})
162		->end()
163		;
164		}
165
166		/**
167		* Gets the rest configuration node.
168		*
169		* @return \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
170		*/
171		private function getRestNode()
172		{
173		$treeBuilder = new TreeBuilder();
174		$node = $treeBuilder->root('rest');
175		return $node
176		->addDefaultsIfNotSet()
177		->children()
178		->scalarNode('root_endpoint')->isRequired()->cannotBeEmpty()->defaultValue('modlr/api')
179		->validate()
180		->always(function($v) {
181		$v = $this->formatRestEndpoint($v);
182		return $v;
183		})
184		->end()
185		->end()
186		->end()
187
188		;
189		}
190
191		/**
192		* Gets the search clients configuration node.
193		*
194		* @return \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition
195		*/
196	View Code Duplication	private function getSearchClientsNode()
		1 ignored issue – show Duplication introduced 2016-03-15 20:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
197		{
198		$treeBuilder = new TreeBuilder();
199		$node = $treeBuilder->root('search_clients');
200		return $node
201		->isRequired()
202		->useAttributeAsKey('name')
203		->prototype('array')
204		->children()
205
206		->scalarNode('type')->cannotBeEmpty()->end()
207		->scalarNode('service')->cannotBeEmpty()->end()
208
209		->arrayNode('parameters')
210		->prototype('variable')->end()
211		->end()
212		->end()
213		->end()
214		->validate()
215		->always(function($v) {
216		$this->validateSearchClients($v);
217		return $v;
218		})
219		->end()
220		;
221		}
222
223		/**
224		* Validates the api adapter config.
225		*
226		* @param array $adapter
227		* @return self
228		* @throws InvalidConfigurationException
229		*/
230		private function validateAdapter(array $adapter)
231		{
232		$this->validateTypeAndService($adapter, 'as3_modlr.adapter');
233
234		if (isset($adapter['type'])) {
235		if ('jsonapiorg' === $adapter['type']) {
236		if (false === class_exists('As3\Modlr\Api\JsonApiOrg\Adapter')) {
237		throw new InvalidConfigurationException('The jsonapi.org adapter class was not found for "as3_modlr.adapter.type" - was the library installed?');
238		}
239		} else {
240		throw new InvalidConfigurationException('An unrecognized adapter type was set for "as3_modlr.adapter.type"');
241		}
242		}
243		return $this;
244		}
245
246		/**
247		* Validates the metadata cache config.
248		*
249		* @param array $config
250		* @return self
251		* @throws InvalidConfigurationException
252		*/
253		private function validateMetadataCache(array $config)
254		{
255		if (false === $config['enabled']) {
256		return $this;
257		}
258
259		$this->validateTypeAndService($config, 'as3_modlr.metadata.cache');
260		if (isset($config['type']) && 'redis' === $config['type'] && !isset($config['parameters']['handler'])) {
261		throw new InvalidConfigurationException('A Redis handler service name must be defined for "as3_modlr.metadata.cache.parameters.handler"');
262		}
263		return $this;
264		}
265
266		/**
267		* Validates the metadata drivers config.
268		*
269		* @param array $drivers
270		* @return self
271		* @throws InvalidConfigurationException
272		*/
273		private function validateMetadataDrivers(array $drivers)
274		{
275		foreach ($drivers as $name => $config) {
276		$this->validateTypeAndService($config, sprintf('as3_modlr.metadata.drivers.%s', $name));
277		}
278		return $this;
279		}
280
281		/**
282		* Validates the persisters config.
283		*
284		* @param array $persisters
285		* @return self
286		* @throws InvalidConfigurationException
287		*/
288		private function validatePersisters(array $persisters)
289		{
290		foreach ($persisters as $name => $config) {
291		$this->validateTypeAndService($config, sprintf('as3_modlr.persisters.%s', $name));
292		if (isset($config['type'])) {
293		if ('mongodb' === $config['type']) {
294	View Code Duplication	if (false === class_exists(Utility::getLibraryClass('Persister\MongoDb\Persister'))) {
		0 ignored issues – show Duplication introduced 2016-03-15 20:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
295		throw new InvalidConfigurationException(sprintf('The MongoDB persister library class was not found for "as3_modlr.persisters.%s.type" - was the library installed?', $name));
296		}
297		if (!isset($config['parameters']['host'])) {
298		throw new InvalidConfigurationException(sprintf('The MongoDB persister requires a value for "as3_modlr.persisters.%s.parameters.host"', $name));
299		}
300		} else {
301		throw new InvalidConfigurationException(sprintf('An unrecognized persister type was set for "as3_modlr.persisters.%s.type"', $name));
302		}
303		}
304		}
305		}
306
307		/**
308		* Validates the search clients config.
309		*
310		* @param array $clients
311		* @return self
312		* @throws InvalidConfigurationException
313		*/
314		private function validateSearchClients(array $clients)
315		{
316		foreach ($clients as $name => $config) {
317		$this->validateTypeAndService($config, sprintf('as3_modlr.search_clients.%s', $name));
318		if (isset($config['type'])) {
319		if ('elastic' === $config['type']) {
320	View Code Duplication	if (false === class_exists(Utility::getLibraryClass('Search\Elastic\Client'))) {
		0 ignored issues – show Duplication introduced 2016-03-15 20:30 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
321		throw new InvalidConfigurationException(sprintf('The Elastic persister library class was not found for "as3_modlr.search_clients.%s.type" - was the library installed?', $name));
322		}
323		} else {
324		throw new InvalidConfigurationException(sprintf('An unrecognized search type was set for "as3_modlr.search_clients.%s.type"', $name));
325		}
326		}
327		}
328		}
329
330		private function validateTypeAndService(array $config, $path)
331		{
332	View Code Duplication	if (!isset($config['type']) && !isset($config['service'])) {
		0 ignored issues – show Duplication introduced 2016-03-15 21:06 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
333		throw new InvalidConfigurationException(sprintf('You must set one of "type" or "service" for "%s"', $path));
334		}
335	View Code Duplication	if (isset($config['type']) && isset($config['service'])) {
		0 ignored issues – show Duplication introduced 2016-03-15 21:06 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
336		throw new InvalidConfigurationException(sprintf('You cannot set both "type" and "service" for "%s" - please choose one.', $path));
337		}
338		}
339		}
340

as3io / As3ModlrBundle

Pull Request — master (#3)

Configuration::getPersistersNode() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like