fix: do not add a doctrine relation if it is a mapped superclass (#370)

Author: alanpoulain

src/AttributeGenerator/DoctrineMongoDBAttributeGenerator.php

@@ -113,9 +113,7 @@ public function generatePropertyAttributes(Property $property, string $className
             return [new Attribute('MongoDB\Field', ['type' => $type])];
         }
 
-        if (null === $relationName = $this->getRelationName($property->reference)) {
-            $this->logger ? $this->logger->error('There is no reference for the property "{property}" from the class "{class}"', ['property' => $property->name(), 'class' => $className]) : null;
-
+        if (null === $relationName = $this->getRelationName($property, $className)) {
             return [];
         }
 
@@ -146,9 +144,23 @@ public function generateUses(Class_ $class): array
     /**
      * Gets class or interface name to use in relations.
      */
-    private function getRelationName(?Class_ $reference): ?string
+    private function getRelationName(Property $property, string $className): ?string
     {
+        $reference = $property->reference;
+
         if (!$reference) {
+            $this->logger ? $this->logger->error('There is no reference for the property "{property}" from the class "{class}"', ['property' => $property->name(), 'class' => $className]) : null;
+
+            return null;
+        }
+
+        if ($reference->isAbstract && !$this->config['doctrine']['inheritanceAttributes']) {
+            $this->logger ? $this->logger->warning(
+                <<<'EOD'
+                Cannot create a relation from the property "{property}" of the class "{class}" to the class "{referenceClass}" because the latter is a Mapped Superclass.
+                If you want to add a relation anyway, use an inheritance mapping strategy and a discriminator column to do so.
+                EOD, ['property' => $property->name(), 'class' => $className, 'referenceClass' => $reference->shortName()]) : null;
+
             return null;
         }
 

src/AttributeGenerator/DoctrineOrmAttributeGenerator.php

@@ -170,9 +170,7 @@ public function generatePropertyAttributes(Property $property, string $className
             return [new Attribute('ORM\Column', $args)];
         }
 
-        if (null === $relationName = $this->getRelationName($property->reference)) {
-            $this->logger ? $this->logger->error('There is no reference for the property "{property}" from the class "{class}"', ['property' => $property->name(), 'class' => $className]) : null;
-
+        if (null === $relationName = $this->getRelationName($property, $className)) {
             return [];
         }
 
@@ -276,9 +274,23 @@ private function generateIdAttributes(): array
     /**
      * Gets class or interface name to use in relations.
      */
-    private function getRelationName(?Class_ $reference): ?string
+    private function getRelationName(Property $property, string $className): ?string
     {
+        $reference = $property->reference;
+
         if (!$reference) {
+            $this->logger ? $this->logger->error('There is no reference for the property "{property}" from the class "{class}"', ['property' => $property->name(), 'class' => $className]) : null;
+
+            return null;
+        }
+
+        if ($reference->isAbstract && !$this->config['doctrine']['inheritanceAttributes']) {
+            $this->logger ? $this->logger->warning(
+                <<<'EOD'
+                Cannot create a relation from the property "{property}" of the class "{class}" to the class "{referenceClass}" because the latter is a Mapped Superclass.
+                If you want to add a relation anyway, use an inheritance mapping strategy and a discriminator column to do so.
+                EOD, ['property' => $property->name(), 'class' => $className, 'referenceClass' => $reference->shortName()]) : null;
+
             return null;
         }
 

tests/AttributeGenerator/DoctrineMongoDBAttributeGeneratorTest.php

@@ -24,11 +24,16 @@
 use EasyRdf\Graph as RdfGraph;
 use EasyRdf\Resource as RdfResource;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\String\Inflector\EnglishInflector;
 
 class DoctrineMongoDBAttributeGeneratorTest extends TestCase
 {
+    use ProphecyTrait;
+
     private DoctrineMongoDBAttributeGenerator $generator;
 
     private array $classMap = [];
@@ -66,6 +71,11 @@ protected function setUp(): void
         $weightProperty->range = new RdfResource('http://www.w3.org/2001/XMLSchema#nonPositiveInteger');
         $weightProperty->type = 'nonPositiveInteger';
         $vehicle->addProperty($weightProperty);
+        $productProperty = new Property('product');
+        $productProperty->rangeName = 'Product';
+        $productProperty->range = new RdfResource('https://schema.org/Product');
+        $productProperty->reference = $product;
+        $vehicle->addProperty($productProperty);
         $relationProperty = new Property('relation');
         $relationProperty->rangeName = 'Person';
         $relationProperty->range = new RdfResource('https://schema.org/Person');
@@ -145,4 +155,13 @@ public function testGenerateFieldAttributes(): void
             $this->generator->generatePropertyAttributes($this->classMap['Vehicle']->getPropertyByName('relations'), 'Vehicle')
         );
     }
+
+    public function testGenerateAbstractRelation(): void
+    {
+        $loggerProphecy = $this->prophesize(LoggerInterface::class);
+        $loggerProphecy->warning(Argument::cetera())->shouldBeCalledOnce();
+        $this->generator->setLogger($loggerProphecy->reveal());
+
+        $this->assertSame([], $this->generator->generatePropertyAttributes($this->classMap['Vehicle']->getPropertyByName('product'), 'Vehicle'));
+    }
 }

tests/AttributeGenerator/DoctrineOrmAttributeGeneratorTest.php

@@ -24,6 +24,9 @@
 use EasyRdf\Graph as RdfGraph;
 use EasyRdf\Resource as RdfResource;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\String\Inflector\EnglishInflector;
 
@@ -32,6 +35,8 @@
  */
 class DoctrineOrmAttributeGeneratorTest extends TestCase
 {
+    use ProphecyTrait;
+
     private DoctrineOrmAttributeGenerator $generator;
 
     private array $classMap = [];
@@ -76,6 +81,11 @@ protected function setUp(): void
         $prefixedWeightProperty->range = new RdfResource('https://schema.org/QuantitativeValue');
         $prefixedWeightProperty->reference = new SchemaClass('QuantitativeValue', new RdfResource('htts://schema.org/QuantitativeValue', $graph));
         $vehicle->addProperty($prefixedWeightProperty);
+        $productProperty = new Property('product');
+        $productProperty->rangeName = 'Product';
+        $productProperty->range = new RdfResource('https://schema.org/Product');
+        $productProperty->reference = $product;
+        $vehicle->addProperty($productProperty);
         $relation01Property = new Property('relation0_1');
         $relation01Property->rangeName = 'QuantitativeValue';
         $relation01Property->range = new RdfResource('https://schema.org/QuantitativeValue');
@@ -216,4 +226,13 @@ public function testGenerateFieldAttributes(): void
             $this->generator->generatePropertyAttributes($this->classMap['Vehicle']->getPropertyByName('relationN_N'), 'Vehicle')
         );
     }
+
+    public function testGenerateAbstractRelation(): void
+    {
+        $loggerProphecy = $this->prophesize(LoggerInterface::class);
+        $loggerProphecy->warning(Argument::cetera())->shouldBeCalledOnce();
+        $this->generator->setLogger($loggerProphecy->reveal());
+
+        $this->assertSame([], $this->generator->generatePropertyAttributes($this->classMap['Vehicle']->getPropertyByName('product'), 'Vehicle'));
+    }
 }

tests/e2e/customized/App/Schema/Entity/Person.php

@@ -139,6 +139,14 @@ class Person extends MyCustomClass implements MyCustomInterface
     #[ApiProperty(iri: 'https://schema.org/siblings')]
     private ?Collection $siblings = null;
 
+    /**
+     * Of a \[\[Person\]\], and less typically of an \[\[Organization\]\], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or \[\[JobPosting\]\] descriptions.
+     *
+     * @see https://schema.org/knowsAbout
+     */
+    #[ApiProperty(iri: 'https://schema.org/knowsAbout')]
+    private ?Thing $knowsAbout = null;
+
     /** @see _:customColumn */
     #[ORM\Column(type: 'decimal', precision: 5, scale: 1, options: ['comment' => 'my comment'])]
     private ?Person $customColumn = null;
@@ -266,6 +274,16 @@ public function getSiblings(): Collection
         return $this->siblings;
     }
 
+    public function setKnowsAbout(?Thing $knowsAbout): void
+    {
+        $this->knowsAbout = $knowsAbout;
+    }
+
+    public function getKnowsAbout(): ?Thing
+    {
+        return $this->knowsAbout;
+    }
+
     public function setCustomColumn(?Person $customColumn): void
     {
         $this->customColumn = $customColumn;

tests/e2e/original/App/Schema/Entity/Person.php

@@ -130,6 +130,14 @@ class Person extends Thing
     #[ApiProperty(iri: 'https://schema.org/siblings')]
     private ?Collection $siblings = null;
 
+    /**
+     * Of a \[\[Person\]\], and less typically of an \[\[Organization\]\], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or \[\[JobPosting\]\] descriptions.
+     *
+     * @see https://schema.org/knowsAbout
+     */
+    #[ApiProperty(iri: 'https://schema.org/knowsAbout')]
+    private ?Thing $knowsAbout = null;
+
     /**
      * @see _:customColumn
      */
@@ -254,6 +262,16 @@ public function getSiblings(): Collection
         return $this->siblings;
     }
 
+    public function setKnowsAbout(?Thing $knowsAbout): void
+    {
+        $this->knowsAbout = $knowsAbout;
+    }
+
+    public function getKnowsAbout(): ?Thing
+    {
+        return $this->knowsAbout;
+    }
+
     public function setCustomColumn(?Person $customColumn): void
     {
         $this->customColumn = $customColumn;

tests/e2e/schema.yml

@@ -35,6 +35,7 @@ types:
             email: { unique: true, security: "is_granted('ROLE_ADMIN')" }
             url: ~
             siblings: { cardinality: "(0..*)" }
+            knowsAbout: { range: https://schema.org/Thing }
             customColumn: { ormColumn: {type: "decimal", precision: 5, scale: 1, options: {comment: "my comment"}} }
     Brand:
         properties: