feat (symfony-validator-bridge): guess IRI from validation constraints

features/jsonld/context.feature

@@ -28,7 +28,7 @@ Feature: JSON-LD contexts generation
             "dummy": "Dummy/dummy",
             "dummyBoolean": "Dummy/dummyBoolean",
             "dummyDate": {
-              "@id": "Dummy/dummyDate",
+              "@id": "http://schema.org/DateTime",
               "@type": "@id"
             },
             "dummyFloat": "Dummy/dummyFloat",

src/Bridge/Symfony/Validator/Metadata/Property/ValidatorPropertyMetadataFactory.php

@@ -16,8 +16,22 @@
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Constraints\Bic;
+use Symfony\Component\Validator\Constraints\CardScheme;
+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\Time;
+use Symfony\Component\Validator\Constraints\Url;
+use Symfony\Component\Validator\Constraints\Uuid;
 use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface as ValidatorMetadataFactoryInterface;
 use Symfony\Component\Validator\Mapping\PropertyMetadataInterface as ValidatorPropertyMetadataInterface;
 
@@ -33,6 +47,23 @@ final class ValidatorPropertyMetadataFactory implements PropertyMetadataFactoryI
      */
     const REQUIRED_CONSTRAINTS = [NotBlank::class, NotNull::class];
 
+    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;
 
@@ -48,26 +79,36 @@ public function __construct(ValidatorMetadataFactoryInterface $validatorMetadata
     public function create(string $resourceClass, string $name, array $options = []): PropertyMetadata
     {
         $propertyMetadata = $this->decorated->create($resourceClass, $name, $options);
-        if (null !== $propertyMetadata->isRequired()) {
+
+        $required = $propertyMetadata->isRequired();
+        $iri = $propertyMetadata->getIri();
+
+        if (null !== $required && null !== $iri) {
             return $propertyMetadata;
         }
 
         $validatorClassMetadata = $this->validatorMetadataFactory->getMetadataFor($resourceClass);
         foreach ($validatorClassMetadata->getPropertyMetadata($name) as $validatorPropertyMetadata) {
-            if (isset($options['validation_groups'])) {
-                return $propertyMetadata->withRequired($this->isRequiredByGroups($validatorPropertyMetadata, $options));
+            if (null === $required && isset($options['validation_groups'])) {
+                $required = $this->isRequiredByGroups($validatorPropertyMetadata, $options);
             }
 
             foreach ($validatorPropertyMetadata->findConstraints($validatorClassMetadata->getDefaultGroup()) as $constraint) {
-                if ($this->isRequired($constraint)) {
-                    return $propertyMetadata->withRequired(true);
+                if (null === $required && $this->isRequired($constraint)) {
+                    $required = true;
                 }
-            }
 
-            return $propertyMetadata->withRequired(false);
+                if (null === $iri) {
+                    $iri = self::SCHEMA_MAPPED_CONSTRAINTS[\get_class($constraint)] ?? null;
+                }
+
+                if (null !== $required && null !== $iri) {
+                    break 2;
+                }
+            }
         }
 
-        return $propertyMetadata->withRequired(false);
+        return $propertyMetadata->withIri($iri)->withRequired($required ?? false);
     }
 
     /**

tests/Bridge/Symfony/Validator/Metadata/Property/ValidatorPropertyMetadataFactoryTest.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Core\Bridge\Symfony\Validator\Metadata\Property\ValidatorPropertyMetadataFactory;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
+use ApiPlatform\Core\Tests\Fixtures\DummyIriWithValidationEntity;
 use ApiPlatform\Core\Tests\Fixtures\DummyValidatedEntity;
 use Doctrine\Common\Annotations\AnnotationReader;
 use PHPUnit\Framework\TestCase;
@@ -58,6 +59,7 @@ public function testCreateWithPropertyWithNotRequiredConstraints()
     {
         $propertyMetadata = new PropertyMetadata(null, 'A dummy date', true, true, null, null, null, false);
         $expectedPropertyMetadata = $propertyMetadata->withRequired(false);
+        $expectedPropertyMetadata = $expectedPropertyMetadata->withIri('http://schema.org/Date');
 
         $decoratedPropertyMetadataFactory = $this->prophesize(PropertyMetadataFactoryInterface::class);
         $decoratedPropertyMetadataFactory->create(DummyValidatedEntity::class, 'dummyDate', [])->willReturn($propertyMetadata)->shouldBeCalled();
@@ -146,7 +148,7 @@ public function testCreateWithPropertyWithNonStringValidationGroupsAndRequiredCo
 
     public function testCreateWithRequiredByDecorated()
     {
-        $propertyMetadata = new PropertyMetadata(null, 'A dummy date', true, true, null, null, true, false);
+        $propertyMetadata = new PropertyMetadata(null, 'A dummy date', true, true, null, null, true, false, 'foo:bar');
         $expectedPropertyMetadata = clone $propertyMetadata;
 
         $decoratedPropertyMetadataFactory = $this->prophesize(PropertyMetadataFactoryInterface::class);
@@ -160,4 +162,42 @@ public function testCreateWithRequiredByDecorated()
         $this->assertInstanceOf(PropertyMetadata::class, $resultedPropertyMetadata);
         $this->assertEquals($expectedPropertyMetadata, $resultedPropertyMetadata);
     }
+
+    public function testCreateWithPropertyWithValidationConstraints()
+    {
+        $validatorClassMetadata = new ClassMetadata(DummyIriWithValidationEntity::class);
+        (new AnnotationLoader(new AnnotationReader()))->loadClassMetadata($validatorClassMetadata);
+
+        $types = [
+            'dummyUrl' => 'http://schema.org/url',
+            'dummyEmail' => 'http://schema.org/email',
+            'dummyUuid' => 'http://schema.org/identifier',
+            'dummyCardScheme' => 'http://schema.org/identifier',
+            'dummyBic' => 'http://schema.org/identifier',
+            'dummyIban' => 'http://schema.org/identifier',
+            'dummyDate' => 'http://schema.org/Date',
+            'dummyDateTime' => 'http://schema.org/DateTime',
+            'dummyTime' => 'http://schema.org/Time',
+            'dummyImage' => 'http://schema.org/image',
+            'dummyFile' => 'http://schema.org/MediaObject',
+            'dummyCurrency' => 'http://schema.org/priceCurrency',
+            'dummyIsbn' => 'http://schema.org/isbn',
+            'dummyIssn' => 'http://schema.org/issn',
+        ];
+
+        $decoratedPropertyMetadataFactory = $this->prophesize(PropertyMetadataFactoryInterface::class);
+        foreach ($types as $property => $iri) {
+            $decoratedPropertyMetadataFactory->create(DummyIriWithValidationEntity::class, $property, [])->willReturn(new PropertyMetadata())->shouldBeCalled();
+        }
+
+        $validatorMetadataFactory = $this->prophesize(MetadataFactoryInterface::class);
+        $validatorMetadataFactory->getMetadataFor(DummyIriWithValidationEntity::class)->willReturn($validatorClassMetadata)->shouldBeCalled();
+
+        $validatorPropertyMetadataFactory = new ValidatorPropertyMetadataFactory($validatorMetadataFactory->reveal(), $decoratedPropertyMetadataFactory->reveal());
+
+        foreach ($types as $property => $iri) {
+            $resultedPropertyMetadata = $validatorPropertyMetadataFactory->create(DummyIriWithValidationEntity::class, $property);
+            $this->assertSame($iri, $resultedPropertyMetadata->getIri());
+        }
+    }
 }

tests/Fixtures/DummyIriWithValidationEntity.php

@@ -0,0 +1,94 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Tests\Fixtures;
+
+use Symfony\Component\Validator\Constraints as Assert;
+
+/**
+ * Dummy Iri filled with validation Entity.
+ *
+ * @author Grégoire Hébert <[email protected]>
+ */
+class DummyIriWithValidationEntity
+{
+    /**
+     * @Assert\Url
+     */
+    public $dummyUrl;
+
+    /**
+     * @Assert\Email
+     */
+    public $dummyEmail;
+
+    /**
+     * @Assert\Uuid
+     */
+    public $dummyUuid;
+
+    /**
+     * @Assert\CardScheme(schemes="MASTERCARD")
+     */
+    public $dummyCardScheme;
+
+    /**
+     * @Assert\Bic
+     */
+    public $dummyBic;
+
+    /**
+     * @Assert\Iban
+     */
+    public $dummyIban;
+
+    /**
+     * @Assert\Date
+     */
+    public $dummyDate;
+
+    /**
+     * @Assert\DateTime
+     */
+    public $dummyDateTime;
+
+    /**
+     * @Assert\Time
+     */
+    public $dummyTime;
+
+    /**
+     * @Assert\Image
+     */
+    public $dummyImage;
+
+    /**
+     * @Assert\File
+     */
+    public $dummyFile;
+
+    /**
+     * @Assert\Currency
+     */
+    public $dummyCurrency;
+
+    /**
+     * @Assert\Isbn
+     */
+    public $dummyIsbn;
+
+    /**
+     * @Assert\Issn
+     */
+    public $dummyIssn;
+}