#28250

pending completion

Build # #28250

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/587916fac338f91a6e53c6410829fc5abedb4f23">587916fac<a href="https://github.com/api-platform/core/commit/587916fac338f91a6e53c6410829fc5abedb4f23">">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/ea96b52a74b3e0a56cbb21087047779b40626915">ea96b52a7</a>">ea96b52a7</a><a href="https://github.com/api-platform/core/commit/587916fac338f91a6e53c6410829fc5abedb4f23"> into cc8ae0b00">cc8ae0b00</a>

Run Details

683 of 683 new or added lines in 14 files covered. (100.0%)

14008 of 17494 relevant lines covered (80.07%)

14.29 hits per line

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

95.06

/src/Metadata/Resource/Factory/ExtractorResourceMetadataCollectionFactory.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\Metadata\ApiResource;
use ApiPlatform\Metadata\Delete;
use ApiPlatform\Metadata\Extractor\ResourceExtractorInterface;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Operations;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\Resource\DeprecationMetadataTrait;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;

/**
 * Creates a resource metadata from {@see Resource} extractors (XML, YAML).
 *
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 * @experimental
 */
final class ExtractorResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    use DeprecationMetadataTrait;
    private $extractor;
    private $decorated;
    private $defaults;

    public function __construct(ResourceExtractorInterface $extractor, ResourceMetadataCollectionFactoryInterface $decorated = null, array $defaults = [])
    {
        $this->extractor = $extractor;
        $this->decorated = $decorated;
        $this->defaults = $defaults;
    }

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

        if (!(class_exists($resourceClass) || interface_exists($resourceClass)) || !$resources = $this->extractor->getResources()[$resourceClass] ?? false) {
            return $resourceMetadataCollection;
        }

        foreach ($this->buildResources($resources, $resourceClass) as $i => $resource) {
            foreach ($this->defaults['attributes'] ?? [] as $key => $value) {
                if (method_exists($resource, 'get'.ucfirst($key)) && !$resource->{'get'.ucfirst($key)}()) {
                    $resource = $resource->{'with'.ucfirst($key)}($value);
                }
            }

            $resourceMetadataCollection[$i] = $resource;
        }

        return $resourceMetadataCollection;
    }

    /**
     * Builds resources to support:.
     *
     * @return ApiResource[]
     */
    private function buildResources(array $nodes, string $resourceClass): array
    {
        $shortName = (false !== $pos = strrpos($resourceClass, '\\')) ? substr($resourceClass, $pos + 1) : $resourceClass;
        $resources = [];
        foreach ($nodes as $node) {
            $resource = (new ApiResource())
                ->withShortName($shortName)
                ->withClass($resourceClass);
            foreach ($node as $key => $value) {
                $methodName = 'with'.ucfirst($key);
                if ('operations' !== $key && null !== $value && method_exists($resource, $methodName)) {
                    $resource = $resource->{$methodName}($value);
                }
            }

            if (isset($node['graphQlOperations'])) {
                $resource = $resource->withGraphQlOperations($this->buildGraphQlOperations($node['graphQlOperations'], $resource));
            }

            $resources[] = $resource->withOperations(new Operations($this->buildOperations($node['operations'] ?? null, $resource)));
        }

        return $resources;
    }

    private function buildOperations(?array $data, ApiResource $resource): array
    {
        $operations = [];

        if (null === $data) {
            foreach ([new Get(), new GetCollection(), new Post(), new Put(), new Patch(), new Delete()] as $operation) {
                $operationName = sprintf('_api_%s_%s%s', $resource->getShortName(), strtolower($operation->getMethod()), $operation->isCollection() ? '_collection' : '');
                $operations[$operationName] = $this->getOperationWithDefaults($resource, $operation)->withName($operationName);
            }

            return $operations;
        }

        foreach ($data as $attributes) {
            if (!class_exists($attributes['class'])) {
                throw new \InvalidArgumentException(sprintf('Operation "%s" does not exist.', $attributes['class']));
            }

            /** @var Operation $operation */
            $operation = (new $attributes['class']())->withShortName($resource->getShortName());
            unset($attributes['class']);
            foreach ($attributes as $key => $value) {
                if (null === $value) {
                    continue;
                }

                [$camelCaseKey, $value] = $this->getKeyValue($key, $value);
                $methodName = 'with'.ucfirst($camelCaseKey);

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

                $operation = $operation->withExtraProperties(array_merge($operation->getExtraProperties(), [$key => $value]));
            }

            if (empty($attributes['name'])) {
                $attributes['name'] = sprintf('_api_%s_%s%s', $operation->getUriTemplate() ?: $operation->getShortName(), strtolower($operation->getMethod()), $operation->isCollection() ? '_collection' : '');
            }
            $operations[$attributes['name']] = $this->getOperationWithDefaults($resource, $operation)->withName($attributes['name']);
        }

        return $operations;
    }

    private function buildGraphQlOperations(?array $data, ApiResource $resource): array
    {
        $operations = [];

        foreach ($data as $attributes) {
            /** @var Operation $operation */
            $operation = (new $attributes['graphql_operation_class']())->withShortName($resource->getShortName());
            unset($attributes['graphql_operation_class']);

            foreach ($attributes as $key => $value) {
                if (null === $value) {
                    continue;
                }

                [$camelCaseKey, $value] = $this->getKeyValue($key, $value);
                $methodName = 'with'.ucfirst($camelCaseKey);

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

                $operation = $operation->withExtraProperties(array_merge($operation->getExtraProperties(), [$key => $value]));
            }

            $operations[] = $operation;
        }

        return $operations;
    }

    private function getOperationWithDefaults(ApiResource $resource, Operation $operation): Operation
    {
        foreach (($this->defaults['attributes'] ?? []) as $key => $value) {
            [$key, $value] = $this->getKeyValue($key, $value);
            if (null === $operation->{'get'.ucfirst($key)}()) {
                $operation = $operation->{'with'.ucfirst($key)}($value);
            }
        }

        foreach (get_class_methods($resource) as $methodName) {
            if (0 !== strpos($methodName, 'get')) {
                continue;
            }

            if (!method_exists($operation, $methodName) || null !== $operation->{$methodName}()) {
                continue;
            }

            if (null === ($value = $resource->{$methodName}())) {
                continue;
            }

            $operation = $operation->{'with'.substr($methodName, 3)}($value);
        }

        return $operation;
    }
}

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\Metadata\ApiResource;
17	use ApiPlatform\Metadata\Delete;
18	use ApiPlatform\Metadata\Extractor\ResourceExtractorInterface;
19	use ApiPlatform\Metadata\Get;
20	use ApiPlatform\Metadata\GetCollection;
21	use ApiPlatform\Metadata\Operation;
22	use ApiPlatform\Metadata\Operations;
23	use ApiPlatform\Metadata\Patch;
24	use ApiPlatform\Metadata\Post;
25	use ApiPlatform\Metadata\Put;
26	use ApiPlatform\Metadata\Resource\DeprecationMetadataTrait;
27	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
28
29	/**
30	* Creates a resource metadata from {@see Resource} extractors (XML, YAML).
31	*
32	* @author Vincent Chalamon <vincentchalamon@gmail.com>
33	* @experimental
34	*/
35	final class ExtractorResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
36	{
37	use DeprecationMetadataTrait;
38	private $extractor;
39	private $decorated;
40	private $defaults;
41
42	public function __construct(ResourceExtractorInterface $extractor, ResourceMetadataCollectionFactoryInterface $decorated = null, array $defaults = [])
43	{
44	$this->extractor = $extractor;	41✔
45	$this->decorated = $decorated;	41✔
46	$this->defaults = $defaults;	41✔
47	}	41✔
48
49	/**
50	* {@inheritdoc}
51	*/
52	public function create(string $resourceClass): ResourceMetadataCollection
53	{
54	$resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);	4✔
55	if ($this->decorated) {	4✔
56	$resourceMetadataCollection = $this->decorated->create($resourceClass);	2✔
57	}
58
59	if (!(class_exists($resourceClass) \|\| interface_exists($resourceClass)) \|\| !$resources = $this->extractor->getResources()[$resourceClass] ?? false) {	4✔
60	return $resourceMetadataCollection;	2✔
61	}
62
63	foreach ($this->buildResources($resources, $resourceClass) as $i => $resource) {	3✔
64	foreach ($this->defaults['attributes'] ?? [] as $key => $value) {	3✔
65	if (method_exists($resource, 'get'.ucfirst($key)) && !$resource->{'get'.ucfirst($key)}()) {	1✔
66	$resource = $resource->{'with'.ucfirst($key)}($value);	×
67	}
68	}
69
70	$resourceMetadataCollection[$i] = $resource;	3✔
71	}
72
73	return $resourceMetadataCollection;	3✔
74	}
75
76	/**
77	* Builds resources to support:.
78	*
79	* @return ApiResource[]
80	*/
81	private function buildResources(array $nodes, string $resourceClass): array
82	{
83	$shortName = (false !== $pos = strrpos($resourceClass, '\\')) ? substr($resourceClass, $pos + 1) : $resourceClass;	3✔
84	$resources = [];	3✔
85	foreach ($nodes as $node) {	3✔
86	$resource = (new ApiResource())	3✔
87	->withShortName($shortName)	3✔
88	->withClass($resourceClass);	3✔
89	foreach ($node as $key => $value) {	3✔
90	$methodName = 'with'.ucfirst($key);	3✔
91	if ('operations' !== $key && null !== $value && method_exists($resource, $methodName)) {	3✔
92	$resource = $resource->{$methodName}($value);	3✔
93	}
94	}
95
96	if (isset($node['graphQlOperations'])) {	3✔
97	$resource = $resource->withGraphQlOperations($this->buildGraphQlOperations($node['graphQlOperations'], $resource));	2✔
98	}
99
100	$resources[] = $resource->withOperations(new Operations($this->buildOperations($node['operations'] ?? null, $resource)));	3✔
101	}
102
103	return $resources;	3✔
104	}
105
106	private function buildOperations(?array $data, ApiResource $resource): array
107	{
108	$operations = [];	3✔
109
110	if (null === $data) {	3✔
111	foreach ([new Get(), new GetCollection(), new Post(), new Put(), new Patch(), new Delete()] as $operation) {	3✔
112	$operationName = sprintf('_api_%s_%s%s', $resource->getShortName(), strtolower($operation->getMethod()), $operation->isCollection() ? '_collection' : '');	3✔
113	$operations[$operationName] = $this->getOperationWithDefaults($resource, $operation)->withName($operationName);	3✔
114	}
115
116	return $operations;	3✔
117	}
118
119	foreach ($data as $attributes) {	3✔
120	if (!class_exists($attributes['class'])) {	3✔
121	throw new \InvalidArgumentException(sprintf('Operation "%s" does not exist.', $attributes['class']));	×
122	}
123
124	/** @var Operation $operation */
125	$operation = (new $attributes['class']())->withShortName($resource->getShortName());	3✔
126	unset($attributes['class']);	3✔
127	foreach ($attributes as $key => $value) {	3✔
128	if (null === $value) {	3✔
129	continue;	3✔
130	}
131
132	[$camelCaseKey, $value] = $this->getKeyValue($key, $value);	3✔
133	$methodName = 'with'.ucfirst($camelCaseKey);	3✔
134
135	if (method_exists($operation, $methodName)) {	3✔
136	$operation = $operation->{$methodName}($value);	3✔
137	continue;	3✔
138	}
139
140	$operation = $operation->withExtraProperties(array_merge($operation->getExtraProperties(), [$key => $value]));	×
141	}
142
143	if (empty($attributes['name'])) {	3✔
144	$attributes['name'] = sprintf('_api_%s_%s%s', $operation->getUriTemplate() ?: $operation->getShortName(), strtolower($operation->getMethod()), $operation->isCollection() ? '_collection' : '');	3✔
145	}
146	$operations[$attributes['name']] = $this->getOperationWithDefaults($resource, $operation)->withName($attributes['name']);	3✔
147	}
148
149	return $operations;	3✔
150	}
151
152	private function buildGraphQlOperations(?array $data, ApiResource $resource): array
153	{
154	$operations = [];	2✔
155
156	foreach ($data as $attributes) {	2✔
157	/** @var Operation $operation */
158	$operation = (new $attributes['graphql_operation_class']())->withShortName($resource->getShortName());	2✔
159	unset($attributes['graphql_operation_class']);	2✔
160
161	foreach ($attributes as $key => $value) {	2✔
162	if (null === $value) {	2✔
163	continue;	2✔
164	}
165
166	[$camelCaseKey, $value] = $this->getKeyValue($key, $value);	2✔
167	$methodName = 'with'.ucfirst($camelCaseKey);	2✔
168
169	if (method_exists($operation, $methodName)) {	2✔
170	$operation = $operation->{$methodName}($value);	2✔
171	continue;	2✔
172	}
173
174	$operation = $operation->withExtraProperties(array_merge($operation->getExtraProperties(), [$key => $value]));	×
175	}
176
177	$operations[] = $operation;	2✔
178	}
179
180	return $operations;	2✔
181	}
182
183	private function getOperationWithDefaults(ApiResource $resource, Operation $operation): Operation
184	{
185	foreach (($this->defaults['attributes'] ?? []) as $key => $value) {	3✔
186	[$key, $value] = $this->getKeyValue($key, $value);	1✔
187	if (null === $operation->{'get'.ucfirst($key)}()) {	1✔
188	$operation = $operation->{'with'.ucfirst($key)}($value);	1✔
189	}
190	}
191
192	foreach (get_class_methods($resource) as $methodName) {	3✔
193	if (0 !== strpos($methodName, 'get')) {	3✔
194	continue;	3✔
195	}
196
197	if (!method_exists($operation, $methodName) \|\| null !== $operation->{$methodName}()) {	3✔
198	continue;	3✔
199	}
200
201	if (null === ($value = $resource->{$methodName}())) {	3✔
202	continue;	3✔
203	}
204
205	$operation = $operation->{'with'.substr($methodName, 3)}($value);	3✔
206	}
207
208	return $operation;	3✔
209	}
210	}

api-platform / core / #28250

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