SilverbackApiComponentExtension::prepend() - Code Metrics - Inspection of "Implement MetadataNormalizer (#49)" - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/publishable ( ce6968...c26268 )

by Daniel

created 2020-04-28 14:35 UTC

SilverbackApiComponentExtension::prepend() A

↳ Parent: SilverbackApiComponentExtension

Complexity

Conditions	4
Paths	6

Size

Total Lines	47
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	4

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	32
c	2
b	0
f	0
dl	0
loc	47
ccs	19
cts	19
cp	1
rs	9.408
cc	4
nc	6
nop	1
crap	4

<?php

/*
 * This file is part of the Silverback API Component 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\ApiComponentBundle\DependencyInjection;

use Exception;
use RuntimeException;
use Silverback\ApiComponentBundle\Entity\Core\ComponentInterface;
use Silverback\ApiComponentBundle\EventListener\Doctrine\UserListener;
use Silverback\ApiComponentBundle\Extension\Doctrine\ORM\TablePrefixExtension;
use Silverback\ApiComponentBundle\Factory\Mailer\User\ChangeEmailVerificationEmailFactory;
use Silverback\ApiComponentBundle\Factory\Mailer\User\PasswordChangedEmailFactory;
use Silverback\ApiComponentBundle\Factory\Mailer\User\PasswordResetEmailFactory;
use Silverback\ApiComponentBundle\Factory\Mailer\User\UserEnabledEmailFactory;
use Silverback\ApiComponentBundle\Factory\Mailer\User\UsernameChangedEmailFactory;
use Silverback\ApiComponentBundle\Factory\Mailer\User\WelcomeEmailFactory;
use Silverback\ApiComponentBundle\Factory\User\UserFactory;
use Silverback\ApiComponentBundle\Form\FormTypeInterface;
use Silverback\ApiComponentBundle\Form\Type\User\ChangePasswordType;
use Silverback\ApiComponentBundle\Form\Type\User\NewEmailAddressType;
use Silverback\ApiComponentBundle\Form\Type\User\UserRegisterType;
use Silverback\ApiComponentBundle\Mailer\UserMailer;
use Silverback\ApiComponentBundle\Manager\User\PasswordManager;
use Silverback\ApiComponentBundle\Publishable\PublishableHelper;
use Silverback\ApiComponentBundle\Repository\User\UserRepository;
use Silverback\ApiComponentBundle\Security\TokenAuthenticator;
use Silverback\ApiComponentBundle\Security\UserChecker;
use Silverback\ApiComponentBundle\Serializer\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;

/**
 * @author Daniel West <[email protected]>
 */
class SilverbackApiComponentExtension 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);
    }

    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_component.form_type');

        $container->registerForAutoconfiguration(ComponentInterface::class)
            ->addTag('silverback_api_component.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);
        $srcBase = __DIR__ . '/..';
        $configBasePath = $srcBase . '/Resources/config/api_platform';
        $mappingPaths = [$srcBase . '/Entity/Core'];
        foreach ($config['enabled_components'] as $key => $enabled_component) {
            if (true === $enabled_component) {
                $mappingPaths[] = sprintf('%s/%s.yaml', $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',
                        ],
                    ],
                ],
            ]
        );

        $bundles = $container->getParameter('kernel.bundles');
        if (isset($bundles['LiipImagineBundle'])) {
            $this->prependLiipConfig($container);
        }
    }

    private function prependLiipConfig(ContainerBuilder $container): void
    {
        $projectDir = $container->getParameter('kernel.project_dir');
        $uploadsDir = $projectDir . '/var/uploads';
        if (!@mkdir($uploadsDir) && !is_dir($uploadsDir)) {
            throw new RuntimeException(sprintf('Directory "%s" was not created', $uploadsDir));
        }
        $container->prependExtensionConfig(
            'liip_imagine',
            [
                'loaders' => [
                    'default' => [
                        'filesystem' => [
                            'data_root' => [
                                'uploads' => $uploadsDir,
                                'default' => $projectDir . '/public',
                            ],
                        ],
                    ],
                ],
                'filter_sets' => [
                    'placeholder_square' => [
                        'jpeg_quality' => 10,
                        'png_compression_level' => 9,
                        'filters' => [
                            'thumbnail' => [
                                'size' => [80, 80],
                                'mode' => 'outbound',
                            ],
                        ],
                    ],
                    'placeholder' => [
                        'jpeg_quality' => 10,
                        'png_compression_level' => 9,
                        'filters' => [
                            'thumbnail' => [
                                'size' => [100, 100],
                                'mode' => 'inset',
                            ],
                        ],
                    ],
                    'thumbnail' => [
                        'jpeg_quality' => 100,
                        'png_compression_level' => 0,
                        'filters' => [
                            'upscale' => [
                                'min' => [636, 636],
                            ],
                            'thumbnail' => [
                                'size' => [636, 636],
                                'mode' => 'inset',
                                'allow_upscale' => true,
                            ],
                        ],
                    ],
                ],
            ]
        );
    }
}


1		<?php
2
3		/*
4		* This file is part of the Silverback API Component 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\ApiComponentBundle\DependencyInjection;
15
16		use Exception;
17		use RuntimeException;
18		use Silverback\ApiComponentBundle\Entity\Core\ComponentInterface;
19		use Silverback\ApiComponentBundle\EventListener\Doctrine\UserListener;
20		use Silverback\ApiComponentBundle\Extension\Doctrine\ORM\TablePrefixExtension;
21		use Silverback\ApiComponentBundle\Factory\Mailer\User\ChangeEmailVerificationEmailFactory;
22		use Silverback\ApiComponentBundle\Factory\Mailer\User\PasswordChangedEmailFactory;
23		use Silverback\ApiComponentBundle\Factory\Mailer\User\PasswordResetEmailFactory;
24		use Silverback\ApiComponentBundle\Factory\Mailer\User\UserEnabledEmailFactory;
25		use Silverback\ApiComponentBundle\Factory\Mailer\User\UsernameChangedEmailFactory;
26		use Silverback\ApiComponentBundle\Factory\Mailer\User\WelcomeEmailFactory;
27		use Silverback\ApiComponentBundle\Factory\User\UserFactory;
28		use Silverback\ApiComponentBundle\Form\FormTypeInterface;
29		use Silverback\ApiComponentBundle\Form\Type\User\ChangePasswordType;
30		use Silverback\ApiComponentBundle\Form\Type\User\NewEmailAddressType;
31		use Silverback\ApiComponentBundle\Form\Type\User\UserRegisterType;
32		use Silverback\ApiComponentBundle\Mailer\UserMailer;
33		use Silverback\ApiComponentBundle\Manager\User\PasswordManager;
34		use Silverback\ApiComponentBundle\Publishable\PublishableHelper;
35		use Silverback\ApiComponentBundle\Repository\User\UserRepository;
36		use Silverback\ApiComponentBundle\Security\TokenAuthenticator;
37		use Silverback\ApiComponentBundle\Security\UserChecker;
38		use Silverback\ApiComponentBundle\Serializer\MetadataNormalizer;
39		use Symfony\Component\Config\FileLocator;
40		use Symfony\Component\DependencyInjection\ContainerBuilder;
41		use Symfony\Component\DependencyInjection\Extension\Extension;
42		use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
43		use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
44
45		/**
46		* @author Daniel West <[email protected]>
47		*/
48		class SilverbackApiComponentExtension extends Extension implements PrependExtensionInterface
49		{
50		/**
51		* @throws Exception
52		*/
53	1	public function load(array $configs, ContainerBuilder $container): void
54		{
55	1	$configuration = new Configuration();
56	1	$config = $this->processConfiguration($configuration, $configs);
57
58	1	$this->loadServiceConfig($container);
59
60	1	$definition = $container->getDefinition(TablePrefixExtension::class);
61	1	$definition->setArgument('$prefix', $config['table_prefix']);
62
63	1	$definition = $container->getDefinition(TokenAuthenticator::class);
64	1	$definition->setArgument('$tokens', $config['security']['tokens']);
65
66	1	$definition = $container->getDefinition(PasswordManager::class);
67	1	$definition->setArgument('$tokenTtl', $config['user']['password_reset']['repeat_ttl_seconds']);
68
69	1	$definition = $container->getDefinition(UserRepository::class);
70	1	$definition->setArgument('$passwordRequestTimeout', $config['user']['password_reset']['request_timeout_seconds']);
71	1	$definition->setArgument('$entityClass', $config['user']['class_name']);
72
73	1	$definition = $container->getDefinition(PublishableHelper::class);
74	1	$definition->setArgument('$permission', $config['publishable']['permission']);
75
76	1	$definition = $container->getDefinition(MetadataNormalizer::class);
77	1	$definition->setArgument('$metadataKey', $config['metadata_key']);
78
79	1	$this->setEmailVerificationArguments($container, $config['user']['email_verification']);
80	1	$this->setUserClassArguments($container, $config['user']['class_name']);
81	1	$this->setMailerServiceArguments($container, $config);
82	1	}
83
84	1	private function setEmailVerificationArguments(ContainerBuilder $container, array $emailVerificationConfig): void
85		{
86	1	$definition = $container->getDefinition(UserChecker::class);
87	1	$definition->setArgument('$denyUnverifiedLogin', $emailVerificationConfig['deny_unverified_login']);
88
89	1	$definition = $container->getDefinition(UserListener::class);
90	1	$definition->setArgument('$initialEmailVerifiedState', $emailVerificationConfig['default_value']);
91	1	$definition->setArgument('$verifyEmailOnRegister', $emailVerificationConfig['verify_on_register']);
92	1	$definition->setArgument('$verifyEmailOnChange', $emailVerificationConfig['verify_on_change']);
93	1	}
94
95	1	private function setUserClassArguments(ContainerBuilder $container, string $userClass): void
96		{
97	1	$definition = $container->getDefinition(UserFactory::class);
98	1	$definition->setArgument('$userClass', $userClass);
99
100	1	$definition = $container->getDefinition(ChangePasswordType::class);
101	1	$definition->setArgument('$userClass', $userClass);
102
103	1	$definition = $container->getDefinition(NewEmailAddressType::class);
104	1	$definition->setArgument('$userClass', $userClass);
105
106	1	$definition = $container->getDefinition(UserRegisterType::class);
107	1	$definition->setArgument('$userClass', $userClass);
108	1	}
109
110	1	private function setMailerServiceArguments(ContainerBuilder $container, array $config): void
111		{
112	1	$definition = $container->getDefinition(UserMailer::class);
113	1	$definition->setArgument('$context', [
114	1	'website_name' => $config['website_name'],
115		]);
116
117		$mapping = [
118	1	PasswordChangedEmailFactory::class => 'password_changed',
119		UserEnabledEmailFactory::class => 'user_enabled',
120		UsernameChangedEmailFactory::class => 'username_changed',
121		WelcomeEmailFactory::class => 'welcome',
122		];
123	1	foreach ($mapping as $class => $key) {
124	1	$definition = $container->getDefinition($class);
125	1	$definition->setArgument('$subject', $config['user']['emails'][$key]['subject']);
126	1	$definition->setArgument('$enabled', $config['user']['emails'][$key]['enabled']);
127	1	if (WelcomeEmailFactory::class === $class) {
128	1	$definition->setArgument('$defaultRedirectPath', $config['user']['email_verification']['email']['default_redirect_path']);
129	1	$definition->setArgument('$redirectPathQueryKey', $config['user']['email_verification']['email']['redirect_path_query']);
130		}
131		}
132
133		$mapping = [
134	1	ChangeEmailVerificationEmailFactory::class => 'email_verification',
135		PasswordResetEmailFactory::class => 'password_reset',
136		];
137	1	foreach ($mapping as $class => $key) {
138	1	$definition = $container->getDefinition($class);
139	1	$definition->setArgument('$subject', $config['user'][$key]['email']['subject']);
140	1	$definition->setArgument('$enabled', true);
141	1	$definition->setArgument('$defaultRedirectPath', $config['user'][$key]['email']['default_redirect_path']);
142	1	$definition->setArgument('$redirectPathQueryKey', $config['user'][$key]['email']['redirect_path_query']);
143		}
144	1	}
145
146		/**
147		* @throws Exception
148		*/
149	1	private function loadServiceConfig(ContainerBuilder $container): void
150		{
151	1	$container->registerForAutoconfiguration(FormTypeInterface::class)
152	1	->addTag('silverback_api_component.form_type');
153
154	1	$container->registerForAutoconfiguration(ComponentInterface::class)
155	1	->addTag('silverback_api_component.entity.component');
156
157	1	$loader = new PhpFileLoader(
158	1	$container,
159	1	new FileLocator(__DIR__ . '/../Resources/config')
160		);
161	1	$loader->load('services.php');
162	1	}
163
164	1	public function prepend(ContainerBuilder $container): void
165		{
166	1	$configs = $container->getExtensionConfig($this->getAlias());
167	1	$configuration = new Configuration();
168	1	$config = $this->processConfiguration($configuration, $configs);
169	1	$srcBase = __DIR__ . '/..';
170	1	$configBasePath = $srcBase . '/Resources/config/api_platform';
171	1	$mappingPaths = [$srcBase . '/Entity/Core'];
172	1	foreach ($config['enabled_components'] as $key => $enabled_component) {
173	1	if (true === $enabled_component) {
174	1	$mappingPaths[] = sprintf('%s/%s.yaml', $configBasePath, $key);
175		}
176		}
177	1	$websiteName = $config['website_name'];
178	1	$container->prependExtensionConfig(
179	1	'api_platform',
180		[
181	1	'title' => $websiteName,
182	1	'description' => sprintf('API for %s', $websiteName),
183		'collection' => [
184		'pagination' => [
185		'client_items_per_page' => true,
186		'items_per_page_parameter_name' => 'perPage',
187		'maximum_items_per_page' => 100,
188		],
189		],
190		'mapping' => [
191	1	'paths' => $mappingPaths,
192		],
193		'swagger' => [
194		'api_keys' => [
195		'API Token' => [
196		'name' => 'X-AUTH-TOKEN',
197		'type' => 'header',
198		],
199		'JWT (use prefix `Bearer`)' => [
200		'name' => 'Authorization',
201		'type' => 'header',
202		],
203		],
204		],
205		]
206		);
207
208	1	$bundles = $container->getParameter('kernel.bundles');
209	1	if (isset($bundles['LiipImagineBundle'])) {
210	1	$this->prependLiipConfig($container);
211		}
212	1	}
213
214	1	private function prependLiipConfig(ContainerBuilder $container): void
215		{
216	1	$projectDir = $container->getParameter('kernel.project_dir');
217	1	$uploadsDir = $projectDir . '/var/uploads';
218	1	if (!@mkdir($uploadsDir) && !is_dir($uploadsDir)) {
219		throw new RuntimeException(sprintf('Directory "%s" was not created', $uploadsDir));
220		}
221	1	$container->prependExtensionConfig(
222	1	'liip_imagine',
223		[
224		'loaders' => [
225		'default' => [
226		'filesystem' => [
227		'data_root' => [
228	1	'uploads' => $uploadsDir,
229	1	'default' => $projectDir . '/public',
230		],
231		],
232		],
233		],
234		'filter_sets' => [
235		'placeholder_square' => [
236		'jpeg_quality' => 10,
237		'png_compression_level' => 9,
238		'filters' => [
239		'thumbnail' => [
240		'size' => [80, 80],
241		'mode' => 'outbound',
242		],
243		],
244		],
245		'placeholder' => [
246		'jpeg_quality' => 10,
247		'png_compression_level' => 9,
248		'filters' => [
249		'thumbnail' => [
250		'size' => [100, 100],
251		'mode' => 'inset',
252		],
253		],
254		],
255		'thumbnail' => [
256		'jpeg_quality' => 100,
257		'png_compression_level' => 0,
258		'filters' => [
259		'upscale' => [
260		'min' => [636, 636],
261		],
262		'thumbnail' => [
263		'size' => [636, 636],
264		'mode' => 'inset',
265		'allow_upscale' => true,
266		],
267		],
268		],
269		],
270		]
271		);
272	1	}
273		}
274

components-web-app / api-components-bundle

Push — feature/publishable ( ce6968...c26268 )

SilverbackApiComponentExtension::prepend() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like