Configuration::addResourcesSection() - Code Metrics - Inspection of "Add newsletter provider and fix tests (#1142)" - enhavo/enhavo - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8d6b85...0964b2 )

by Gerhard

created 2021-01-31 08:01 UTC

Configuration::addResourcesSection() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	78
ccs	0
cts	77
cp	0
rs	8.48
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

How to fix Long Method

<?php

namespace Enhavo\Bundle\NewsletterBundle\DependencyInjection;

use Enhavo\Bundle\AppBundle\Controller\ResourceController;
use Enhavo\Bundle\NewsletterBundle\Controller\NewsletterController;
use Enhavo\Bundle\NewsletterBundle\Entity\Group;
use Enhavo\Bundle\NewsletterBundle\Entity\LocalSubscriber;
use Enhavo\Bundle\NewsletterBundle\Entity\Newsletter;
use Enhavo\Bundle\NewsletterBundle\Entity\PendingSubscriber;
use Enhavo\Bundle\NewsletterBundle\Factory\LocalSubscriberFactory;
use Enhavo\Bundle\NewsletterBundle\Factory\NewsletterFactory;
use Enhavo\Bundle\NewsletterBundle\Form\Type\GroupType;
use Enhavo\Bundle\NewsletterBundle\Form\Type\LocalSubscriberType;
use Enhavo\Bundle\NewsletterBundle\Form\Type\NewsletterType;
use Enhavo\Bundle\NewsletterBundle\Form\Type\PendingSubscriberType;
use Enhavo\Bundle\NewsletterBundle\Form\Type\SubscriberType;
use Enhavo\Bundle\NewsletterBundle\Model\Subscriber;
use Enhavo\Bundle\NewsletterBundle\Provider\GroupProvider;
use Enhavo\Bundle\NewsletterBundle\Repository\GroupRepository;
use Enhavo\Bundle\NewsletterBundle\Repository\LocalSubscriberRepository;
use Enhavo\Bundle\NewsletterBundle\Repository\NewsletterRepository;
use Enhavo\Bundle\NewsletterBundle\Repository\PendingSubscriberRepository;
use Sylius\Component\Resource\Factory\Factory;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * This is the class that validates and merges configuration from your app/config files
 *
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder('enhavo_newsletter');
        $rootNode = $treeBuilder->getRootNode();

        $this->addResourcesSection($rootNode);

        $this->addNewsletterSection($rootNode);


        return $treeBuilder;
    }

    private function addNewsletterSection(ArrayNodeDefinition $node)
    {
        $node
            ->children()
                ->arrayNode('newsletter')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('provider')->defaultValue(GroupProvider::class)->end()
                        ->arrayNode('test_receiver')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->scalarNode('token')->defaultValue('__tracking_token__')->end()
                                ->arrayNode('parameters')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('firstname')->defaultValue('Max')->end()
                                        ->scalarNode('lastname')->defaultValue('Pattern')->end()
                                        ->scalarNode('token')->defaultValue('__id_token__')->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('mail')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->scalarNode('from')->end()
                            ->end()
                        ->end()
                        ->arrayNode('templates')
                            ->useAttributeAsKey('key')
                            ->prototype('array')
                                ->children()
                                    ->variableNode('template')->end()
                                    ->variableNode('label')->end()
                                    ->variableNode('translation_domain')->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('subscription')
                    ->arrayPrototype()
                        ->children()
                            ->variableNode('strategy')->end()
                            ->variableNode('storage')->end()
                            ->scalarNode('template')->defaultValue('EnhavoNewsletterBundle:mail/newsletter/template:default.html.twig')->end()
                            ->scalarNode('model')->defaultValue(Subscriber::class)->end()
                            ->arrayNode('form')
                                ->addDefaultsIfNotSet()
                                ->children()
                                    ->variableNode('class')->defaultValue(SubscriberType::class)->end()
                                    ->variableNode('template')->defaultValue('EnhavoNewsletterBundle:theme/resource/subscriber:subscribe.html.twig')->end()
                                    ->variableNode('options')->defaultValue([])->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ->end()
        ;
    }

    private function addResourcesSection(ArrayNodeDefinition $node)
    {
        $node
            ->children()
                ->scalarNode('driver')->defaultValue('doctrine/orm')->end()
                ->arrayNode('resources')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->arrayNode('newsletter')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->variableNode('options')->end()
                                ->arrayNode('classes')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('model')->defaultValue(Newsletter::class)->end()
                                        ->scalarNode('controller')->defaultValue(NewsletterController::class)->end()
                                        ->scalarNode('repository')->defaultValue(NewsletterRepository::class)->end()
                                        ->scalarNode('factory')->defaultValue(NewsletterFactory::class)->end()
                                        ->scalarNode('form')->defaultValue(NewsletterType::class)->cannotBeEmpty()->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('local_subscriber')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->variableNode('options')->end()
                                ->arrayNode('classes')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('model')->defaultValue(LocalSubscriber::class)->end()
                                        ->scalarNode('controller')->defaultValue(ResourceController::class)->end()
                                        ->scalarNode('repository')->defaultValue(LocalSubscriberRepository::class)->end()
                                        ->scalarNode('factory')->defaultValue(LocalSubscriberFactory::class)->end()
                                        ->scalarNode('form')->defaultValue(LocalSubscriberType::class)->cannotBeEmpty()->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('pending_subscriber')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->variableNode('options')->end()
                                ->arrayNode('classes')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('model')->defaultValue(PendingSubscriber::class)->end()
                                        ->scalarNode('controller')->defaultValue(ResourceController::class)->end()
                                        ->scalarNode('repository')->defaultValue(PendingSubscriberRepository::class)->end()
                                        ->scalarNode('factory')->defaultValue(Factory::class)->end()
                                        ->scalarNode('form')->defaultValue(PendingSubscriberType::class)->cannotBeEmpty()->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()

                        ->arrayNode('group')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->variableNode('options')->end()
                                ->arrayNode('classes')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('model')->defaultValue(Group::class)->end()
                                        ->scalarNode('controller')->defaultValue(ResourceController::class)->end()
                                        ->scalarNode('repository')->defaultValue(GroupRepository::class)->end()
                                        ->scalarNode('factory')->defaultValue(Factory::class)->end()
                                        ->scalarNode('form')->defaultValue(GroupType::class)->cannotBeEmpty()->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ;
    }
}


1			<?php
2
3			namespace Enhavo\Bundle\NewsletterBundle\DependencyInjection;
4
5			use Enhavo\Bundle\AppBundle\Controller\ResourceController;
6			use Enhavo\Bundle\NewsletterBundle\Controller\NewsletterController;
7			use Enhavo\Bundle\NewsletterBundle\Entity\Group;
8			use Enhavo\Bundle\NewsletterBundle\Entity\LocalSubscriber;
9			use Enhavo\Bundle\NewsletterBundle\Entity\Newsletter;
10			use Enhavo\Bundle\NewsletterBundle\Entity\PendingSubscriber;
11			use Enhavo\Bundle\NewsletterBundle\Factory\LocalSubscriberFactory;
12			use Enhavo\Bundle\NewsletterBundle\Factory\NewsletterFactory;
13			use Enhavo\Bundle\NewsletterBundle\Form\Type\GroupType;
14			use Enhavo\Bundle\NewsletterBundle\Form\Type\LocalSubscriberType;
15			use Enhavo\Bundle\NewsletterBundle\Form\Type\NewsletterType;
16			use Enhavo\Bundle\NewsletterBundle\Form\Type\PendingSubscriberType;
17			use Enhavo\Bundle\NewsletterBundle\Form\Type\SubscriberType;
18			use Enhavo\Bundle\NewsletterBundle\Model\Subscriber;
19			use Enhavo\Bundle\NewsletterBundle\Provider\GroupProvider;
20			use Enhavo\Bundle\NewsletterBundle\Repository\GroupRepository;
21			use Enhavo\Bundle\NewsletterBundle\Repository\LocalSubscriberRepository;
22			use Enhavo\Bundle\NewsletterBundle\Repository\NewsletterRepository;
23			use Enhavo\Bundle\NewsletterBundle\Repository\PendingSubscriberRepository;
24			use Sylius\Component\Resource\Factory\Factory;
25			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
26			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
27			use Symfony\Component\Config\Definition\ConfigurationInterface;
28
29			/**
30			* This is the class that validates and merges configuration from your app/config files
31			*
32			* To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
33			*/
34			class Configuration implements ConfigurationInterface
35			{
36			/**
37			* {@inheritdoc}
38			*/
39			public function getConfigTreeBuilder()
40			{
41			$treeBuilder = new TreeBuilder('enhavo_newsletter');
42			$rootNode = $treeBuilder->getRootNode();
43
44			$this->addResourcesSection($rootNode);
			0 ignored issues – show Compatibility introduced 2021-01-31 08:10 UTC by Report Bug Copy Issue Report `$rootNode` of type `object<Symfony\Component...Builder\NodeDefinition>` is not a sub-type of `object<Symfony\Component...er\ArrayNodeDefinition>`. It seems like you assume a child class of the class `Symfony\Component\Config...\Builder\NodeDefinition` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
45			$this->addNewsletterSection($rootNode);
			0 ignored issues – show Compatibility introduced 2021-01-31 08:10 UTC by Report Bug Copy Issue Report `$rootNode` of type `object<Symfony\Component...Builder\NodeDefinition>` is not a sub-type of `object<Symfony\Component...er\ArrayNodeDefinition>`. It seems like you assume a child class of the class `Symfony\Component\Config...\Builder\NodeDefinition` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
46
47			return $treeBuilder;
48			}
49
50			private function addNewsletterSection(ArrayNodeDefinition $node)
51			{
52			$node
53			->children()
54			->arrayNode('newsletter')
55			->addDefaultsIfNotSet()
56			->children()
57			->scalarNode('provider')->defaultValue(GroupProvider::class)->end()
58			->arrayNode('test_receiver')
59			->addDefaultsIfNotSet()
60			->children()
61			->scalarNode('token')->defaultValue('__tracking_token__')->end()
62			->arrayNode('parameters')
63			->addDefaultsIfNotSet()
64			->children()
65			->scalarNode('firstname')->defaultValue('Max')->end()
66			->scalarNode('lastname')->defaultValue('Pattern')->end()
67			->scalarNode('token')->defaultValue('__id_token__')->end()
68			->end()
69			->end()
70			->end()
71			->end()
72			->arrayNode('mail')
73			->addDefaultsIfNotSet()
74			->children()
75			->scalarNode('from')->end()
76			->end()
77			->end()
78			->arrayNode('templates')
79			->useAttributeAsKey('key')
80			->prototype('array')
81			->children()
82			->variableNode('template')->end()
83			->variableNode('label')->end()
84			->variableNode('translation_domain')->end()
85			->end()
86			->end()
87			->end()
88			->end()
89			->end()
90			->arrayNode('subscription')
91			->arrayPrototype()
92			->children()
93			->variableNode('strategy')->end()
94			->variableNode('storage')->end()
95			->scalarNode('template')->defaultValue('EnhavoNewsletterBundle:mail/newsletter/template:default.html.twig')->end()
96			->scalarNode('model')->defaultValue(Subscriber::class)->end()
97			->arrayNode('form')
98			->addDefaultsIfNotSet()
99			->children()
100			->variableNode('class')->defaultValue(SubscriberType::class)->end()
101			->variableNode('template')->defaultValue('EnhavoNewsletterBundle:theme/resource/subscriber:subscribe.html.twig')->end()
102			->variableNode('options')->defaultValue([])->end()
103			->end()
104			->end()
105			->end()
106			->end()
107			->end()
108			->end()
109			->end()
110			;
111			}
112
113			private function addResourcesSection(ArrayNodeDefinition $node)
114			{
115			$node
116			->children()
117			->scalarNode('driver')->defaultValue('doctrine/orm')->end()
118			->arrayNode('resources')
119			->addDefaultsIfNotSet()
120			->children()
121			->arrayNode('newsletter')
122			->addDefaultsIfNotSet()
123			->children()
124			->variableNode('options')->end()
125			->arrayNode('classes')
126			->addDefaultsIfNotSet()
127			->children()
128			->scalarNode('model')->defaultValue(Newsletter::class)->end()
129			->scalarNode('controller')->defaultValue(NewsletterController::class)->end()
130			->scalarNode('repository')->defaultValue(NewsletterRepository::class)->end()
131			->scalarNode('factory')->defaultValue(NewsletterFactory::class)->end()
132			->scalarNode('form')->defaultValue(NewsletterType::class)->cannotBeEmpty()->end()
133			->end()
134			->end()
135			->end()
136			->end()
137			->arrayNode('local_subscriber')
138			->addDefaultsIfNotSet()
139			->children()
140			->variableNode('options')->end()
141			->arrayNode('classes')
142			->addDefaultsIfNotSet()
143			->children()
144			->scalarNode('model')->defaultValue(LocalSubscriber::class)->end()
145			->scalarNode('controller')->defaultValue(ResourceController::class)->end()
146			->scalarNode('repository')->defaultValue(LocalSubscriberRepository::class)->end()
147			->scalarNode('factory')->defaultValue(LocalSubscriberFactory::class)->end()
148			->scalarNode('form')->defaultValue(LocalSubscriberType::class)->cannotBeEmpty()->end()
149			->end()
150			->end()
151			->end()
152			->end()
153			->arrayNode('pending_subscriber')
154			->addDefaultsIfNotSet()
155			->children()
156			->variableNode('options')->end()
157			->arrayNode('classes')
158			->addDefaultsIfNotSet()
159			->children()
160			->scalarNode('model')->defaultValue(PendingSubscriber::class)->end()
161			->scalarNode('controller')->defaultValue(ResourceController::class)->end()
162			->scalarNode('repository')->defaultValue(PendingSubscriberRepository::class)->end()
163			->scalarNode('factory')->defaultValue(Factory::class)->end()
164			->scalarNode('form')->defaultValue(PendingSubscriberType::class)->cannotBeEmpty()->end()
165			->end()
166			->end()
167			->end()
168			->end()
169
170			->arrayNode('group')
171			->addDefaultsIfNotSet()
172			->children()
173			->variableNode('options')->end()
174			->arrayNode('classes')
175			->addDefaultsIfNotSet()
176			->children()
177			->scalarNode('model')->defaultValue(Group::class)->end()
178			->scalarNode('controller')->defaultValue(ResourceController::class)->end()
179			->scalarNode('repository')->defaultValue(GroupRepository::class)->end()
180			->scalarNode('factory')->defaultValue(Factory::class)->end()
181			->scalarNode('form')->defaultValue(GroupType::class)->cannotBeEmpty()->end()
182			->end()
183			->end()
184			->end()
185			->end()
186			->end()
187			->end()
188			->end()
189			;
190			}
191			}
192

enhavo / enhavo

Push — master ( 8d6b85...0964b2 )

Configuration::addResourcesSection() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like