10943429050

Committed 19 Sep 2024 02:48PM UTC coverage: 7.647% (-0.03%) from 7.675%

Build # 10943429050

Build Type

push

github

Committed by

web-flow

Commit Message

feat: api-platform/json-hal component (#6621)

* feat: add hal support for laravel

* feat: quick review

* fix: typo & cs-fixer

* fix: typo in composer.json

* fix: cs-fixer & phpstan

* fix: forgot about hal item normalizer, therefore there's no more createbook nor updatebook test as Hal is a readonly format

Run Details

0 of 94 new or added lines in 2 files covered. (0.0%)

9082 existing lines in 291 files now uncovered.

12629 of 165144 relevant lines covered (7.65%)

22.89 hits per line

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

72.73

/src/JsonSchema/ResourceMetadataTrait.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\JsonSchema;

use ApiPlatform\Metadata\CollectionOperationInterface;
use ApiPlatform\Metadata\Exception\OperationNotFoundException;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\Metadata\Util\ResourceClassInfoTrait;

/**
 * @internal
 */
trait ResourceMetadataTrait
{
    use ResourceClassInfoTrait;

    private function findOutputClass(string $className, string $type, Operation $operation, ?array $serializerContext): ?string
    {
        $inputOrOutput = ['class' => $className];
        $inputOrOutput = Schema::TYPE_OUTPUT === $type ? ($operation->getOutput() ?? $inputOrOutput) : ($operation->getInput() ?? $inputOrOutput);
        $forceSubschema = $serializerContext[SchemaFactory::FORCE_SUBSCHEMA] ?? false;

        return $forceSubschema ? ($inputOrOutput['class'] ?? $inputOrOutput->class ?? $operation->getClass()) : ($inputOrOutput['class'] ?? $inputOrOutput->class ?? null);
    }

    private function findOperation(string $className, string $type, ?Operation $operation, ?array $serializerContext): Operation
    {
        if (null === $operation) {
            if (null === $this->resourceMetadataFactory) {
                return new HttpOperation();
            }
            $resourceMetadataCollection = $this->resourceMetadataFactory->create($className);

            try {
                $operation = $resourceMetadataCollection->getOperation();
            } catch (OperationNotFoundException $e) {
                $operation = new HttpOperation();
            }
            $forceSubschema = $serializerContext[SchemaFactory::FORCE_SUBSCHEMA] ?? false;
            if ($operation->getShortName() === $this->getShortClassName($className) && $forceSubschema) {
                $operation = new HttpOperation();
            }

            return $this->findOperationForType($resourceMetadataCollection, $type, $operation);
        }

        // The best here is to use an Operation when calling `buildSchema`, we try to do a smart guess otherwise
        if ($this->resourceMetadataFactory && !$operation->getClass()) {
            $resourceMetadataCollection = $this->resourceMetadataFactory->create($className);

            if ($operation->getName()) {
                return $resourceMetadataCollection->getOperation($operation->getName());
            }

            return $this->findOperationForType($resourceMetadataCollection, $type, $operation);
        }

        return $operation;
    }

    private function findOperationForType(ResourceMetadataCollection $resourceMetadataCollection, string $type, Operation $operation): Operation
    {
        // Find the operation and use the first one that matches criterias
        foreach ($resourceMetadataCollection as $resourceMetadata) {
            foreach ($resourceMetadata->getOperations() ?? [] as $op) {
                if ($operation instanceof CollectionOperationInterface && $op instanceof CollectionOperationInterface) {
                    $operation = $op;
                    break 2;
                }

                if (Schema::TYPE_INPUT === $type && \in_array($op->getMethod(), ['POST', 'PATCH', 'PUT'], true)) {
                    $operation = $op;
                    break 2;
                }
            }
        }

        return $operation;
    }

    private function getSerializerContext(Operation $operation, string $type = Schema::TYPE_OUTPUT): array
    {
        return Schema::TYPE_OUTPUT === $type ? ($operation->getNormalizationContext() ?? []) : ($operation->getDenormalizationContext() ?? []);
    }

    private function getShortClassName(string $fullyQualifiedName): string
    {
        $parts = explode('\\', $fullyQualifiedName);

        return end($parts);
    }
}

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\JsonSchema;
15
16	use ApiPlatform\Metadata\CollectionOperationInterface;
17	use ApiPlatform\Metadata\Exception\OperationNotFoundException;
18	use ApiPlatform\Metadata\HttpOperation;
19	use ApiPlatform\Metadata\Operation;
20	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
21	use ApiPlatform\Metadata\Util\ResourceClassInfoTrait;
22
23	/**
24	* @internal
25	*/
26	trait ResourceMetadataTrait
27	{
28	use ResourceClassInfoTrait;
29
30	private function findOutputClass(string $className, string $type, Operation $operation, ?array $serializerContext): ?string
31	{
UNCOV 32	$inputOrOutput = ['class' => $className];	39✔
UNCOV 33	$inputOrOutput = Schema::TYPE_OUTPUT === $type ? ($operation->getOutput() ?? $inputOrOutput) : ($operation->getInput() ?? $inputOrOutput);	39✔
UNCOV 34	$forceSubschema = $serializerContext[SchemaFactory::FORCE_SUBSCHEMA] ?? false;	39✔
35
UNCOV 36	return $forceSubschema ? ($inputOrOutput['class'] ?? $inputOrOutput->class ?? $operation->getClass()) : ($inputOrOutput['class'] ?? $inputOrOutput->class ?? null);	39✔
37	}
38
39	private function findOperation(string $className, string $type, ?Operation $operation, ?array $serializerContext): Operation
40	{
UNCOV 41	if (null === $operation) {	39✔
UNCOV 42	if (null === $this->resourceMetadataFactory) {	39✔
43	return new HttpOperation();	×
44	}
UNCOV 45	$resourceMetadataCollection = $this->resourceMetadataFactory->create($className);	39✔
46
47	try {
UNCOV 48	$operation = $resourceMetadataCollection->getOperation();	39✔
49	} catch (OperationNotFoundException $e) {	×
50	$operation = new HttpOperation();	×
51	}
UNCOV 52	$forceSubschema = $serializerContext[SchemaFactory::FORCE_SUBSCHEMA] ?? false;	39✔
UNCOV 53	if ($operation->getShortName() === $this->getShortClassName($className) && $forceSubschema) {	39✔
UNCOV 54	$operation = new HttpOperation();	39✔
55	}
56
UNCOV 57	return $this->findOperationForType($resourceMetadataCollection, $type, $operation);	39✔
58	}
59
60	// The best here is to use an Operation when calling `buildSchema`, we try to do a smart guess otherwise
UNCOV 61	if ($this->resourceMetadataFactory && !$operation->getClass()) {	39✔
62	$resourceMetadataCollection = $this->resourceMetadataFactory->create($className);	×
63
64	if ($operation->getName()) {	×
65	return $resourceMetadataCollection->getOperation($operation->getName());	×
66	}
67
68	return $this->findOperationForType($resourceMetadataCollection, $type, $operation);	×
69	}
70
UNCOV 71	return $operation;	39✔
72	}
73
74	private function findOperationForType(ResourceMetadataCollection $resourceMetadataCollection, string $type, Operation $operation): Operation
75	{
76	// Find the operation and use the first one that matches criterias
UNCOV 77	foreach ($resourceMetadataCollection as $resourceMetadata) {	39✔
UNCOV 78	foreach ($resourceMetadata->getOperations() ?? [] as $op) {	39✔
UNCOV 79	if ($operation instanceof CollectionOperationInterface && $op instanceof CollectionOperationInterface) {	39✔
80	$operation = $op;	×
81	break 2;	×
82	}
83
UNCOV 84	if (Schema::TYPE_INPUT === $type && \in_array($op->getMethod(), ['POST', 'PATCH', 'PUT'], true)) {	39✔
UNCOV 85	$operation = $op;	39✔
UNCOV 86	break 2;	39✔
87	}
88	}
89	}
90
UNCOV 91	return $operation;	39✔
92	}
93
94	private function getSerializerContext(Operation $operation, string $type = Schema::TYPE_OUTPUT): array
95	{
UNCOV 96	return Schema::TYPE_OUTPUT === $type ? ($operation->getNormalizationContext() ?? []) : ($operation->getDenormalizationContext() ?? []);	39✔
97	}
98
99	private function getShortClassName(string $fullyQualifiedName): string
100	{
UNCOV 101	$parts = explode('\\', $fullyQualifiedName);	39✔
102
UNCOV 103	return end($parts);	39✔
104	}
105	}

api-platform / core / 10943429050

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