#26821

pending completion

Build # #26821

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/b9f794ea4d539f29c2d2a5354739c200fed0026c">b9f794ea4<a href="https://github.com/api-platform/core/commit/b9f794ea4d539f29c2d2a5354739c200fed0026c">">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/6fb68e1750bef8d761b59df80d5d3edf19773a5a">6fb68e175</a>">6fb68e175</a><a href="https://github.com/api-platform/core/commit/b9f794ea4d539f29c2d2a5354739c200fed0026c"> into 4717bd564">4717bd564</a>

Run Details

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

9621 of 11587 relevant lines covered (83.03%)

14.27 hits per line

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

93.88

/src/Bridge/Symfony/Validator/Metadata/Property/ValidatorPropertyMetadataFactory.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\Bridge\Symfony\Validator\Metadata\Property;

use ApiPlatform\Core\Bridge\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaRestrictionMetadataInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\AtLeastOneOf;
use Symfony\Component\Validator\Constraints\Bic;
use Symfony\Component\Validator\Constraints\CardScheme;
use Symfony\Component\Validator\Constraints\Composite;
use Symfony\Component\Validator\Constraints\Currency;
use Symfony\Component\Validator\Constraints\Date;
use Symfony\Component\Validator\Constraints\DateTime;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\File;
use Symfony\Component\Validator\Constraints\Iban;
use Symfony\Component\Validator\Constraints\Image;
use Symfony\Component\Validator\Constraints\Isbn;
use Symfony\Component\Validator\Constraints\Issn;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\NotNull;
use Symfony\Component\Validator\Constraints\Sequentially;
use Symfony\Component\Validator\Constraints\Time;
use Symfony\Component\Validator\Constraints\Url;
use Symfony\Component\Validator\Constraints\Uuid;
use Symfony\Component\Validator\Mapping\ClassMetadataInterface as ValidatorClassMetadataInterface;
use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface as ValidatorMetadataFactoryInterface;
use Symfony\Component\Validator\Mapping\PropertyMetadataInterface as ValidatorPropertyMetadataInterface;

/**
 * Decorates a metadata loader using the validator.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ValidatorPropertyMetadataFactory implements PropertyMetadataFactoryInterface
{
    /**
     * @var string[] A list of constraint classes making the entity required
     */
    public const REQUIRED_CONSTRAINTS = [NotBlank::class, NotNull::class];

    public const SCHEMA_MAPPED_CONSTRAINTS = [
        Url::class => 'http://schema.org/url',
        Email::class => 'http://schema.org/email',
        Uuid::class => 'http://schema.org/identifier',
        CardScheme::class => 'http://schema.org/identifier',
        Bic::class => 'http://schema.org/identifier',
        Iban::class => 'http://schema.org/identifier',
        Date::class => 'http://schema.org/Date',
        DateTime::class => 'http://schema.org/DateTime',
        Time::class => 'http://schema.org/Time',
        Image::class => 'http://schema.org/image',
        File::class => 'http://schema.org/MediaObject',
        Currency::class => 'http://schema.org/priceCurrency',
        Isbn::class => 'http://schema.org/isbn',
        Issn::class => 'http://schema.org/issn',
    ];

    private $decorated;
    private $validatorMetadataFactory;
    /**
     * @var iterable<PropertySchemaRestrictionMetadataInterface>
     */
    private $restrictionsMetadata;

    /**
     * @param PropertySchemaRestrictionMetadataInterface[] $restrictionsMetadata
     */
    public function __construct(ValidatorMetadataFactoryInterface $validatorMetadataFactory, PropertyMetadataFactoryInterface $decorated, iterable $restrictionsMetadata = [])
    {
        $this->validatorMetadataFactory = $validatorMetadataFactory;
        $this->decorated = $decorated;
        $this->restrictionsMetadata = $restrictionsMetadata;
    }

    /**
     * {@inheritdoc}
     */
    public function create(string $resourceClass, string $name, array $options = []): PropertyMetadata
    {
        $propertyMetadata = $this->decorated->create($resourceClass, $name, $options);

        $required = $propertyMetadata->isRequired();
        $iri = $propertyMetadata->getIri();
        $schema = $propertyMetadata->getSchema();

        if (null !== $required && null !== $iri && null !== $schema) {
            return $propertyMetadata;
        }

        $validatorClassMetadata = $this->validatorMetadataFactory->getMetadataFor($resourceClass);

        if (!$validatorClassMetadata instanceof ValidatorClassMetadataInterface) {
            throw new \UnexpectedValueException(sprintf('Validator class metadata expected to be of type "%s".', ValidatorClassMetadataInterface::class));
        }

        $validationGroups = $this->getValidationGroups($validatorClassMetadata, $options);
        $restrictions = [];

        foreach ($validatorClassMetadata->getPropertyMetadata($name) as $validatorPropertyMetadata) {
            foreach ($this->getPropertyConstraints($validatorPropertyMetadata, $validationGroups) as $constraint) {
                if (null === $required && $this->isRequired($constraint)) {
                    $required = true;
                }

                if (null === $iri) {
                    $iri = self::SCHEMA_MAPPED_CONSTRAINTS[\get_class($constraint)] ?? null;
                }

                foreach ($this->restrictionsMetadata as $restrictionMetadata) {
                    if ($restrictionMetadata->supports($constraint, $propertyMetadata)) {
                        $restrictions[] = $restrictionMetadata->create($constraint, $propertyMetadata);
                    }
                }
            }
        }

        $propertyMetadata = $propertyMetadata->withIri($iri)->withRequired($required ?? false);

        if (!empty($restrictions)) {
            if (null === $schema) {
                $schema = [];
            }

            $schema += array_merge(...$restrictions);
            $propertyMetadata = $propertyMetadata->withSchema($schema);
        }

        return $propertyMetadata;
    }

    /**
     * Returns the list of validation groups.
     */
    private function getValidationGroups(ValidatorClassMetadataInterface $classMetadata, array $options): array
    {
        if (isset($options['validation_groups'])) {
            return $options['validation_groups'];
        }

        if (!method_exists($classMetadata, 'getDefaultGroup')) {
            throw new \UnexpectedValueException(sprintf('Validator class metadata expected to have method "%s".', 'getDefaultGroup'));
        }

        return [$classMetadata->getDefaultGroup()];
    }

    /**
     * Tests if the property is required because of its validation groups.
     */
    private function getPropertyConstraints(
        ValidatorPropertyMetadataInterface $validatorPropertyMetadata,
        array $groups
    ): array {
        $constraints = [];

        foreach ($groups as $validationGroup) {
            if (!\is_string($validationGroup)) {
                continue;
            }

            foreach ($validatorPropertyMetadata->findConstraints($validationGroup) as $propertyConstraint) {
                if ($propertyConstraint instanceof Sequentially) {
                    $constraints[] = $propertyConstraint->getNestedContraints();
                } else {
                    $constraints[] = [$propertyConstraint];
                }
            }
        }

        return array_merge([], ...$constraints);
    }

    /**
     * Is this constraint making the related property required?
     */
    private function isRequired(Constraint $constraint): bool
    {
        foreach (self::REQUIRED_CONSTRAINTS as $requiredConstraint) {
            if ($constraint instanceof $requiredConstraint) {
                return true;
            }
        }

        return false;
    }
}

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\Bridge\Symfony\Validator\Metadata\Property;
15
16	use ApiPlatform\Core\Bridge\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaRestrictionMetadataInterface;
17	use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
18	use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
19	use Symfony\Component\Validator\Constraint;
20	use Symfony\Component\Validator\Constraints\AtLeastOneOf;
21	use Symfony\Component\Validator\Constraints\Bic;
22	use Symfony\Component\Validator\Constraints\CardScheme;
23	use Symfony\Component\Validator\Constraints\Composite;
24	use Symfony\Component\Validator\Constraints\Currency;
25	use Symfony\Component\Validator\Constraints\Date;
26	use Symfony\Component\Validator\Constraints\DateTime;
27	use Symfony\Component\Validator\Constraints\Email;
28	use Symfony\Component\Validator\Constraints\File;
29	use Symfony\Component\Validator\Constraints\Iban;
30	use Symfony\Component\Validator\Constraints\Image;
31	use Symfony\Component\Validator\Constraints\Isbn;
32	use Symfony\Component\Validator\Constraints\Issn;
33	use Symfony\Component\Validator\Constraints\NotBlank;
34	use Symfony\Component\Validator\Constraints\NotNull;
35	use Symfony\Component\Validator\Constraints\Sequentially;
36	use Symfony\Component\Validator\Constraints\Time;
37	use Symfony\Component\Validator\Constraints\Url;
38	use Symfony\Component\Validator\Constraints\Uuid;
39	use Symfony\Component\Validator\Mapping\ClassMetadataInterface as ValidatorClassMetadataInterface;
40	use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface as ValidatorMetadataFactoryInterface;
41	use Symfony\Component\Validator\Mapping\PropertyMetadataInterface as ValidatorPropertyMetadataInterface;
42
43	/**
44	* Decorates a metadata loader using the validator.
45	*
46	* @author Kévin Dunglas <dunglas@gmail.com>
47	*/
48	final class ValidatorPropertyMetadataFactory implements PropertyMetadataFactoryInterface
49	{
50	/**
51	* @var string[] A list of constraint classes making the entity required
52	*/
53	public const REQUIRED_CONSTRAINTS = [NotBlank::class, NotNull::class];
54
55	public const SCHEMA_MAPPED_CONSTRAINTS = [
56	Url::class => 'http://schema.org/url',
57	Email::class => 'http://schema.org/email',
58	Uuid::class => 'http://schema.org/identifier',
59	CardScheme::class => 'http://schema.org/identifier',
60	Bic::class => 'http://schema.org/identifier',
61	Iban::class => 'http://schema.org/identifier',
62	Date::class => 'http://schema.org/Date',
63	DateTime::class => 'http://schema.org/DateTime',
64	Time::class => 'http://schema.org/Time',
65	Image::class => 'http://schema.org/image',
66	File::class => 'http://schema.org/MediaObject',
67	Currency::class => 'http://schema.org/priceCurrency',
68	Isbn::class => 'http://schema.org/isbn',
69	Issn::class => 'http://schema.org/issn',
70	];
71
72	private $decorated;
73	private $validatorMetadataFactory;
74	/**
75	* @var iterable<PropertySchemaRestrictionMetadataInterface>
76	*/
77	private $restrictionsMetadata;
78
79	/**
80	* @param PropertySchemaRestrictionMetadataInterface[] $restrictionsMetadata
81	*/
82	public function __construct(ValidatorMetadataFactoryInterface $validatorMetadataFactory, PropertyMetadataFactoryInterface $decorated, iterable $restrictionsMetadata = [])
83	{
84	$this->validatorMetadataFactory = $validatorMetadataFactory;	47✔
85	$this->decorated = $decorated;	47✔
86	$this->restrictionsMetadata = $restrictionsMetadata;	47✔
87	}	47✔
88
89	/**
90	* {@inheritdoc}
91	*/
92	public function create(string $resourceClass, string $name, array $options = []): PropertyMetadata
93	{
94	$propertyMetadata = $this->decorated->create($resourceClass, $name, $options);	17✔
95
96	$required = $propertyMetadata->isRequired();	17✔
97	$iri = $propertyMetadata->getIri();	17✔
98	$schema = $propertyMetadata->getSchema();	17✔
99
100	if (null !== $required && null !== $iri && null !== $schema) {	17✔
101	return $propertyMetadata;	×
102	}
103
104	$validatorClassMetadata = $this->validatorMetadataFactory->getMetadataFor($resourceClass);	17✔
105
106	if (!$validatorClassMetadata instanceof ValidatorClassMetadataInterface) {	17✔
107	throw new \UnexpectedValueException(sprintf('Validator class metadata expected to be of type "%s".', ValidatorClassMetadataInterface::class));	×
108	}
109
110	$validationGroups = $this->getValidationGroups($validatorClassMetadata, $options);	17✔
111	$restrictions = [];	17✔
112
113	foreach ($validatorClassMetadata->getPropertyMetadata($name) as $validatorPropertyMetadata) {	17✔
114	foreach ($this->getPropertyConstraints($validatorPropertyMetadata, $validationGroups) as $constraint) {	14✔
115	if (null === $required && $this->isRequired($constraint)) {	12✔
116	$required = true;	7✔
117	}
118
119	if (null === $iri) {	12✔
120	$iri = self::SCHEMA_MAPPED_CONSTRAINTS[\get_class($constraint)] ?? null;	9✔
121	}
122
123	foreach ($this->restrictionsMetadata as $restrictionMetadata) {	12✔
124	if ($restrictionMetadata->supports($constraint, $propertyMetadata)) {	7✔
125	$restrictions[] = $restrictionMetadata->create($constraint, $propertyMetadata);	7✔
126	}
127	}
128	}
129	}
130
131	$propertyMetadata = $propertyMetadata->withIri($iri)->withRequired($required ?? false);	17✔
132
133	if (!empty($restrictions)) {	17✔
134	if (null === $schema) {	7✔
135	$schema = [];	7✔
136	}
137
138	$schema += array_merge(...$restrictions);	7✔
139	$propertyMetadata = $propertyMetadata->withSchema($schema);	7✔
140	}
141
142	return $propertyMetadata;	17✔
143	}
144
145	/**
146	* Returns the list of validation groups.
147	*/
148	private function getValidationGroups(ValidatorClassMetadataInterface $classMetadata, array $options): array
149	{
150	if (isset($options['validation_groups'])) {	17✔
151	return $options['validation_groups'];	4✔
152	}
153
154	if (!method_exists($classMetadata, 'getDefaultGroup')) {	14✔
155	throw new \UnexpectedValueException(sprintf('Validator class metadata expected to have method "%s".', 'getDefaultGroup'));	×
156	}
157
158	return [$classMetadata->getDefaultGroup()];	14✔
159	}
160
161	/**
162	* Tests if the property is required because of its validation groups.
163	*/
164	private function getPropertyConstraints(
165	ValidatorPropertyMetadataInterface $validatorPropertyMetadata,
166	array $groups
167	): array {
168	$constraints = [];	14✔
169
170	foreach ($groups as $validationGroup) {	14✔
171	if (!\is_string($validationGroup)) {	14✔
172	continue;	1✔
173	}
174
175	foreach ($validatorPropertyMetadata->findConstraints($validationGroup) as $propertyConstraint) {	13✔
176	if ($propertyConstraint instanceof Sequentially) {	12✔
177	$constraints[] = $propertyConstraint->getNestedContraints();	1✔
178	} else {
179	$constraints[] = [$propertyConstraint];	11✔
180	}
181	}
182	}
183
184	return array_merge([], ...$constraints);	14✔
185	}
186
187	/**
188	* Is this constraint making the related property required?
189	*/
190	private function isRequired(Constraint $constraint): bool
191	{
192	foreach (self::REQUIRED_CONSTRAINTS as $requiredConstraint) {	11✔
193	if ($constraint instanceof $requiredConstraint) {	11✔
194	return true;	7✔
195	}
196	}
197
198	return false;	5✔
199	}
200	}

api-platform / core / #26821

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