PublishableNormalizer::supportsDenormalization() - Code Metrics - Inspection of "Fix readme badges" - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/uploadable ( 7c6d25...a7ed20 )

by Daniel

created 2020-05-02 19:56 UTC

PublishableNormalizer::supportsDenormalization() A

↳ Parent: PublishableNormalizer

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	1
nc	2
nop	4
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	6
rs	10
c	0
b	0
f	0

<?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\Serializer\Normalizer;

use ApiPlatform\Core\Bridge\Symfony\Validator\Exception\ValidationException;
use ApiPlatform\Core\Validator\ValidatorInterface;
use Doctrine\ORM\Mapping\ClassMetadataInfo;
use Doctrine\Persistence\ManagerRegistry;
use Silverback\ApiComponentsBundle\Annotation\Publishable;
use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
use Silverback\ApiComponentsBundle\Publishable\PublishableHelper;
use Silverback\ApiComponentsBundle\Validator\PublishableValidator;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\ContextAwareDenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerAwareTrait;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;

/**
 * Adds `published` property on response, if not set.
 *
 * @author Vincent Chalamon <[email protected]>
 */
final class PublishableNormalizer implements ContextAwareNormalizerInterface, CacheableSupportsMethodInterface, NormalizerAwareInterface, ContextAwareDenormalizerInterface, DenormalizerAwareInterface
{
    use NormalizerAwareTrait;
    use DenormalizerAwareTrait;

    private const ALREADY_CALLED = 'PUBLISHABLE_NORMALIZER_ALREADY_CALLED';

    private PublishableHelper $publishableHelper;
    private ManagerRegistry $registry;
    private RequestStack $requestStack;
    private ValidatorInterface $validator;

    public function __construct(PublishableHelper $publishableHelper, ManagerRegistry $registry, RequestStack $requestStack, ValidatorInterface $validator)
    {
        $this->publishableHelper = $publishableHelper;
        $this->registry = $registry;
        $this->requestStack = $requestStack;
        $this->validator = $validator;
    }

    public function normalize($object, $format = null, array $context = [])
    {
        $context[self::ALREADY_CALLED] = true;
        $context[MetadataNormalizer::METADATA_CONTEXT]['published'] = $this->publishableHelper->isActivePublishedAt($object);

        if ($this->publishableHelper->isGranted($object)) {
            try {
                $this->validator->validate($object, [PublishableValidator::PUBLISHED_KEY => true]);
            } catch (ValidationException $exception) {
                $context[MetadataNormalizer::METADATA_CONTEXT]['violation_list'] = $this->normalizer->normalize($exception->getConstraintViolationList(), $format);
            }
        }

        return $this->normalizer->normalize($object, $format, $context);
    }

    public function supportsNormalization($data, $format = null, $context = []): bool
    {
        return !isset($context[self::ALREADY_CALLED]) &&
            \is_object($data) &&
            !$data instanceof \Traversable &&
            $this->publishableHelper->getAnnotationReader()->isConfigured($data);
    }

    /**
     * {@inheritdoc}
     */
    public function denormalize($data, $type, $format = null, array $context = [])
    {
        $context[self::ALREADY_CALLED] = true;
        $configuration = $this->publishableHelper->getAnnotationReader()->getConfiguration($type);

        $data = $this->unsetRestrictedData($type, $data, $configuration);

        $request = $this->requestStack->getMasterRequest();
        if ($request && true === $this->publishableHelper->isPublishedRequest($request)) {
            return $this->denormalizer->denormalize($data, $type, $format, $context);
        }

        // It's a new object
        if (!isset($context[AbstractNormalizer::OBJECT_TO_POPULATE])) {
            // User doesn't have draft access: force publication date
            if (!$this->publishableHelper->isGranted($type)) {
                $data[$configuration->fieldName] = date('Y-m-d H:i:s');
            }

            return $this->denormalizer->denormalize($data, $type, $format, $context);
        }

        $object = $context[AbstractNormalizer::OBJECT_TO_POPULATE];
        $data = $this->setPublishedAt($data, $configuration, $object);

        // No field has been updated (after publishedAt verified and cleaned/unset if needed): nothing to do here anymore
        // or User doesn't have draft access: update the original object
        if (
            empty($data) ||
            !$this->publishableHelper->isActivePublishedAt($object) ||
            !$this->publishableHelper->isGranted($type)
        ) {
            return $this->denormalizer->denormalize($data, $type, $format, $context);
        }

        // Any field has been modified: create a draft
        $draft = $this->createDraft($object, $configuration, $type);

        $context[AbstractNormalizer::OBJECT_TO_POPULATE] = $draft;

        return $this->denormalizer->denormalize($data, $type, $format, $context);
    }

    private function setPublishedAt(array $data, Publishable $configuration, object $object): array
    {
        if (isset($data[$configuration->fieldName])) {
            $publicationDate = new \DateTimeImmutable($data[$configuration->fieldName]);

            // User changed the publication date with an earlier one on a published resource: ignore it
            if (
                $this->publishableHelper->isActivePublishedAt($object) &&
                new \DateTimeImmutable() >= $publicationDate
            ) {
                unset($data[$configuration->fieldName]);
            }
        }

        return $data;
    }

    private function unsetRestrictedData($type, array $data, Publishable $configuration): array
    {
        // It's not possible to change the publishedResource and draftResource properties
        unset($data[$configuration->associationName], $data[$configuration->reverseAssociationName]);

        // User doesn't have draft access: cannot set or change the publication date
        if (!$this->publishableHelper->isGranted($type)) {
            unset($data[$configuration->fieldName]);
        }

        return $data;
    }

    private function createDraft(object $object, Publishable $configuration, string $type): object
    {
        $em = $this->registry->getManagerForClass($type);
        if (!$em) {
            throw new InvalidArgumentException(sprintf('Could not find entity manager for class %s', $type));
        }

        /** @var ClassMetadataInfo $classMetadata */
        $classMetadata = $em->getClassMetadata($type);

        // Resource is a draft: nothing to do here anymore
        if (null !== $classMetadata->getFieldValue($object, $configuration->associationName)) {
            return $object;
        }

        $draft = clone $object; // Identifier(s) should be reset from AbstractComponent::__clone method

        // Empty publishedDate on draft
        $classMetadata->setFieldValue($draft, $configuration->fieldName, null);

        // Set publishedResource on draft
        $classMetadata->setFieldValue($draft, $configuration->associationName, $object);

        // Set draftResource on data
        $classMetadata->setFieldValue($object, $configuration->reverseAssociationName, $draft);

        // Add draft object to UnitOfWork
        $em->persist($draft);

        return $draft;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
    {
        return !isset($context[self::ALREADY_CALLED]) && $this->publishableHelper->getAnnotationReader()->isConfigured($type);
    }

    public function hasCacheableSupportsMethod(): bool
    {
        return false;
    }
}


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\Serializer\Normalizer;
15
16			use ApiPlatform\Core\Bridge\Symfony\Validator\Exception\ValidationException;
17			use ApiPlatform\Core\Validator\ValidatorInterface;
18			use Doctrine\ORM\Mapping\ClassMetadataInfo;
19			use Doctrine\Persistence\ManagerRegistry;
20			use Silverback\ApiComponentsBundle\Annotation\Publishable;
21			use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
22			use Silverback\ApiComponentsBundle\Publishable\PublishableHelper;
23			use Silverback\ApiComponentsBundle\Validator\PublishableValidator;
24			use Symfony\Component\HttpFoundation\RequestStack;
25			use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
26			use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
27			use Symfony\Component\Serializer\Normalizer\ContextAwareDenormalizerInterface;
28			use Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface;
29			use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
30			use Symfony\Component\Serializer\Normalizer\DenormalizerAwareTrait;
31			use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
32			use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
33
34			/**
35			* Adds `published` property on response, if not set.
36			*
37			* @author Vincent Chalamon <[email protected]>
38			*/
39			final class PublishableNormalizer implements ContextAwareNormalizerInterface, CacheableSupportsMethodInterface, NormalizerAwareInterface, ContextAwareDenormalizerInterface, DenormalizerAwareInterface
40			{
41			use NormalizerAwareTrait;
42			use DenormalizerAwareTrait;
43
44			private const ALREADY_CALLED = 'PUBLISHABLE_NORMALIZER_ALREADY_CALLED';
45
46			private PublishableHelper $publishableHelper;
47			private ManagerRegistry $registry;
48			private RequestStack $requestStack;
49			private ValidatorInterface $validator;
50
51			public function __construct(PublishableHelper $publishableHelper, ManagerRegistry $registry, RequestStack $requestStack, ValidatorInterface $validator)
52			{
53			$this->publishableHelper = $publishableHelper;
54			$this->registry = $registry;
55			$this->requestStack = $requestStack;
56			$this->validator = $validator;
57			}
58
59			public function normalize($object, $format = null, array $context = [])
60			{
61			$context[self::ALREADY_CALLED] = true;
62			$context[MetadataNormalizer::METADATA_CONTEXT]['published'] = $this->publishableHelper->isActivePublishedAt($object);
63
64			if ($this->publishableHelper->isGranted($object)) {
65			try {
66			$this->validator->validate($object, [PublishableValidator::PUBLISHED_KEY => true]);
67			} catch (ValidationException $exception) {
68			$context[MetadataNormalizer::METADATA_CONTEXT]['violation_list'] = $this->normalizer->normalize($exception->getConstraintViolationList(), $format);
69			}
70			}
71
72			return $this->normalizer->normalize($object, $format, $context);
73			}
74
75			public function supportsNormalization($data, $format = null, $context = []): bool
76			{
77			return !isset($context[self::ALREADY_CALLED]) &&
78			\is_object($data) &&
79			!$data instanceof \Traversable &&
80			$this->publishableHelper->getAnnotationReader()->isConfigured($data);
81			}
82
83			/**
84			* {@inheritdoc}
85			*/
86			public function denormalize($data, $type, $format = null, array $context = [])
87			{
88			$context[self::ALREADY_CALLED] = true;
89			$configuration = $this->publishableHelper->getAnnotationReader()->getConfiguration($type);
90
91			$data = $this->unsetRestrictedData($type, $data, $configuration);
92
93			$request = $this->requestStack->getMasterRequest();
94			if ($request && true === $this->publishableHelper->isPublishedRequest($request)) {
95			return $this->denormalizer->denormalize($data, $type, $format, $context);
96			}
97
98			// It's a new object
99			if (!isset($context[AbstractNormalizer::OBJECT_TO_POPULATE])) {
100			// User doesn't have draft access: force publication date
101			if (!$this->publishableHelper->isGranted($type)) {
102			$data[$configuration->fieldName] = date('Y-m-d H:i:s');
103			}
104
105			return $this->denormalizer->denormalize($data, $type, $format, $context);
106			}
107
108			$object = $context[AbstractNormalizer::OBJECT_TO_POPULATE];
109			$data = $this->setPublishedAt($data, $configuration, $object);
110
111			// No field has been updated (after publishedAt verified and cleaned/unset if needed): nothing to do here anymore
112			// or User doesn't have draft access: update the original object
113			if (
114			empty($data) \|\|
115			!$this->publishableHelper->isActivePublishedAt($object) \|\|
116			!$this->publishableHelper->isGranted($type)
117			) {
118			return $this->denormalizer->denormalize($data, $type, $format, $context);
119			}
120
121			// Any field has been modified: create a draft
122			$draft = $this->createDraft($object, $configuration, $type);
123
124			$context[AbstractNormalizer::OBJECT_TO_POPULATE] = $draft;
125
126			return $this->denormalizer->denormalize($data, $type, $format, $context);
127			}
128
129			private function setPublishedAt(array $data, Publishable $configuration, object $object): array
130			{
131			if (isset($data[$configuration->fieldName])) {
132			$publicationDate = new \DateTimeImmutable($data[$configuration->fieldName]);
133
134			// User changed the publication date with an earlier one on a published resource: ignore it
135			if (
136			$this->publishableHelper->isActivePublishedAt($object) &&
137			new \DateTimeImmutable() >= $publicationDate
138			) {
139			unset($data[$configuration->fieldName]);
140			}
141			}
142
143			return $data;
144			}
145
146			private function unsetRestrictedData($type, array $data, Publishable $configuration): array
147			{
148			// It's not possible to change the publishedResource and draftResource properties
149			unset($data[$configuration->associationName], $data[$configuration->reverseAssociationName]);
150
151			// User doesn't have draft access: cannot set or change the publication date
152			if (!$this->publishableHelper->isGranted($type)) {
153			unset($data[$configuration->fieldName]);
154			}
155
156			return $data;
157			}
158
159			private function createDraft(object $object, Publishable $configuration, string $type): object
160			{
161			$em = $this->registry->getManagerForClass($type);
162			if (!$em) {
163			throw new InvalidArgumentException(sprintf('Could not find entity manager for class %s', $type));
164			}
165
166			/** @var ClassMetadataInfo $classMetadata */
167			$classMetadata = $em->getClassMetadata($type);
168
169			// Resource is a draft: nothing to do here anymore
170			if (null !== $classMetadata->getFieldValue($object, $configuration->associationName)) {
171			return $object;
172			}
173
174			$draft = clone $object; // Identifier(s) should be reset from AbstractComponent::__clone method
175
176			// Empty publishedDate on draft
177			$classMetadata->setFieldValue($draft, $configuration->fieldName, null);
178
179			// Set publishedResource on draft
180			$classMetadata->setFieldValue($draft, $configuration->associationName, $object);
181
182			// Set draftResource on data
183			$classMetadata->setFieldValue($object, $configuration->reverseAssociationName, $draft);
184
185			// Add draft object to UnitOfWork
186			$em->persist($draft);
187
188			return $draft;
189			}
190
191			/**
192			* {@inheritdoc}
193			*/
194			public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
195			{
196			return !isset($context[self::ALREADY_CALLED]) && $this->publishableHelper->getAnnotationReader()->isConfigured($type);
197			}
198
199			public function hasCacheableSupportsMethod(): bool
200			{
201			return false;
202			}
203			}
204

components-web-app / api-components-bundle

Push — feature/uploadable ( 7c6d25...a7ed20 )

PublishableNormalizer::supportsDenormalization() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like