kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

refactor #12970 [DX] Add sylius prefixes to normalizers ALREADY_CALLED consts values to avoid name collision (lchrusciel)

Browse source 
This PR was merged into the 1.11-dev branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         | master
| Bug fix?        | kind of
| New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| Related tickets | 
| License         | MIT

While adding custom normalizer, it may be tempting to use the same name for the flag. This may lead to skipping part of normalization. It would be better to prefix our config keys with `sylius` and make official recommendation, that such keys in end projects should be prefixed with `app`

<!--
 - Bug fixes must be submitted against the 1.9 or 1.10 branch (the lowest possible)
 - Features and deprecations must be submitted against the master branch
 - Make sure that the correct base branch is set

 To be sure you are not breaking any Backward Compatibilities, check the documentation:
 https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html
-->


Commits
-------

7e0c050880 [DX] Add sylius prefixes to normalizers ALREADY_CALLED consts values to avoid name collision
This commit is contained in:
Grzegorz Sadowski 2021-08-18 07:27:25 +02:00 • committed by GitHub
commit 2c8755ec39
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 23 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/Sylius/Bundle/ApiBundle/Serializer/CommandNormalizer.php
View file

@ -22,7 +22,7 @@ use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
*/
final class CommandNormalizer implements ContextAwareNormalizerInterface
{
private const ALREADY_CALLED = 'command_normalizer_already_called';
private const ALREADY_CALLED = 'sylius_command_normalizer_already_called';
/** @var NormalizerInterface */
private $objectNormalizer;

2
src/Sylius/Bundle/ApiBundle/Serializer/ProductImageNormalizer.php
View file

@ -26,7 +26,7 @@ class ProductImageNormalizer implements ContextAwareNormalizerInterface, Normali
{
use NormalizerAwareTrait;
private const ALREADY_CALLED = 'product_image_normalizer_already_called';
private const ALREADY_CALLED = 'sylius_product_image_normalizer_already_called';
private CacheManager $cacheManager;
private RequestStack $requestStack;

2
src/Sylius/Bundle/ApiBundle/Serializer/ProductNormalizer.php
View file

@ -26,7 +26,7 @@ final class ProductNormalizer implements ContextAwareNormalizerInterface, Normal
{
use NormalizerAwareTrait;
private const ALREADY_CALLED = 'product_normalizer_already_called';
private const ALREADY_CALLED = 'sylius_product_normalizer_already_called';
/** @var ProductVariantResolverInterface */
private $defaultProductVariantResolver;

2
src/Sylius/Bundle/ApiBundle/Serializer/ProductVariantNormalizer.php
View file

@ -30,7 +30,7 @@ final class ProductVariantNormalizer implements ContextAwareNormalizerInterface,
{
use NormalizerAwareTrait;
private const ALREADY_CALLED = 'product_variant_normalizer_already_called';
private const ALREADY_CALLED = 'sylius_product_variant_normalizer_already_called';
/** @var ProductVariantPricesCalculatorInterface */
private $priceCalculator;

2
src/Sylius/Bundle/ApiBundle/Serializer/ShippingMethodNormalizer.php
View file

@ -29,7 +29,7 @@ final class ShippingMethodNormalizer implements ContextAwareNormalizerInterface,
{
use NormalizerAwareTrait;
private const ALREADY_CALLED = 'shipping_method_normalizer_already_called';
private const ALREADY_CALLED = 'sylius_shipping_method_normalizer_already_called';
/** @var OrderRepositoryInterface */
private $orderRepository;

4
src/Sylius/Bundle/ApiBundle/spec/Serializer/CommandNormalizerSpec.php
View file

@ -56,7 +56,7 @@ final class CommandNormalizerSpec extends ObjectBehavior
->supportsNormalization(
new class() { public function getClass(): string { return MissingConstructorArgumentsException::class; }},
null,
['command_normalizer_already_called' => true]
['sylius_command_normalizer_already_called' => true]
)
->shouldReturn(false)
;
@ -72,7 +72,7 @@ final class CommandNormalizerSpec extends ObjectBehavior
\stdClass $object
): void {
$baseNormalizer
->normalize($object, null, ['command_normalizer_already_called' => true])
->normalize($object, null, ['sylius_command_normalizer_already_called' => true])
->willReturn(['message' => 'Message'])
;

4
src/Sylius/Bundle/ApiBundle/spec/Serializer/ProductImageNormalizerSpec.php
View file

@ -52,7 +52,7 @@ final class ProductImageNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($productImage, null, ['product_image_normalizer_already_called' => true])->willReturn(['path' => 'some_path']);
$normalizer->normalize($productImage, null, ['sylius_product_image_normalizer_already_called' => true])->willReturn(['path' => 'some_path']);
$requestStack->getCurrentRequest()->willReturn($request);
$request->query = new ParameterBag([]);
@ -69,7 +69,7 @@ final class ProductImageNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($productImage, null, ['product_image_normalizer_already_called' => true])->willReturn(['path' => 'some_path']);
$normalizer->normalize($productImage, null, ['sylius_product_image_normalizer_already_called' => true])->willReturn(['path' => 'some_path']);
$requestStack->getCurrentRequest()->willReturn($request);
$request->query = new ParameterBag(['filter' => 'sylius_large']);

10
src/Sylius/Bundle/ApiBundle/spec/Serializer/ProductNormalizerSpec.php
View file

@ -40,7 +40,7 @@ final class ProductNormalizerSpec extends ObjectBehavior
function it_does_not_support_if_the_normalizer_has_been_already_called(ProductVariantInterface $variant): void
{
$this
->supportsNormalization($variant, null, ['product_normalizer_already_called' => true])
->supportsNormalization($variant, null, ['sylius_product_normalizer_already_called' => true])
->shouldReturn(false)
;
}
@ -54,7 +54,7 @@ final class ProductNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($product, null, ['product_normalizer_already_called' => true])->willReturn([]);
$normalizer->normalize($product, null, ['sylius_product_normalizer_already_called' => true])->willReturn([]);
$defaultProductVariantResolver->getVariant($product)->willReturn($variant);
$iriConverter->getIriFromItem($variant)->willReturn('/api/v2/shop/product-variants/CODE');
@ -69,7 +69,7 @@ final class ProductNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($product, null, ['product_normalizer_already_called' => true])->willReturn([]);
$normalizer->normalize($product, null, ['sylius_product_normalizer_already_called' => true])->willReturn([]);
$defaultProductVariantResolver->getVariant($product)->willReturn(null);
$iriConverter->getIriFromItem(Argument::any())->shouldNotBeCalled();
@ -82,11 +82,11 @@ final class ProductNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($product, null, ['product_normalizer_already_called' => true])->shouldNotBeCalled();
$normalizer->normalize($product, null, ['sylius_product_normalizer_already_called' => true])->shouldNotBeCalled();
$this
->shouldThrow(\InvalidArgumentException::class)
->during('normalize', [$product, null, ['product_normalizer_already_called' => true]])
->during('normalize', [$product, null, ['sylius_product_normalizer_already_called' => true]])
;
}
}

12
src/Sylius/Bundle/ApiBundle/spec/Serializer/ProductVariantNormalizerSpec.php
View file

@ -64,7 +64,7 @@ final class ProductVariantNormalizerSpec extends ObjectBehavior
function it_does_not_support_if_the_normalizer_has_been_already_called(ProductVariantInterface $variant): void
{
$this
->supportsNormalization($variant, null, ['product_variant_normalizer_already_called' => true])
->supportsNormalization($variant, null, ['sylius_product_variant_normalizer_already_called' => true])
->shouldReturn(false)
;
}
@ -79,7 +79,7 @@ final class ProductVariantNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($variant, null, ['product_variant_normalizer_already_called' => true])->willReturn([]);
$normalizer->normalize($variant, null, ['sylius_product_variant_normalizer_already_called' => true])->willReturn([]);
$channelContext->getChannel()->willReturn($channel);
$pricesCalculator->calculate($variant, ['channel' => $channel])->willReturn(1000);
@ -100,7 +100,7 @@ final class ProductVariantNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($variant, null, ['product_variant_normalizer_already_called' => true])->willReturn([]);
$normalizer->normalize($variant, null, ['sylius_product_variant_normalizer_already_called' => true])->willReturn([]);
$channelContext->getChannel()->willReturn($channel);
$pricesCalculator->calculate($variant, ['channel' => $channel])->willReturn(500);
@ -121,7 +121,7 @@ final class ProductVariantNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($variant, null, ['product_variant_normalizer_already_called' => true])->willReturn([]);
$normalizer->normalize($variant, null, ['sylius_product_variant_normalizer_already_called' => true])->willReturn([]);
$channelContext->getChannel()->willReturn($channel);
$pricesCalculator->calculate($variant, ['channel' => $channel])->willThrow(ChannelNotFoundException::class);
@ -138,11 +138,11 @@ final class ProductVariantNormalizerSpec extends ObjectBehavior
): void {
$this->setNormalizer($normalizer);
$normalizer->normalize($variant, null, ['product_variant_normalizer_already_called' => true])->shouldNotBeCalled();
$normalizer->normalize($variant, null, ['sylius_product_variant_normalizer_already_called' => true])->shouldNotBeCalled();
$this
->shouldThrow(\InvalidArgumentException::class)
->during('normalize', [$variant, null, ['product_variant_normalizer_already_called' => true]])
->during('normalize', [$variant, null, ['sylius_product_variant_normalizer_already_called' => true]])
;
}
}

6
src/Sylius/Bundle/ApiBundle/spec/Serializer/ShippingMethodNormalizerSpec.php
View file

@ -60,7 +60,7 @@ final class ShippingMethodNormalizerSpec extends ObjectBehavior
{
$this
->supportsNormalization($shippingMethod, null, [
'shipping_method_normalizer_already_called' => true,
'sylius_shipping_method_normalizer_already_called' => true,
'subresource_identifiers' => ['tokenValue' => '666', 'shipments' => '999'],
])
->shouldReturn(false)
@ -90,7 +90,7 @@ final class ShippingMethodNormalizerSpec extends ObjectBehavior
$normalizer
->normalize($shippingMethod, null, [
'shipping_method_normalizer_already_called' => true,
'sylius_shipping_method_normalizer_already_called' => true,
'subresource_identifiers' => ['tokenValue' => '666', 'shipments' => '999'],
])
->willReturn([])
@ -118,7 +118,7 @@ final class ShippingMethodNormalizerSpec extends ObjectBehavior
$normalizer
->normalize($shippingMethod, null, [
'shipping_method_normalizer_already_called' => true,
'sylius_shipping_method_normalizer_already_called' => true,
'subresource_identifiers' => ['tokenValue' => '666', 'shipments' => '999'],
])
->shouldNotBeCalled()