SilverbackApiComponentsExtension - Code Metrics - Inspection of "Doctrine Ramsay Uuid Update" - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 80e8d3...7b53d1 )

by Daniel

created 2020-05-06 12:10 UTC

SilverbackApiComponentsExtension A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
eloc	109
dl	0
loc	185
ccs	99
cts	99
cp	1
rs	10
c	0
b	0
f	0
wmc	14

8 Methods

Rating	Name	Size	Complexity
A	setUserClassArguments()	13	1
A	loadServiceConfig()	10	1
A	prependDoctrineConfiguration()	9	1
A	setMailerServiceArguments()	33	4
A	prependApiAPlatformConfig()	37	3
A	load()	40	2
A	prepend()	7	1
A	setEmailVerificationArguments()	9	1

<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentsBundle\DependencyInjection;

use Exception;
use Ramsey\Uuid\Doctrine\UuidBinaryOrderedTimeType;
use Silverback\ApiComponentsBundle\AnnotationReader\UploadableAnnotationReader;
use Silverback\ApiComponentsBundle\Doctrine\Extension\ORM\TablePrefixExtension;
use Silverback\ApiComponentsBundle\Entity\Core\ComponentInterface;
use Silverback\ApiComponentsBundle\EventListener\Doctrine\UserListener;
use Silverback\ApiComponentsBundle\Factory\Mailer\User\ChangeEmailVerificationEmailFactory;
use Silverback\ApiComponentsBundle\Factory\Mailer\User\PasswordChangedEmailFactory;
use Silverback\ApiComponentsBundle\Factory\Mailer\User\PasswordResetEmailFactory;
use Silverback\ApiComponentsBundle\Factory\Mailer\User\UserEnabledEmailFactory;
use Silverback\ApiComponentsBundle\Factory\Mailer\User\UsernameChangedEmailFactory;
use Silverback\ApiComponentsBundle\Factory\Mailer\User\WelcomeEmailFactory;
use Silverback\ApiComponentsBundle\Factory\Uploadable\MediaObjectFactory;
use Silverback\ApiComponentsBundle\Factory\User\UserFactory;
use Silverback\ApiComponentsBundle\Form\FormTypeInterface;
use Silverback\ApiComponentsBundle\Form\Type\User\ChangePasswordType;
use Silverback\ApiComponentsBundle\Form\Type\User\NewEmailAddressType;
use Silverback\ApiComponentsBundle\Form\Type\User\UserRegisterType;
use Silverback\ApiComponentsBundle\Helper\Publishable\PublishableHelper;
use Silverback\ApiComponentsBundle\Helper\Uploadable\UploadableHelper;
use Silverback\ApiComponentsBundle\Mailer\UserMailer;
use Silverback\ApiComponentsBundle\Manager\User\PasswordManager;
use Silverback\ApiComponentsBundle\Repository\User\UserRepository;
use Silverback\ApiComponentsBundle\Security\TokenAuthenticator;
use Silverback\ApiComponentsBundle\Security\UserChecker;
use Silverback\ApiComponentsBundle\Serializer\Normalizer\MetadataNormalizer;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
use Symfony\Component\DependencyInjection\Reference;

/**
 * @author Daniel West <[email protected]>
 */
class SilverbackApiComponentsExtension extends Extension implements PrependExtensionInterface
{
    /**
     * @throws Exception
     */
    public function load(array $configs, ContainerBuilder $container): void
    {
        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);

        $this->loadServiceConfig($container);

        $definition = $container->getDefinition(TablePrefixExtension::class);
        $definition->setArgument('$prefix', $config['table_prefix']);

        $definition = $container->getDefinition(TokenAuthenticator::class);
        $definition->setArgument('$tokens', $config['security']['tokens']);

        $definition = $container->getDefinition(PasswordManager::class);
        $definition->setArgument('$tokenTtl', $config['user']['password_reset']['repeat_ttl_seconds']);

        $definition = $container->getDefinition(UserRepository::class);
        $definition->setArgument('$passwordRequestTimeout', $config['user']['password_reset']['request_timeout_seconds']);
        $definition->setArgument('$entityClass', $config['user']['class_name']);

        $definition = $container->getDefinition(PublishableHelper::class);
        $definition->setArgument('$permission', $config['publishable']['permission']);

        $definition = $container->getDefinition(MetadataNormalizer::class);
        $definition->setArgument('$metadataKey', $config['metadata_key']);

        $this->setEmailVerificationArguments($container, $config['user']['email_verification']);
        $this->setUserClassArguments($container, $config['user']['class_name']);
        $this->setMailerServiceArguments($container, $config);

        $imagineEnabled = $container->getParameter('api_component.imagine_enabled');
        $definition = $container->getDefinition(UploadableAnnotationReader::class);
        $definition->setArgument('$imagineBundleEnabled', $imagineEnabled);

        if ($imagineEnabled) {
            $definition = $container->getDefinition(UploadableHelper::class);
            $definition->setArgument('$filterService', new Reference('liip_imagine.service.filter'));

            $definition = $container->getDefinition(MediaObjectFactory::class);
            $definition->setArgument('$filterService', new Reference('liip_imagine.service.filter'));
        }
    }

    private function setEmailVerificationArguments(ContainerBuilder $container, array $emailVerificationConfig): void
    {
        $definition = $container->getDefinition(UserChecker::class);
        $definition->setArgument('$denyUnverifiedLogin', $emailVerificationConfig['deny_unverified_login']);

        $definition = $container->getDefinition(UserListener::class);
        $definition->setArgument('$initialEmailVerifiedState', $emailVerificationConfig['default_value']);
        $definition->setArgument('$verifyEmailOnRegister', $emailVerificationConfig['verify_on_register']);
        $definition->setArgument('$verifyEmailOnChange', $emailVerificationConfig['verify_on_change']);
    }

    private function setUserClassArguments(ContainerBuilder $container, string $userClass): void
    {
        $definition = $container->getDefinition(UserFactory::class);
        $definition->setArgument('$userClass', $userClass);

        $definition = $container->getDefinition(ChangePasswordType::class);
        $definition->setArgument('$userClass', $userClass);

        $definition = $container->getDefinition(NewEmailAddressType::class);
        $definition->setArgument('$userClass', $userClass);

        $definition = $container->getDefinition(UserRegisterType::class);
        $definition->setArgument('$userClass', $userClass);
    }

    private function setMailerServiceArguments(ContainerBuilder $container, array $config): void
    {
        $definition = $container->getDefinition(UserMailer::class);
        $definition->setArgument('$context', [
            'website_name' => $config['website_name'],
        ]);

        $mapping = [
            PasswordChangedEmailFactory::class => 'password_changed',
            UserEnabledEmailFactory::class => 'user_enabled',
            UsernameChangedEmailFactory::class => 'username_changed',
            WelcomeEmailFactory::class => 'welcome',
        ];
        foreach ($mapping as $class => $key) {
            $definition = $container->getDefinition($class);
            $definition->setArgument('$subject', $config['user']['emails'][$key]['subject']);
            $definition->setArgument('$enabled', $config['user']['emails'][$key]['enabled']);
            if (WelcomeEmailFactory::class === $class) {
                $definition->setArgument('$defaultRedirectPath', $config['user']['email_verification']['email']['default_redirect_path']);
                $definition->setArgument('$redirectPathQueryKey', $config['user']['email_verification']['email']['redirect_path_query']);
            }
        }

        $mapping = [
            ChangeEmailVerificationEmailFactory::class => 'email_verification',
            PasswordResetEmailFactory::class => 'password_reset',
        ];
        foreach ($mapping as $class => $key) {
            $definition = $container->getDefinition($class);
            $definition->setArgument('$subject', $config['user'][$key]['email']['subject']);
            $definition->setArgument('$enabled', true);
            $definition->setArgument('$defaultRedirectPath', $config['user'][$key]['email']['default_redirect_path']);
            $definition->setArgument('$redirectPathQueryKey', $config['user'][$key]['email']['redirect_path_query']);
        }
    }

    /**
     * @throws Exception
     */
    private function loadServiceConfig(ContainerBuilder $container): void
    {
        $container->registerForAutoconfiguration(FormTypeInterface::class)
            ->addTag('silverback_api_components.form_type');

        $container->registerForAutoconfiguration(ComponentInterface::class)
            ->addTag('silverback_api_components.entity.component');

        $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
        $loader->load('services.php');
    }

    public function prepend(ContainerBuilder $container): void
    {
        $configs = $container->getExtensionConfig($this->getAlias());
        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);
        $this->prependApiAPlatformConfig($container, $config);
        $this->prependDoctrineConfiguration($container);
    }

    private function prependDoctrineConfiguration(ContainerBuilder $container): void
    {
        $container->prependExtensionConfig('doctrine', [
            'dbal' => [
                'types' => [
                    'uuid_binary_ordered_time' => UuidBinaryOrderedTimeType::class,
                ],
                'mapping_types' => [
                    'uuid_binary_ordered_time' => 'binary',
                ],
            ],
        ]);
    }

    private function prependApiAPlatformConfig(ContainerBuilder $container, array $config): void
    {
        $srcBase = __DIR__ . '/..';
        $configBasePath = $srcBase . '/Resources/config/api_platform';

        $mappingPaths = [$srcBase . '/Entity/Core'];
        $mappingPaths[] = sprintf('%s/%s.xml', $configBasePath, 'uploadable');
        foreach ($config['enabled_components'] as $key => $enabled_component) {
            if (true === $enabled_component) {
                $mappingPaths[] = sprintf('%s/%s.xml', $configBasePath, $key);
            }
        }

        $websiteName = $config['website_name'];

        $container->prependExtensionConfig('api_platform', [
            'title' => $websiteName,
            'description' => sprintf('API for %s', $websiteName),
            'collection' => [
                'pagination' => [
                    'client_items_per_page' => true,
                    'items_per_page_parameter_name' => 'perPage',
                    'maximum_items_per_page' => 100,
                ],
            ],
            'mapping' => [
                'paths' => $mappingPaths,
            ],
            'swagger' => [
                'api_keys' => [
                    'API Token' => [
                        'name' => 'X-AUTH-TOKEN',
                        'type' => 'header',
                    ],
                    'JWT (use prefix `Bearer`)' => [
                        'name' => 'Authorization',
                        'type' => 'header',
                    ],
                ],
            ],
        ]);
    }
}


1		<?php
2
3		/*
4		* This file is part of the Silverback API Components Bundle Project
5		*
6		* (c) Daniel West <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		declare(strict_types=1);
13
14		namespace Silverback\ApiComponentsBundle\DependencyInjection;
15
16		use Exception;
17		use Ramsey\Uuid\Doctrine\UuidBinaryOrderedTimeType;
18		use Silverback\ApiComponentsBundle\AnnotationReader\UploadableAnnotationReader;
19		use Silverback\ApiComponentsBundle\Doctrine\Extension\ORM\TablePrefixExtension;
20		use Silverback\ApiComponentsBundle\Entity\Core\ComponentInterface;
21		use Silverback\ApiComponentsBundle\EventListener\Doctrine\UserListener;
22		use Silverback\ApiComponentsBundle\Factory\Mailer\User\ChangeEmailVerificationEmailFactory;
23		use Silverback\ApiComponentsBundle\Factory\Mailer\User\PasswordChangedEmailFactory;
24		use Silverback\ApiComponentsBundle\Factory\Mailer\User\PasswordResetEmailFactory;
25		use Silverback\ApiComponentsBundle\Factory\Mailer\User\UserEnabledEmailFactory;
26		use Silverback\ApiComponentsBundle\Factory\Mailer\User\UsernameChangedEmailFactory;
27		use Silverback\ApiComponentsBundle\Factory\Mailer\User\WelcomeEmailFactory;
28		use Silverback\ApiComponentsBundle\Factory\Uploadable\MediaObjectFactory;
29		use Silverback\ApiComponentsBundle\Factory\User\UserFactory;
30		use Silverback\ApiComponentsBundle\Form\FormTypeInterface;
31		use Silverback\ApiComponentsBundle\Form\Type\User\ChangePasswordType;
32		use Silverback\ApiComponentsBundle\Form\Type\User\NewEmailAddressType;
33		use Silverback\ApiComponentsBundle\Form\Type\User\UserRegisterType;
34		use Silverback\ApiComponentsBundle\Helper\Publishable\PublishableHelper;
35		use Silverback\ApiComponentsBundle\Helper\Uploadable\UploadableHelper;
36		use Silverback\ApiComponentsBundle\Mailer\UserMailer;
37		use Silverback\ApiComponentsBundle\Manager\User\PasswordManager;
38		use Silverback\ApiComponentsBundle\Repository\User\UserRepository;
39		use Silverback\ApiComponentsBundle\Security\TokenAuthenticator;
40		use Silverback\ApiComponentsBundle\Security\UserChecker;
41		use Silverback\ApiComponentsBundle\Serializer\Normalizer\MetadataNormalizer;
42		use Symfony\Component\Config\FileLocator;
43		use Symfony\Component\DependencyInjection\ContainerBuilder;
44		use Symfony\Component\DependencyInjection\Extension\Extension;
45		use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
46		use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
47		use Symfony\Component\DependencyInjection\Reference;
48
49		/**
50		* @author Daniel West <[email protected]>
51		*/
52		class SilverbackApiComponentsExtension extends Extension implements PrependExtensionInterface
53		{
54		/**
55		* @throws Exception
56		*/
57	1	public function load(array $configs, ContainerBuilder $container): void
58		{
59	1	$configuration = new Configuration();
60	1	$config = $this->processConfiguration($configuration, $configs);
61
62	1	$this->loadServiceConfig($container);
63
64	1	$definition = $container->getDefinition(TablePrefixExtension::class);
65	1	$definition->setArgument('$prefix', $config['table_prefix']);
66
67	1	$definition = $container->getDefinition(TokenAuthenticator::class);
68	1	$definition->setArgument('$tokens', $config['security']['tokens']);
69
70	1	$definition = $container->getDefinition(PasswordManager::class);
71	1	$definition->setArgument('$tokenTtl', $config['user']['password_reset']['repeat_ttl_seconds']);
72
73	1	$definition = $container->getDefinition(UserRepository::class);
74	1	$definition->setArgument('$passwordRequestTimeout', $config['user']['password_reset']['request_timeout_seconds']);
75	1	$definition->setArgument('$entityClass', $config['user']['class_name']);
76
77	1	$definition = $container->getDefinition(PublishableHelper::class);
78	1	$definition->setArgument('$permission', $config['publishable']['permission']);
79
80	1	$definition = $container->getDefinition(MetadataNormalizer::class);
81	1	$definition->setArgument('$metadataKey', $config['metadata_key']);
82
83	1	$this->setEmailVerificationArguments($container, $config['user']['email_verification']);
84	1	$this->setUserClassArguments($container, $config['user']['class_name']);
85	1	$this->setMailerServiceArguments($container, $config);
86
87	1	$imagineEnabled = $container->getParameter('api_component.imagine_enabled');
88	1	$definition = $container->getDefinition(UploadableAnnotationReader::class);
89	1	$definition->setArgument('$imagineBundleEnabled', $imagineEnabled);
90
91	1	if ($imagineEnabled) {
92	1	$definition = $container->getDefinition(UploadableHelper::class);
93	1	$definition->setArgument('$filterService', new Reference('liip_imagine.service.filter'));
94
95	1	$definition = $container->getDefinition(MediaObjectFactory::class);
96	1	$definition->setArgument('$filterService', new Reference('liip_imagine.service.filter'));
97		}
98	1	}
99
100	1	private function setEmailVerificationArguments(ContainerBuilder $container, array $emailVerificationConfig): void
101		{
102	1	$definition = $container->getDefinition(UserChecker::class);
103	1	$definition->setArgument('$denyUnverifiedLogin', $emailVerificationConfig['deny_unverified_login']);
104
105	1	$definition = $container->getDefinition(UserListener::class);
106	1	$definition->setArgument('$initialEmailVerifiedState', $emailVerificationConfig['default_value']);
107	1	$definition->setArgument('$verifyEmailOnRegister', $emailVerificationConfig['verify_on_register']);
108	1	$definition->setArgument('$verifyEmailOnChange', $emailVerificationConfig['verify_on_change']);
109	1	}
110
111	1	private function setUserClassArguments(ContainerBuilder $container, string $userClass): void
112		{
113	1	$definition = $container->getDefinition(UserFactory::class);
114	1	$definition->setArgument('$userClass', $userClass);
115
116	1	$definition = $container->getDefinition(ChangePasswordType::class);
117	1	$definition->setArgument('$userClass', $userClass);
118
119	1	$definition = $container->getDefinition(NewEmailAddressType::class);
120	1	$definition->setArgument('$userClass', $userClass);
121
122	1	$definition = $container->getDefinition(UserRegisterType::class);
123	1	$definition->setArgument('$userClass', $userClass);
124	1	}
125
126	1	private function setMailerServiceArguments(ContainerBuilder $container, array $config): void
127		{
128	1	$definition = $container->getDefinition(UserMailer::class);
129	1	$definition->setArgument('$context', [
130	1	'website_name' => $config['website_name'],
131		]);
132
133		$mapping = [
134	1	PasswordChangedEmailFactory::class => 'password_changed',
135		UserEnabledEmailFactory::class => 'user_enabled',
136		UsernameChangedEmailFactory::class => 'username_changed',
137		WelcomeEmailFactory::class => 'welcome',
138		];
139	1	foreach ($mapping as $class => $key) {
140	1	$definition = $container->getDefinition($class);
141	1	$definition->setArgument('$subject', $config['user']['emails'][$key]['subject']);
142	1	$definition->setArgument('$enabled', $config['user']['emails'][$key]['enabled']);
143	1	if (WelcomeEmailFactory::class === $class) {
144	1	$definition->setArgument('$defaultRedirectPath', $config['user']['email_verification']['email']['default_redirect_path']);
145	1	$definition->setArgument('$redirectPathQueryKey', $config['user']['email_verification']['email']['redirect_path_query']);
146		}
147		}
148
149		$mapping = [
150	1	ChangeEmailVerificationEmailFactory::class => 'email_verification',
151		PasswordResetEmailFactory::class => 'password_reset',
152		];
153	1	foreach ($mapping as $class => $key) {
154	1	$definition = $container->getDefinition($class);
155	1	$definition->setArgument('$subject', $config['user'][$key]['email']['subject']);
156	1	$definition->setArgument('$enabled', true);
157	1	$definition->setArgument('$defaultRedirectPath', $config['user'][$key]['email']['default_redirect_path']);
158	1	$definition->setArgument('$redirectPathQueryKey', $config['user'][$key]['email']['redirect_path_query']);
159		}
160	1	}
161
162		/**
163		* @throws Exception
164		*/
165	1	private function loadServiceConfig(ContainerBuilder $container): void
166		{
167	1	$container->registerForAutoconfiguration(FormTypeInterface::class)
168	1	->addTag('silverback_api_components.form_type');
169
170	1	$container->registerForAutoconfiguration(ComponentInterface::class)
171	1	->addTag('silverback_api_components.entity.component');
172
173	1	$loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
174	1	$loader->load('services.php');
175	1	}
176
177	1	public function prepend(ContainerBuilder $container): void
178		{
179	1	$configs = $container->getExtensionConfig($this->getAlias());
180	1	$configuration = new Configuration();
181	1	$config = $this->processConfiguration($configuration, $configs);
182	1	$this->prependApiAPlatformConfig($container, $config);
183	1	$this->prependDoctrineConfiguration($container);
184	1	}
185
186	1	private function prependDoctrineConfiguration(ContainerBuilder $container): void
187		{
188	1	$container->prependExtensionConfig('doctrine', [
189		'dbal' => [
190		'types' => [
191	1	'uuid_binary_ordered_time' => UuidBinaryOrderedTimeType::class,
192		],
193		'mapping_types' => [
194		'uuid_binary_ordered_time' => 'binary',
195		],
196		],
197		]);
198	1	}
199
200	1	private function prependApiAPlatformConfig(ContainerBuilder $container, array $config): void
201		{
202	1	$srcBase = __DIR__ . '/..';
203	1	$configBasePath = $srcBase . '/Resources/config/api_platform';
204
205	1	$mappingPaths = [$srcBase . '/Entity/Core'];
206	1	$mappingPaths[] = sprintf('%s/%s.xml', $configBasePath, 'uploadable');
207	1	foreach ($config['enabled_components'] as $key => $enabled_component) {
208	1	if (true === $enabled_component) {
209	1	$mappingPaths[] = sprintf('%s/%s.xml', $configBasePath, $key);
210		}
211		}
212
213	1	$websiteName = $config['website_name'];
214
215	1	$container->prependExtensionConfig('api_platform', [
216	1	'title' => $websiteName,
217	1	'description' => sprintf('API for %s', $websiteName),
218		'collection' => [
219		'pagination' => [
220		'client_items_per_page' => true,
221		'items_per_page_parameter_name' => 'perPage',
222		'maximum_items_per_page' => 100,
223		],
224		],
225		'mapping' => [
226	1	'paths' => $mappingPaths,
227		],
228		'swagger' => [
229		'api_keys' => [
230		'API Token' => [
231		'name' => 'X-AUTH-TOKEN',
232		'type' => 'header',
233		],
234		'JWT (use prefix `Bearer`)' => [
235		'name' => 'Authorization',
236		'type' => 'header',
237		],
238		],
239		],
240		]);
241	1	}
242		}
243

components-web-app / api-components-bundle

Push — master ( 80e8d3...7b53d1 )

SilverbackApiComponentsExtension A

Complexity

Size/Duplication

Test Coverage

Importance

8 Methods

Duplication Side-by-Side

Filter issues like