Generate merged properties for property-level composed objects to access all properties

Author: wol-soft

src/Model/Schema.php

@@ -33,9 +33,9 @@ class Schema
      *
      * @param SchemaDefinitionDictionary $dictionary
      */
-    public function __construct(SchemaDefinitionDictionary $dictionary)
+    public function __construct(SchemaDefinitionDictionary $dictionary = null)
     {
-        $this->schemaDefinitionDictionary = $dictionary;
+        $this->schemaDefinitionDictionary = $dictionary ?? new SchemaDefinitionDictionary('');
     }
 
     /**

src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php

@@ -5,10 +5,13 @@
 namespace PHPModelGenerator\PropertyProcessor\ComposedValue;
 
 use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
+use PHPModelGenerator\Model\Property\Property;
 use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\ComposedPropertyValidator;
 use PHPModelGenerator\Model\Validator\RequiredPropertyValidator;
+use PHPModelGenerator\PropertyProcessor\Decorator\Property\ObjectInstantiationDecorator;
 use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\CompositionTypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\Property\AbstractValueProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyCollectionProcessor;
@@ -31,6 +34,7 @@ protected function generateValidators(PropertyInterface $property, array $proper
         $propertyFactory = new PropertyFactory(new PropertyProcessorFactory());
 
         $properties = [];
+        $createMergedProperty = $this instanceof MergedComposedPropertiesInterface;
 
         foreach ($propertyData['propertyData'][$propertyData['type']] as $compositionElement) {
             $compositionProperty = new CompositionPropertyDecorator(
@@ -49,13 +53,23 @@ protected function generateValidators(PropertyInterface $property, array $proper
                     !is_a($validator->getValidator(), ComposedPropertyValidator::class);
             });
 
-            $property->addTypeHintDecorator(new CompositionTypeHintDecorator($compositionProperty));
+            // only create a composed type hint if we aren't a AnyOf or an AllOf processor and the compositionProperty
+            // contains no object. This results in objects being composed each separately for a OneOf processor
+            // (eg. string|ObjectA|ObjectB). For a merged composed property the objects are merged together so it
+            // results in string|MergedObject
+            if (!($createMergedProperty && $compositionProperty->getNestedSchema())) {
+                $property->addTypeHintDecorator(new CompositionTypeHintDecorator($compositionProperty));
+            }
 
             $properties[] = $compositionProperty;
         }
 
         $availableAmount = count($properties);
 
+        if ($createMergedProperty) {
+            $this->createMergedProperty($property, $properties);
+        }
+
         $property->addValidator(
             new ComposedPropertyValidator(
                 $property,
@@ -78,6 +92,43 @@ protected function generateValidators(PropertyInterface $property, array $proper
         );
     }
 
+    /**
+     * TODO: no nested properties --> cancel, only one --> use original model
+     *
+     * Gather all nested object properties and merge them together into a single merged property
+     *
+     * @param PropertyInterface              $property
+     * @param CompositionPropertyDecorator[] $properties
+     *
+     * @return PropertyInterface
+     */
+    private function createMergedProperty(PropertyInterface $property, array $properties): PropertyInterface
+    {
+        $mergedPropertySchema = new Schema();
+        $mergedClassName = sprintf('%s_Merged_%s', $this->schemaProcessor->getCurrentClassName(), uniqid());
+        $mergedProperty = new Property('MergedProperty', $mergedClassName);
+
+        foreach ($properties as $property) {
+            if ($property->getNestedSchema()) {
+                foreach ($property->getNestedSchema()->getProperties() as $nestedProperty) {
+                    $mergedPropertySchema->addProperty($nestedProperty);
+                }
+            }
+        }
+
+        $this->schemaProcessor->generateClassFile(
+            $this->schemaProcessor->getCurrentClassPath(),
+            $mergedClassName,
+            $mergedPropertySchema
+        );
+
+        $property->addTypeHintDecorator(new CompositionTypeHintDecorator($mergedProperty));
+
+        return $mergedProperty
+            ->addDecorator(new ObjectInstantiationDecorator($mergedClassName))
+            ->setNestedSchema($mergedPropertySchema);
+    }
+
     /**
      * @param int $composedElements The amount of elements which are composed together
      *

src/PropertyProcessor/ComposedValue/AllOfProcessor.php

@@ -7,7 +7,9 @@
  *
  * @package PHPModelGenerator\PropertyProcessor\ComposedValue
  */
-class AllOfProcessor extends AbstractComposedValueProcessor implements ComposedPropertiesInterface
+class AllOfProcessor
+    extends AbstractComposedValueProcessor
+    implements ComposedPropertiesInterface, MergedComposedPropertiesInterface
 {
     /**
      * @inheritdoc

src/PropertyProcessor/ComposedValue/AnyOfProcessor.php

@@ -7,7 +7,9 @@
  *
  * @package PHPModelGenerator\PropertyProcessor\ComposedValue
  */
-class AnyOfProcessor extends AbstractComposedValueProcessor implements ComposedPropertiesInterface
+class AnyOfProcessor
+    extends AbstractComposedValueProcessor
+    implements ComposedPropertiesInterface, MergedComposedPropertiesInterface
 {
     /**
      * @inheritdoc

src/PropertyProcessor/ComposedValue/IfProcessor.php

@@ -63,7 +63,6 @@ protected function generateValidators(PropertyInterface $property, array $proper
             $properties[$compositionElement] = $compositionProperty;
         }
 
-        print_r($propertyData['propertyData'], true);
         $property->addValidator(
             new ConditionalPropertyValidator(
                 $property,

src/PropertyProcessor/ComposedValue/MergedComposedPropertiesInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\ComposedValue;
+
+/**
+ * Interface MergedComposedPropertiesInterface
+ *
+ * @package PHPModelGenerator\PropertyProcessor\ComposedValue
+ */
+interface MergedComposedPropertiesInterface
+{
+}

src/SchemaProcessor/SchemaProcessor.php

@@ -143,6 +143,20 @@ protected function generateModel(
             $structure
         );
 
+        $this->generateClassFile($classPath, $className, $schema);
+
+        return $schema;
+    }
+
+    /**
+     * Attach a new class file render job to the render proxy
+     *
+     * @param string $classPath
+     * @param string $className
+     * @param Schema $schema
+     */
+    public function generateClassFile(string $classPath, string $className, Schema $schema): void
+    {
         $fileName = join(
                 DIRECTORY_SEPARATOR,
                 [$this->destination, str_replace('\\', DIRECTORY_SEPARATOR, $classPath), $className]
@@ -157,8 +171,6 @@ protected function generateModel(
         }
 
         $this->generatedFiles[] = $fileName;
-
-        return $schema;
     }
 
     /**

tests/PropertyProcessor/PropertyProcessorFactoryTest.php

@@ -41,7 +41,7 @@ public function testGetPropertyProcessor(string $type, string $expectedClass): v
             $type,
             new PropertyCollectionProcessor(),
             new SchemaProcessor('', '', new GeneratorConfiguration(), new RenderQueue()),
-            new Schema(new SchemaDefinitionDictionary(''))
+            new Schema()
         );
 
         $this->assertInstanceOf($expectedClass, $propertyProcessor);
@@ -79,7 +79,7 @@ public function testGetInvalidPropertyProcessorThrowsAnException()
             'Hello',
             new PropertyCollectionProcessor(),
             new SchemaProcessor('', '', new GeneratorConfiguration(), new RenderQueue()),
-            new Schema(new SchemaDefinitionDictionary(''))
+            new Schema()
         );
     }
 }