#26933

pending completion

Build # #26933

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/ce1fb0f58a6721c4ef3f2f42c8c32ed697344996">ce1fb0f58<a href="https://github.com/api-platform/core/commit/ce1fb0f58a6721c4ef3f2f42c8c32ed697344996">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/4558ab91cc43e57fec5b723fe88d094e4e990e4a">4558ab91c</a>">4558ab91c</a><a href="https://github.com/api-platform/core/commit/ce1fb0f58a6721c4ef3f2f42c8c32ed697344996"> into d5f869207">d5f869207</a>

Run Details

11 of 11 new or added lines in 3 files covered. (100.0%)

9622 of 11584 relevant lines covered (83.06%)

14.4 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.0

/src/GraphQl/Serializer/ItemNormalizer.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\GraphQl\Serializer;

use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
use ApiPlatform\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Security\ResourceAccessCheckerInterface;
use ApiPlatform\Core\Serializer\ItemNormalizer as BaseItemNormalizer;
use ApiPlatform\Core\Util\ClassInfoTrait;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * GraphQL normalizer.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ItemNormalizer extends BaseItemNormalizer
{
    use ClassInfoTrait;

    public const FORMAT = 'graphql';
    public const ITEM_RESOURCE_CLASS_KEY = '#itemResourceClass';
    public const ITEM_IDENTIFIERS_KEY = '#itemIdentifiers';

    private $identifiersExtractor;

    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, IdentifiersExtractorInterface $identifiersExtractor, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, ItemDataProviderInterface $itemDataProvider = null, bool $allowPlainIdentifiers = false, LoggerInterface $logger = null, iterable $dataTransformers = [], ResourceMetadataFactoryInterface $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
    {
        parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $itemDataProvider, $allowPlainIdentifiers, $logger ?: new NullLogger(), $dataTransformers, $resourceMetadataFactory, $resourceAccessChecker);

        $this->identifiersExtractor = $identifiersExtractor;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization($data, $format = null): bool
    {
        return self::FORMAT === $format && parent::supportsNormalization($data, $format);
    }

    /**
     * {@inheritdoc}
     *
     * @throws UnexpectedValueException
     */
    public function normalize($object, $format = null, array $context = [])
    {
        if (null !== $this->getOutputClass($this->getObjectClass($object), $context)) {
            return parent::normalize($object, $format, $context);
        }

        $data = parent::normalize($object, $format, $context);
        if (!\is_array($data)) {
            throw new UnexpectedValueException('Expected data to be an array.');
        }

        if (!($context['no_resolver_data'] ?? false)) {
            $data[self::ITEM_RESOURCE_CLASS_KEY] = $this->getObjectClass($object);
            $data[self::ITEM_IDENTIFIERS_KEY] = $this->identifiersExtractor->getIdentifiersFromItem($object);
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    protected function normalizeCollectionOfRelations(PropertyMetadata $propertyMetadata, $attributeValue, string $resourceClass, ?string $format, array $context): array
    {
        // to-many are handled directly by the GraphQL resolver
        return [];
    }

    /**
     * {@inheritdoc}
     */
    public function supportsDenormalization($data, $type, $format = null): bool
    {
        return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format);
    }

    /**
     * {@inheritdoc}
     */
    protected function getAllowedAttributes($classOrObject, array $context, $attributesAsString = false)
    {
        $allowedAttributes = parent::getAllowedAttributes($classOrObject, $context, $attributesAsString);

        if (($context['api_denormalize'] ?? false) && \is_array($allowedAttributes) && false !== ($indexId = array_search('id', $allowedAttributes, true))) {
            $allowedAttributes[] = '_id';
            array_splice($allowedAttributes, (int) $indexId, 1);
        }

        return $allowedAttributes;
    }

    /**
     * {@inheritdoc}
     */
    protected function setAttributeValue($object, $attribute, $value, $format = null, array $context = []): void
    {
        if ('_id' === $attribute) {
            $attribute = 'id';
        }

        parent::setAttributeValue($object, $attribute, $value, $format, $context);
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
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 ApiPlatform\Core\GraphQl\Serializer;
15
16	use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
17	use ApiPlatform\Core\Api\IriConverterInterface;
18	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
19	use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
20	use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
21	use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
22	use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
23	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
24	use ApiPlatform\Core\Security\ResourceAccessCheckerInterface;
25	use ApiPlatform\Core\Serializer\ItemNormalizer as BaseItemNormalizer;
26	use ApiPlatform\Core\Util\ClassInfoTrait;
27	use Psr\Log\LoggerInterface;
28	use Psr\Log\NullLogger;
29	use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
30	use Symfony\Component\Serializer\Exception\UnexpectedValueException;
31	use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
32	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
33
34	/**
35	* GraphQL normalizer.
36	*
37	* @author Kévin Dunglas <dunglas@gmail.com>
38	*/
39	final class ItemNormalizer extends BaseItemNormalizer
40	{
41	use ClassInfoTrait;
42
43	public const FORMAT = 'graphql';
44	public const ITEM_RESOURCE_CLASS_KEY = '#itemResourceClass';
45	public const ITEM_IDENTIFIERS_KEY = '#itemIdentifiers';
46
47	private $identifiersExtractor;
48
49	public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, IdentifiersExtractorInterface $identifiersExtractor, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, ItemDataProviderInterface $itemDataProvider = null, bool $allowPlainIdentifiers = false, LoggerInterface $logger = null, iterable $dataTransformers = [], ResourceMetadataFactoryInterface $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
50	{
51	parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $itemDataProvider, $allowPlainIdentifiers, $logger ?: new NullLogger(), $dataTransformers, $resourceMetadataFactory, $resourceAccessChecker);	34✔
52
53	$this->identifiersExtractor = $identifiersExtractor;	34✔
54	}	34✔
55
56	/**
57	* {@inheritdoc}
58	*/
59	public function supportsNormalization($data, $format = null): bool
60	{
61	return self::FORMAT === $format && parent::supportsNormalization($data, $format);	17✔
62	}
63
64	/**
65	* {@inheritdoc}
66	*
67	* @throws UnexpectedValueException
68	*/
69	public function normalize($object, $format = null, array $context = [])
70	{
71	if (null !== $this->getOutputClass($this->getObjectClass($object), $context)) {	2✔
72	return parent::normalize($object, $format, $context);	×
73	}
74
75	$data = parent::normalize($object, $format, $context);	2✔
76	if (!\is_array($data)) {	2✔
77	throw new UnexpectedValueException('Expected data to be an array.');	×
78	}
79
80	if (!($context['no_resolver_data'] ?? false)) {	2✔
81	$data[self::ITEM_RESOURCE_CLASS_KEY] = $this->getObjectClass($object);	1✔
82	$data[self::ITEM_IDENTIFIERS_KEY] = $this->identifiersExtractor->getIdentifiersFromItem($object);	1✔
83	}
84
85	return $data;	2✔
86	}
87
88	/**
89	* {@inheritdoc}
90	*/
91	protected function normalizeCollectionOfRelations(PropertyMetadata $propertyMetadata, $attributeValue, string $resourceClass, ?string $format, array $context): array
92	{
93	// to-many are handled directly by the GraphQL resolver
94	return [];	×
95	}
96
97	/**
98	* {@inheritdoc}
99	*/
100	public function supportsDenormalization($data, $type, $format = null): bool
101	{
102	return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format);	4✔
103	}
104
105	/**
106	* {@inheritdoc}
107	*/
108	protected function getAllowedAttributes($classOrObject, array $context, $attributesAsString = false)
109	{
110	$allowedAttributes = parent::getAllowedAttributes($classOrObject, $context, $attributesAsString);	3✔
111
112	if (($context['api_denormalize'] ?? false) && \is_array($allowedAttributes) && false !== ($indexId = array_search('id', $allowedAttributes, true))) {	3✔
113	$allowedAttributes[] = '_id';	×
114	array_splice($allowedAttributes, (int) $indexId, 1);	×
115	}
116
117	return $allowedAttributes;	3✔
118	}
119
120	/**
121	* {@inheritdoc}
122	*/
123	protected function setAttributeValue($object, $attribute, $value, $format = null, array $context = []): void
124	{
125	if ('_id' === $attribute) {	1✔
126	$attribute = 'id';	×
127	}
128
129	parent::setAttributeValue($object, $attribute, $value, $format, $context);	1✔
130	}	1✔
131	}

api-platform / core / #26933

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous