#27660

pending completion

Build # #27660

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/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/51d102b8712d603b39cc8002359febeca489708a">51d102b87">&lt;a href=&quot;https://github.com/api-platform/core/commit/</a><a class="double-link" href="https://github.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/api-platform/core/commit/51d102b8712d603b39cc8002359febeca489708a">51d102b87</a><a href="https://github.com/api-platform/core/commit/51d102b8712d603b39cc8002359febeca489708a">&lt;a href=&quot;https://github.com/api-platform/core/commit/51d102b8712d603b39cc8002359febeca489708a&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/api-platform/core/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/api-platform/core/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot;&amp;gt;&amp;amp;lt;a class=&amp;lt;/a&amp;gt;hub.com/api-platform/core/commit/51d102b8712d603b39cc8002359febeca489708a&amp;quot;&amp;gt;51d102b87&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/51d102b8712d603b39cc8002359febeca489708a&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/api-platform/core/commit/51d102b8712d603b39cc8002359febec&amp;lt;/a&amp;gt;a4897</a>08a&quot;&gt;&amp;quot;&amp;gt;Merge &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/a346b89ab&quot;&gt;a346b89... (continued)

Run Details

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

13178 of 15984 relevant lines covered (82.44%)

14.82 hits per line

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

96.2

/src/Metadata/Resource/Factory/LegacyResourceMetadataResourceMetadataCollectionFactory.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\Metadata\Resource\Factory;

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameGenerator;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Exception\ResourceClassNotFoundException;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\GraphQl\Mutation;
use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
use ApiPlatform\Metadata\GraphQl\Query;
use ApiPlatform\Metadata\GraphQl\Subscription;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Operations;
use ApiPlatform\Metadata\Resource\DeprecationMetadataTrait;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;

final class LegacyResourceMetadataResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    use DeprecationMetadataTrait;
    private $decorated;
    private $resourceMetadataFactory;
    private $defaults;

    public function __construct(ResourceMetadataCollectionFactoryInterface $decorated = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, array $defaults = [])
    {
        $this->decorated = $decorated;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->defaults = $defaults + ['attributes' => []];
    }

    public function create(string $resourceClass): ResourceMetadataCollection
    {
        $resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);
        if ($this->decorated) {
            $resourceMetadataCollection = $this->decorated->create($resourceClass);
        }

        try {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
        } catch (ResourceClassNotFoundException $resourceNotFoundException) {
            return $resourceMetadataCollection;
        }

        $attributes = $resourceMetadata->getAttributes() ?? [];

        foreach ($this->defaults['attributes'] as $key => $value) {
            if (!$value) {
                continue;
            }

            if (!isset($attributes[$key])) {
                $attributes[$key] = $value;
            }
        }

        $resource = (new ApiResource())
            ->withShortName($resourceMetadata->getShortName())
            ->withDescription($resourceMetadata->getDescription())
            ->withClass($resourceClass)
            ->withTypes($resourceMetadata->getIri() ? [$resourceMetadata->getIri()] : []);

        foreach ($attributes as $key => $value) {
            $resource = $this->setAttributeValue($resource, $key, $value);
        }

        $operations = [];
        foreach ($this->createOperations($resourceMetadata->getItemOperations(), OperationType::ITEM, $resource) as $operationName => $operation) {
            $operationName = RouteNameGenerator::generate($operationName, $resourceMetadata->getShortName(), OperationType::ITEM);
            $operations[$operationName] = $operation->withShortName($resourceMetadata->getShortName())->withName($operationName);
        }

        foreach ($this->createOperations($resourceMetadata->getCollectionOperations(), OperationType::COLLECTION, $resource) as $operationName => $operation) {
            $operationName = RouteNameGenerator::generate($operationName, $resourceMetadata->getShortName(), OperationType::COLLECTION);
            if (!$operation->getUriTemplate() && !$operation->getRouteName() && $operation->getIdentifiers()) {
                $operation = $operation->withIdentifiers([]);
            }

            $operations[$operationName] = $operation->withShortName($resourceMetadata->getShortName())->withName($operationName);
        }

        if (!$resourceMetadata->getGraphql()) {
            // GraphQl can be null or an empty array, an empty array doesn't disable graphql type creation
            $resourceMetadataCollection[] = $resource->withGraphQlOperations($resourceMetadata->getGraphql())->withOperations(new Operations($operations));

            return $resourceMetadataCollection;
        }

        $graphQlOperations = [];
        foreach ($resourceMetadata->getGraphql() as $operationName => $operation) {
            if (false !== strpos($operationName, 'query') || isset($operation['item_query']) || isset($operation['collection_query'])) {
                $graphQlOperation = (new Query())
                    ->withCollection(isset($operation['collection_query']) || false !== strpos($operationName, 'collection'))
                    ->withName($operationName);
            } else {
                $graphQlOperation = (new Mutation())
                    ->withDescription(ucfirst("{$operationName}s a {$resourceMetadata->getShortName()}."))
                    ->withName($operationName);
            }

            $graphQlOperation = $graphQlOperation
                ->withArgs($operation['args'] ?? null)
                ->withResolver($operation['item_query'] ?? $operation['collection_query'] ?? $operation['mutation'] ?? null);

            foreach ($operation as $key => $value) {
                $graphQlOperation = $this->setAttributeValue($graphQlOperation, $key, $value);
            }

            if (null === $graphQlOperation->getCompositeIdentifier()) {
                $graphQlOperation = $graphQlOperation->withCompositeIdentifier(true);
            }

            $graphQlOperation = $graphQlOperation->withResource($resource);

            if ('update' === $operationName && $graphQlOperation instanceof Mutation && $graphQlOperation->getMercure()) {
                $graphQlOperations['update_subscription'] = (new Subscription())
                    ->withDescription("Subscribes to the $operationName event of a {$graphQlOperation->getShortName()}.")
                    ->withName('update_subscription')
                    ->withOperation($graphQlOperation);
            }

            $graphQlOperations[$operationName] = $graphQlOperation;
        }

        $resourceMetadataCollection[] = $resource->withOperations(new Operations($operations))->withGraphQlOperations($graphQlOperations);

        return $resourceMetadataCollection;
    }

    private function createOperations(array $operations, string $type, ApiResource $resource): iterable
    {
        $priority = 0;
        foreach ($operations as $operationName => $operation) {
            $newOperation = (new Operation())
                ->withMethod($operation['method'])
                ->withCollection(OperationType::COLLECTION === $type)
                ->withPriority($priority++);

            foreach ($operation as $key => $value) {
                $newOperation = $this->setAttributeValue($newOperation, $key, $value);
            }

            $newOperation = $newOperation->withResource($resource);

            // Default behavior in API Platform < 2.7
            if (null === $newOperation->getCompositeIdentifier()) {
                $newOperation = $newOperation->withCompositeIdentifier(true);
            }

            $newOperation = $newOperation->withExtraProperties($newOperation->getExtraProperties() + ['is_legacy_resource_metadata' => true]);
            // Avoiding operation name collision by adding _collection, this is rewritten by the UriTemplateResourceMetadataCollectionFactory
            yield sprintf('%s%s', $newOperation->getRouteName() ?? $operationName, OperationType::COLLECTION === $type ? '_collection' : '') => $newOperation;
        }
    }

    /**
     * @param Operation|GraphQlOperation|ApiResource $operation
     *
     * @return Operation|GraphQlOperation|ApiResource
     */
    private function setAttributeValue($operation, string $key, $value)
    {
        [$camelCaseKey, $value] = $this->getKeyValue($key, $value);
        $methodName = 'with'.ucfirst($camelCaseKey);

        if (method_exists($operation, $methodName)) {
            return $operation->{$methodName}($value);
        }

        return $operation->withExtraProperties($operation->getExtraProperties() + [$key => $value]);
    }
}

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\Metadata\Resource\Factory;
15
16	use ApiPlatform\Core\Api\OperationType;
17	use ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameGenerator;
18	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
19	use ApiPlatform\Exception\ResourceClassNotFoundException;
20	use ApiPlatform\Metadata\ApiResource;
21	use ApiPlatform\Metadata\GraphQl\Mutation;
22	use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
23	use ApiPlatform\Metadata\GraphQl\Query;
24	use ApiPlatform\Metadata\GraphQl\Subscription;
25	use ApiPlatform\Metadata\Operation;
26	use ApiPlatform\Metadata\Operations;
27	use ApiPlatform\Metadata\Resource\DeprecationMetadataTrait;
28	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
29
30	final class LegacyResourceMetadataResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
31	{
32	use DeprecationMetadataTrait;
33	private $decorated;
34	private $resourceMetadataFactory;
35	private $defaults;
36
37	public function __construct(ResourceMetadataCollectionFactoryInterface $decorated = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, array $defaults = [])
38	{
39	$this->decorated = $decorated;	38✔
40	$this->resourceMetadataFactory = $resourceMetadataFactory;	38✔
41	$this->defaults = $defaults + ['attributes' => []];	38✔
42	}	38✔
43
44	public function create(string $resourceClass): ResourceMetadataCollection
45	{
46	$resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);	3✔
47	if ($this->decorated) {	3✔
48	$resourceMetadataCollection = $this->decorated->create($resourceClass);	3✔
49	}
50
51	try {
52	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	3✔
53	} catch (ResourceClassNotFoundException $resourceNotFoundException) {	3✔
54	return $resourceMetadataCollection;	3✔
55	}
56
57	$attributes = $resourceMetadata->getAttributes() ?? [];	1✔
58
59	foreach ($this->defaults['attributes'] as $key => $value) {	1✔
60	if (!$value) {	1✔
61	continue;	×
62	}
63
64	if (!isset($attributes[$key])) {	1✔
65	$attributes[$key] = $value;	×
66	}
67	}
68
69	$resource = (new ApiResource())	1✔
70	->withShortName($resourceMetadata->getShortName())	1✔
71	->withDescription($resourceMetadata->getDescription())	1✔
72	->withClass($resourceClass)	1✔
73	->withTypes($resourceMetadata->getIri() ? [$resourceMetadata->getIri()] : []);	1✔
74
75	foreach ($attributes as $key => $value) {	1✔
76	$resource = $this->setAttributeValue($resource, $key, $value);	1✔
77	}
78
79	$operations = [];	1✔
80	foreach ($this->createOperations($resourceMetadata->getItemOperations(), OperationType::ITEM, $resource) as $operationName => $operation) {	1✔
81	$operationName = RouteNameGenerator::generate($operationName, $resourceMetadata->getShortName(), OperationType::ITEM);	1✔
82	$operations[$operationName] = $operation->withShortName($resourceMetadata->getShortName())->withName($operationName);	1✔
83	}
84
85	foreach ($this->createOperations($resourceMetadata->getCollectionOperations(), OperationType::COLLECTION, $resource) as $operationName => $operation) {	1✔
86	$operationName = RouteNameGenerator::generate($operationName, $resourceMetadata->getShortName(), OperationType::COLLECTION);	1✔
87	if (!$operation->getUriTemplate() && !$operation->getRouteName() && $operation->getIdentifiers()) {	1✔
88	$operation = $operation->withIdentifiers([]);	1✔
89	}
90
91	$operations[$operationName] = $operation->withShortName($resourceMetadata->getShortName())->withName($operationName);	1✔
92	}
93
94	if (!$resourceMetadata->getGraphql()) {	1✔
95	// GraphQl can be null or an empty array, an empty array doesn't disable graphql type creation
96	$resourceMetadataCollection[] = $resource->withGraphQlOperations($resourceMetadata->getGraphql())->withOperations(new Operations($operations));	1✔
97
98	return $resourceMetadataCollection;	1✔
99	}
100
101	$graphQlOperations = [];	1✔
102	foreach ($resourceMetadata->getGraphql() as $operationName => $operation) {	1✔
103	if (false !== strpos($operationName, 'query') \|\| isset($operation['item_query']) \|\| isset($operation['collection_query'])) {	1✔
104	$graphQlOperation = (new Query())	1✔
105	->withCollection(isset($operation['collection_query']) \|\| false !== strpos($operationName, 'collection'))	1✔
106	->withName($operationName);	1✔
107	} else {
108	$graphQlOperation = (new Mutation())	1✔
109	->withDescription(ucfirst("{$operationName}s a {$resourceMetadata->getShortName()}."))	1✔
110	->withName($operationName);	1✔
111	}
112
113	$graphQlOperation = $graphQlOperation	1✔
114	->withArgs($operation['args'] ?? null)	1✔
115	->withResolver($operation['item_query'] ?? $operation['collection_query'] ?? $operation['mutation'] ?? null);	1✔
116
117	foreach ($operation as $key => $value) {	1✔
118	$graphQlOperation = $this->setAttributeValue($graphQlOperation, $key, $value);	1✔
119	}
120
121	if (null === $graphQlOperation->getCompositeIdentifier()) {	1✔
122	$graphQlOperation = $graphQlOperation->withCompositeIdentifier(true);	1✔
123	}
124
125	$graphQlOperation = $graphQlOperation->withResource($resource);	1✔
126
127	if ('update' === $operationName && $graphQlOperation instanceof Mutation && $graphQlOperation->getMercure()) {	1✔
128	$graphQlOperations['update_subscription'] = (new Subscription())	1✔
129	->withDescription("Subscribes to the $operationName event of a {$graphQlOperation->getShortName()}.")	1✔
130	->withName('update_subscription')	1✔
131	->withOperation($graphQlOperation);	1✔
132	}
133
134	$graphQlOperations[$operationName] = $graphQlOperation;	1✔
135	}
136
137	$resourceMetadataCollection[] = $resource->withOperations(new Operations($operations))->withGraphQlOperations($graphQlOperations);	1✔
138
139	return $resourceMetadataCollection;	1✔
140	}
141
142	private function createOperations(array $operations, string $type, ApiResource $resource): iterable
143	{
144	$priority = 0;	1✔
145	foreach ($operations as $operationName => $operation) {	1✔
146	$newOperation = (new Operation())	1✔
147	->withMethod($operation['method'])	1✔
148	->withCollection(OperationType::COLLECTION === $type)	1✔
149	->withPriority($priority++);	1✔
150
151	foreach ($operation as $key => $value) {	1✔
152	$newOperation = $this->setAttributeValue($newOperation, $key, $value);	1✔
153	}
154
155	$newOperation = $newOperation->withResource($resource);	1✔
156
157	// Default behavior in API Platform < 2.7
158	if (null === $newOperation->getCompositeIdentifier()) {	1✔
159	$newOperation = $newOperation->withCompositeIdentifier(true);	1✔
160	}
161
162	$newOperation = $newOperation->withExtraProperties($newOperation->getExtraProperties() + ['is_legacy_resource_metadata' => true]);	1✔
163	// Avoiding operation name collision by adding _collection, this is rewritten by the UriTemplateResourceMetadataCollectionFactory
164	yield sprintf('%s%s', $newOperation->getRouteName() ?? $operationName, OperationType::COLLECTION === $type ? '_collection' : '') => $newOperation;	1✔
165	}
166	}	1✔
167
168	/**
169	* @param Operation\|GraphQlOperation\|ApiResource $operation
170	*
171	* @return Operation\|GraphQlOperation\|ApiResource
172	*/
173	private function setAttributeValue($operation, string $key, $value)
174	{
175	[$camelCaseKey, $value] = $this->getKeyValue($key, $value);	1✔
176	$methodName = 'with'.ucfirst($camelCaseKey);	1✔
177
178	if (method_exists($operation, $methodName)) {	1✔
179	return $operation->{$methodName}($value);	1✔
180	}
181
182	return $operation->withExtraProperties($operation->getExtraProperties() + [$key => $value]);	×
183	}
184	}

api-platform / core / #27660

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