Configuration::configureEntityProto() - Code Metrics - Inspection of "Form processor" - php-rpc/cruds - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Pavel

created 2016-11-01 18:29 UTC

Configuration::configureEntityProto() A

↳ Parent: Configuration

Complexity

Conditions	3
Paths	1

Size

Total Lines	69
Code Lines	52

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	47
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	69
ccs	47
cts	48
cp	0.9792
rs	9.2083
c	0
b	0
f	0
cc	3
eloc	52
nc	1
nop	1
crap	3

How to fix Long Method

<?php

namespace ScayTrase\Api\Cruds\DependencyInjection;

use ScayTrase\Api\Cruds\EntityFactoryInterface;
use ScayTrase\Api\Cruds\EntityProcessorInterface;
use ScayTrase\Api\Cruds\PropertyAccessProcessor;
use ScayTrase\Api\Cruds\ReflectionConstructorFactory;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

final class Configuration implements ConfigurationInterface
{
    /** {@inheritdoc} */
    public function getConfigTreeBuilder()
    {
        $builder = new TreeBuilder();
        $root    = $builder->root('cruds');

        $entities = $root->children()->arrayNode('entities');
        $entities->useAttributeAsKey('name');
        $entities->normalizeKeys(false);
        /** @var ArrayNodeDefinition $entitiesProto */
        $entitiesProto = $entities->prototype('array');

        $events = $root->children()->arrayNode('listeners');
        $events->addDefaultsIfNotSet();
        $events
            ->children()
            ->booleanNode('param_converter')
            ->defaultTrue()
            ->info('Configure param converting for symfony request');
        $events
            ->children()
            ->booleanNode('response_normalizer')
            ->defaultTrue()
            ->info('Configure normalizer view event listener');
        $events
            ->children()
            ->booleanNode('response_serializer')
            ->defaultTrue()
            ->info('Configure serializer view event listener');

        $this->configureEntityProto($entitiesProto);

        return $builder;
    }

    private function configureEntityProto(ArrayNodeDefinition $parent)
    {
        $parent->canBeDisabled();

        $parent
            ->children()
            ->scalarNode('class')
            ->isRequired()
            ->info('Doctrine class')
            ->example('MyBundle:MyEntity');

        $parent
            ->children()
            ->scalarNode('prefix')
            ->defaultNull()
            ->info('Route prefix. Defaults to entity key if not set')
            ->example('/my-entity');

        $parent
            ->children()
            ->scalarNode('mount')
            ->defaultValue('api')
            ->cannotBeEmpty()
            ->info(
                'Route mount. You can create different entries '.
                'with different mounts. You can use this value when loading routes'
            )
            ->example('my-mount-name');

        $parent
            ->children()
            ->scalarNode('repository')
            ->defaultNull()
            ->info(
                'Entity repository. service reference,'.PHP_EOL.
                'default to factory-acquired doctrine repository'
            )
            ->example('@my_entity.repository');

        $actions = $parent
            ->children()
            ->arrayNode('actions');

        $actions
            ->beforeNormalization()
            ->ifArray()
            ->then(
                function (array $v) {
                    if (array_keys($v) !== range(0, count($v) - 1)) {
                        return $v;
                    }

                    $result = [];
                    foreach ($v as $key) {
                        $result[$key] = ['enabled' => true];
                    }

                    return $result;
                }
            )
            ->end()
            ->info('Action configuration');

        $this->configureCreateAction($actions);
        $this->configureReadAction($actions);
        $this->configureUpdateAction($actions);
        $this->configureDeleteAction($actions);
        $this->configureSearchAction($actions);
    }

    private function configureCreateAction(ArrayNodeDefinition $parent)
    {
        $create = $parent
            ->children()
            ->arrayNode('create');

        $create
            ->children()
            ->variableNode('factory')
            ->defaultNull()
            ->example('@my_entity.factory')
            ->info(
                'Service ID implementing '.PHP_EOL.
                EntityFactoryInterface::class.PHP_EOL.
                'Defaults to '.ReflectionConstructorFactory::class
            );

        $create
            ->children()
            ->variableNode('processor')
            ->defaultNull()
            ->example('@my_entity.factory')
            ->info(
                'Service ID implementing '.PHP_EOL.
                EntityFactoryInterface::class.PHP_EOL.
                'Defaults to '.ReflectionConstructorFactory::class
            );

        $this->configureActionNode($create, 'create');
    }

    private function configureSearchAction(ArrayNodeDefinition $parent)
    {
        $search = $parent
            ->children()
            ->arrayNode('search');
        $this->configureActionNode($search, 'search');

        $search
            ->children()
            ->scalarNode('count_path')
            ->info('Path for count action (will be prefixed with entity prefix)')
            ->defaultValue('/count');

        $criteria = $search->children()->variableNode('criteria');
        $criteria->info(
            'Criteria modifiers. Array will be treated as nested criteria,'.PHP_EOL.
            'allowing configuring several modifiers by key:value'
        );
        $criteria->defaultValue('cruds.criteria.entity');
        $criteria->example('my.criteria.modifier');
        $criteria->cannotBeEmpty();
    }

    private function configureReadAction(ArrayNodeDefinition $parent)
    {
        $read = $parent
            ->children()
            ->arrayNode('read');
        $this->configureActionNode($read, 'get');
    }

    private function configureUpdateAction(ArrayNodeDefinition $parent)
    {
        $update = $parent
            ->children()
            ->arrayNode('update');

        $update
            ->children()
            ->variableNode('processor')
            ->defaultNull()
            ->example('@my_entity.processor')
            ->info(
                'Service ID implementing '.PHP_EOL.
                EntityProcessorInterface::class.PHP_EOL.
                'Defaults to '.PropertyAccessProcessor::class
            );

        $this->configureActionNode($update, 'update');
    }

    private function configureDeleteAction(ArrayNodeDefinition $parent)
    {
        $delete = $parent
            ->children()
            ->arrayNode('delete');
        $this->configureActionNode($delete, 'delete');
    }

    private function configureActionNode(ArrayNodeDefinition $parent, $action)
    {
        $parent->canBeEnabled();

        $parent
            ->children()
            ->scalarNode('path')
            ->info('Action path (will be prefixed with entity prefix)')
            ->defaultValue('/'.$action);
    }
}


1		<?php
2
3		namespace ScayTrase\Api\Cruds\DependencyInjection;
4
5		use ScayTrase\Api\Cruds\EntityFactoryInterface;
6		use ScayTrase\Api\Cruds\EntityProcessorInterface;
7		use ScayTrase\Api\Cruds\PropertyAccessProcessor;
8		use ScayTrase\Api\Cruds\ReflectionConstructorFactory;
9		use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
10		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
11		use Symfony\Component\Config\Definition\ConfigurationInterface;
12
13		final class Configuration implements ConfigurationInterface
14		{
15		/** {@inheritdoc} */
16	19	public function getConfigTreeBuilder()
17		{
18	19	$builder = new TreeBuilder();
19	19	$root = $builder->root('cruds');
20
21	19	$entities = $root->children()->arrayNode('entities');
22	19	$entities->useAttributeAsKey('name');
23	19	$entities->normalizeKeys(false);
24		/** @var ArrayNodeDefinition $entitiesProto */
25	19	$entitiesProto = $entities->prototype('array');
26
27	19	$events = $root->children()->arrayNode('listeners');
28	19	$events->addDefaultsIfNotSet();
29		$events
30	19	->children()
31	19	->booleanNode('param_converter')
32	19	->defaultTrue()
33	19	->info('Configure param converting for symfony request');
34		$events
35	19	->children()
36	19	->booleanNode('response_normalizer')
37	19	->defaultTrue()
38	19	->info('Configure normalizer view event listener');
39		$events
40	19	->children()
41	19	->booleanNode('response_serializer')
42	19	->defaultTrue()
43	19	->info('Configure serializer view event listener');
44
45	19	$this->configureEntityProto($entitiesProto);
46
47	19	return $builder;
48		}
49
50	19	private function configureEntityProto(ArrayNodeDefinition $parent)
51		{
52	19	$parent->canBeDisabled();
53
54		$parent
55	19	->children()
56	19	->scalarNode('class')
57	19	->isRequired()
58	19	->info('Doctrine class')
59	19	->example('MyBundle:MyEntity');
60
61		$parent
62	19	->children()
63	19	->scalarNode('prefix')
64	19	->defaultNull()
65	19	->info('Route prefix. Defaults to entity key if not set')
66	19	->example('/my-entity');
67
68		$parent
69	19	->children()
70	19	->scalarNode('mount')
71	19	->defaultValue('api')
72	19	->cannotBeEmpty()
73	19	->info(
74		'Route mount. You can create different entries '.
75		'with different mounts. You can use this value when loading routes'
76	19	)
77	19	->example('my-mount-name');
78
79		$parent
80	19	->children()
81	19	->scalarNode('repository')
82	19	->defaultNull()
83	19	->info(
84	19	'Entity repository. service reference,'.PHP_EOL.
85		'default to factory-acquired doctrine repository'
86	19	)
87	19	->example('@my_entity.repository');
88
89		$actions = $parent
90	19	->children()
91	19	->arrayNode('actions');
92
93		$actions
94	19	->beforeNormalization()
95	19	->ifArray()
96	19	->then(
97	19	function (array $v) {
98	19	if (array_keys($v) !== range(0, count($v) - 1)) {
99		return $v;
100		}
101
102	19	$result = [];
103	19	foreach ($v as $key) {
104	19	$result[$key] = ['enabled' => true];
105	19	}
106
107	19	return $result;
108		}
109	19	)
110	19	->end()
111	19	->info('Action configuration');
112
113	19	$this->configureCreateAction($actions);
114	19	$this->configureReadAction($actions);
115	19	$this->configureUpdateAction($actions);
116	19	$this->configureDeleteAction($actions);
117	19	$this->configureSearchAction($actions);
118	19	}
119
120	19	private function configureCreateAction(ArrayNodeDefinition $parent)
121		{
122		$create = $parent
123	19	->children()
124	19	->arrayNode('create');
125
126		$create
127	19	->children()
128	19	->variableNode('factory')
129	19	->defaultNull()
130	19	->example('@my_entity.factory')
131	19	->info(
132	19	'Service ID implementing '.PHP_EOL.
133	19	EntityFactoryInterface::class.PHP_EOL.
134	19	'Defaults to '.ReflectionConstructorFactory::class
135	19	);
136
137		$create
138	19	->children()
139	19	->variableNode('processor')
140	19	->defaultNull()
141	19	->example('@my_entity.factory')
142	19	->info(
143	19	'Service ID implementing '.PHP_EOL.
144	19	EntityFactoryInterface::class.PHP_EOL.
145	19	'Defaults to '.ReflectionConstructorFactory::class
146	19	);
147
148	19	$this->configureActionNode($create, 'create');
149	19	}
150
151	19	private function configureSearchAction(ArrayNodeDefinition $parent)
152		{
153		$search = $parent
154	19	->children()
155	19	->arrayNode('search');
156	19	$this->configureActionNode($search, 'search');
157
158		$search
159	19	->children()
160	19	->scalarNode('count_path')
161	19	->info('Path for count action (will be prefixed with entity prefix)')
162	19	->defaultValue('/count');
163
164	19	$criteria = $search->children()->variableNode('criteria');
165	19	$criteria->info(
166	19	'Criteria modifiers. Array will be treated as nested criteria,'.PHP_EOL.
167		'allowing configuring several modifiers by key:value'
168	19	);
169	19	$criteria->defaultValue('cruds.criteria.entity');
170	19	$criteria->example('my.criteria.modifier');
171	19	$criteria->cannotBeEmpty();
172	19	}
173
174	19	private function configureReadAction(ArrayNodeDefinition $parent)
175		{
176		$read = $parent
177	19	->children()
178	19	->arrayNode('read');
179	19	$this->configureActionNode($read, 'get');
180	19	}
181
182	19	private function configureUpdateAction(ArrayNodeDefinition $parent)
183		{
184		$update = $parent
185	19	->children()
186	19	->arrayNode('update');
187
188		$update
189	19	->children()
190	19	->variableNode('processor')
191	19	->defaultNull()
192	19	->example('@my_entity.processor')
193	19	->info(
194	19	'Service ID implementing '.PHP_EOL.
195	19	EntityProcessorInterface::class.PHP_EOL.
196	19	'Defaults to '.PropertyAccessProcessor::class
197	19	);
198
199	19	$this->configureActionNode($update, 'update');
200	19	}
201
202	19	private function configureDeleteAction(ArrayNodeDefinition $parent)
203		{
204		$delete = $parent
205	19	->children()
206	19	->arrayNode('delete');
207	19	$this->configureActionNode($delete, 'delete');
208	19	}
209
210	19	private function configureActionNode(ArrayNodeDefinition $parent, $action)
211		{
212	19	$parent->canBeEnabled();
213
214		$parent
215	19	->children()
216	19	->scalarNode('path')
217	19	->info('Action path (will be prefixed with entity prefix)')
218	19	->defaultValue('/'.$action);
219	19	}
220		}
221

php-rpc / cruds

Pull Request — master (#15)

Configuration::configureEntityProto() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like