#26534

pending completion

Build # #26534

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/c10f8fa67974112041c67228189d74da97a9ced1">c10f8fa67<a href="https://github.com/api-platform/core/commit/c10f8fa67974112041c67228189d74da97a9ced1">">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/1ca18290898d15b0c5035e49b480a8fc38ba252f">1ca182908</a>">1ca182908</a><a href="https://github.com/api-platform/core/commit/c10f8fa67974112041c67228189d74da97a9ced1"> into fa87557cd">fa87557cd</a>

Run Details

7 of 7 new or added lines in 1 file covered. (100.0%)

9505 of 11452 relevant lines covered (83.0%)

14.87 hits per line

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

96.55

/src/OpenApi/Serializer/OpenApiNormalizer.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\OpenApi\Serializer;

use ApiPlatform\Core\OpenApi\OpenApi;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Generates an OpenAPI v3 specification.
 */
final class OpenApiNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
{
    public const FORMAT = 'json';
    private const EXTENSION_PROPERTIES_KEY = 'extensionProperties';

    private $decorated;

    public function __construct(NormalizerInterface $decorated)
    {
        $this->decorated = $decorated;
    }

    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = null, array $context = []): array
    {
        $context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] = true;
        $context[AbstractObjectNormalizer::SKIP_NULL_VALUES] = true;

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

    private function recursiveClean($data): array
    {
        foreach ($data as $key => $value) {
            if (self::EXTENSION_PROPERTIES_KEY === $key) {
                foreach ($data[self::EXTENSION_PROPERTIES_KEY] as $extensionPropertyKey => $extensionPropertyValue) {
                    $data[$extensionPropertyKey] = $extensionPropertyValue;
                }
                continue;
            }

            if ('schemas' === $key) {
                $this->ksort($value);
            }

            // Side effect of using getPaths(): Paths which itself contains the array
            if ('paths' === $key) {
                $value = $data['paths'] = $data['paths']['paths'];
                if ($value) {
                    $this->ksort($value);
                }
                unset($data['paths']['paths']);
            }

            if (\is_array($value)) {
                $data[$key] = $this->recursiveClean($value);
                // arrays must stay even if empty
                continue;
            }
        }

        unset($data[self::EXTENSION_PROPERTIES_KEY]);

        return $data;
    }

    /**
     * @param \ArrayObject|array|mixed $value
     */
    private function ksort(&$value)
    {
        if ($value instanceof \ArrayObject) {
            $value->ksort();
        } elseif (\is_array($value) && $value) {
            ksort($value);
        }
    }

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

    /**
     * {@inheritdoc}
     */
    public function hasCacheableSupportsMethod(): bool
    {
        return true;
    }
}

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\OpenApi\Serializer;
15
16	use ApiPlatform\Core\OpenApi\OpenApi;
17	use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
18	use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
19	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
20
21	/**
22	* Generates an OpenAPI v3 specification.
23	*/
24	final class OpenApiNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
25	{
26	public const FORMAT = 'json';
27	private const EXTENSION_PROPERTIES_KEY = 'extensionProperties';
28
29	private $decorated;
30
31	public function __construct(NormalizerInterface $decorated)
32	{
33	$this->decorated = $decorated;	32✔
34	}	32✔
35
36	/**
37	* {@inheritdoc}
38	*/
39	public function normalize($object, $format = null, array $context = []): array
40	{
41	$context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] = true;	5✔
42	$context[AbstractObjectNormalizer::SKIP_NULL_VALUES] = true;	5✔
43
44	return $this->recursiveClean($this->decorated->normalize($object, $format, $context));	5✔
45	}
46
47	private function recursiveClean($data): array
48	{
49	foreach ($data as $key => $value) {	5✔
50	if (self::EXTENSION_PROPERTIES_KEY === $key) {	5✔
51	foreach ($data[self::EXTENSION_PROPERTIES_KEY] as $extensionPropertyKey => $extensionPropertyValue) {	5✔
52	$data[$extensionPropertyKey] = $extensionPropertyValue;	1✔
53	}
54	continue;	5✔
55	}
56
57	if ('schemas' === $key) {	5✔
58	$this->ksort($value);	5✔
59	}
60
61	// Side effect of using getPaths(): Paths which itself contains the array
62	if ('paths' === $key) {	5✔
63	$value = $data['paths'] = $data['paths']['paths'];	5✔
64	if ($value) {	5✔
65	$this->ksort($value);	4✔
66	}
67	unset($data['paths']['paths']);	5✔
68	}
69
70	if (\is_array($value)) {	5✔
71	$data[$key] = $this->recursiveClean($value);	5✔
72	// arrays must stay even if empty
73	continue;	5✔
74	}
75	}
76
77	unset($data[self::EXTENSION_PROPERTIES_KEY]);	5✔
78
79	return $data;	5✔
80	}
81
82	/**
83	* @param \ArrayObject\|array\|mixed $value
84	*/
85	private function ksort(&$value)
86	{
87	if ($value instanceof \ArrayObject) {	5✔
88	$value->ksort();	×
89	} elseif (\is_array($value) && $value) {	5✔
90	ksort($value);	5✔
91	}
92	}	5✔
93
94	/**
95	* {@inheritdoc}
96	*/
97	public function supportsNormalization($data, $format = null): bool
98	{
99	return self::FORMAT === $format && $data instanceof OpenApi;	26✔
100	}
101
102	/**
103	* {@inheritdoc}
104	*/
105	public function hasCacheableSupportsMethod(): bool
106	{
107	return true;	26✔
108	}
109	}

api-platform / core / #26534

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