Add test cases for OneOf composition

Unset model values transferred from failing compositions

Author: wol-soft

src/Model/Property/CompositionPropertyDecorator.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Model\Property;
+
+use PHPModelGenerator\Model\ResolvedDefinitionsCollection;
+
+/**
+ * Class CompositionPropertyDecorator
+ *
+ * @package PHPModelGenerator\Model\Property
+ */
+class CompositionPropertyDecorator extends PropertyProxy
+{
+    private const PROPERTY_KEY = 'composition';
+
+    /**
+     * Store all properties from nested schemas of the composed property validator. If the composition validator fails
+     * all affected properties must be set to null to adopt only valid values in the base model.
+     *
+     * @var PropertyInterface[]
+     */
+    protected $affectedObjectProperties = [];
+
+    /**
+     * CompositionPropertyDecorator constructor.
+     *
+     * @param PropertyInterface $property
+     */
+    public function __construct(PropertyInterface $property)
+    {
+        parent::__construct(new ResolvedDefinitionsCollection([self::PROPERTY_KEY => $property]), self::PROPERTY_KEY);
+    }
+
+    /**
+     * Append an object property which is affected by the composition validator
+     *
+     * @param PropertyInterface $property
+     */
+    public function appendAffectedObjectProperty(PropertyInterface $property)
+    {
+        $this->affectedObjectProperties[] = $property;
+    }
+
+    /**
+     * @return PropertyInterface[]
+     */
+    public function getAffectedObjectProperties(): array
+    {
+        return $this->affectedObjectProperties;
+    }
+}

src/Model/ResolvedDefinitionsCollection.php

@@ -4,68 +4,8 @@
 
 namespace PHPModelGenerator\Model;
 
-class ResolvedDefinitionsCollection
-{
-    protected $t;
-    /**
-     * Whether a offset exists
-     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
-     * @param mixed $offset <p>
-     * An offset to check for.
-     * </p>
-     * @return boolean true on success or false on failure.
-     * </p>
-     * <p>
-     * The return value will be casted to boolean if non-boolean was returned.
-     * @since 5.0.0
-     */
-    public function offsetExists($offset)
-    {
-        return isset($this->t[$offset]);
-    }
-
-    /**
-     * Offset to retrieve
-     * @link http://php.net/manual/en/arrayaccess.offsetget.php
-     * @param mixed $offset <p>
-     * The offset to retrieve.
-     * </p>
-     * @return mixed Can return all value types.
-     * @since 5.0.0
-     */
-    public function offsetGet($offset)
-    {
-        return $this->t[$offset];
-    }
+use ArrayObject;
 
-    /**
-     * Offset to set
-     * @link http://php.net/manual/en/arrayaccess.offsetset.php
-     * @param mixed $offset <p>
-     * The offset to assign the value to.
-     * </p>
-     * @param mixed $value <p>
-     * The value to set.
-     * </p>
-     * @return void
-     * @since 5.0.0
-     */
-    public function offsetSet($offset, $value)
-    {
-        $this->t[$offset] = $value;
-    }
-
-    /**
-     * Offset to unset
-     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
-     * @param mixed $offset <p>
-     * The offset to unset.
-     * </p>
-     * @return void
-     * @since 5.0.0
-     */
-    public function offsetUnset($offset)
-    {
-        unset($this->t[$offset]);
-    }
-}
+class ResolvedDefinitionsCollection extends ArrayObject
+{
+}

src/Model/Validator/ComposedPropertyValidator.php

@@ -5,6 +5,7 @@
 namespace PHPModelGenerator\Model\Validator;
 
 use PHPModelGenerator\Exception\InvalidArgumentException;
+use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
@@ -16,16 +17,16 @@ class ComposedPropertyValidator extends PropertyTemplateValidator
 {
     /** @var string */
     protected $composedProcessor;
-    /** @var PropertyInterface[] */
+    /** @var CompositionPropertyDecorator[] */
     protected $composedProperties;
 
     /**
      * ComposedPropertyValidator constructor.
      *
-     * @param PropertyInterface   $property
-     * @param PropertyInterface[] $composedProperties
-     * @param string              $composedProcessor
-     * @param array               $validatorVariables
+     * @param PropertyInterface              $property
+     * @param CompositionPropertyDecorator[] $composedProperties
+     * @param string                         $composedProcessor
+     * @param array                          $validatorVariables
      */
     public function __construct(
         PropertyInterface $property,
@@ -53,7 +54,7 @@ public function getComposedProcessor(): string
     }
 
     /**
-     * @return PropertyInterface[]
+     * @return CompositionPropertyDecorator[]
      */
     public function getComposedProperties(): array
     {

src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace PHPModelGenerator\PropertyProcessor\ComposedValue;
 
+use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\ComposedPropertyValidator;
@@ -29,14 +32,16 @@ protected function generateValidators(PropertyInterface $property, array $proper
         $properties = [];
 
         foreach ($propertyData['composition'] as $compositionElement) {
-            $compositionProperty = $propertyFactory
-                ->create(
-                    new PropertyCollectionProcessor([$property->getName() => $property->isRequired()]),
-                    $this->schemaProcessor,
-                    $this->schema,
-                    $property->getName(),
-                    $compositionElement
-                );
+            $compositionProperty = new CompositionPropertyDecorator(
+                $propertyFactory
+                    ->create(
+                        new PropertyCollectionProcessor([$property->getName() => $property->isRequired()]),
+                        $this->schemaProcessor,
+                        $this->schema,
+                        $property->getName(),
+                        $compositionElement
+                    )
+            );
 
             $compositionProperty->filterValidators(function (Validator $validator) {
                 return !is_a($validator->getValidator(), RequiredPropertyValidator::class) &&

src/PropertyProcessor/ComposedValue/AllOfProcessor.php

@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\PropertyProcessor\ComposedValue;
 
 /**
- * Class AllofProcessor
+ * Class AllOfProcessor
  *
  * @package PHPModelGenerator\PropertyProcessor\ComposedValue
  */

src/PropertyProcessor/ComposedValue/AnyOfProcessor.php

@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\PropertyProcessor\ComposedValue;
 
 /**
- * Class AnyofProcessor
+ * Class AnyOfProcessor
  *
  * @package PHPModelGenerator\PropertyProcessor\ComposedValue
  */

src/PropertyProcessor/ComposedValue/OneOfProcessor.php

@@ -3,7 +3,7 @@
 namespace PHPModelGenerator\PropertyProcessor\ComposedValue;
 
 /**
- * Class OneofProcessor
+ * Class OneOfProcessor
  *
  * @package PHPModelGenerator\PropertyProcessor\ComposedValue
  */

src/PropertyProcessor/Property/AbstractPropertyProcessor.php

@@ -114,7 +114,7 @@ protected function addComposedValueValidator(PropertyInterface $property, array
                     $property->getName(),
                     [
                         'type' => $composedValueKeyword,
-                        'composition' => $propertyData[$composedValueKeyword]
+                        'composition' => $propertyData[$composedValueKeyword],
                     ]
                 );
 

src/PropertyProcessor/Property/BaseProcessor.php

@@ -197,6 +197,8 @@ protected function transferComposedPropertiesToSchema(PropertyInterface $propert
                                     !is_a($validator->getValidator(), TypeCheckValidator::class);
                             })
                     );
+
+                    $composedProperty->appendAffectedObjectProperty($property);
                 }
             }
         }

src/SchemaProcessor/SchemaProcessor.php

@@ -99,7 +99,9 @@ public function processSchema(
         if ((!isset($jsonSchema['type']) || $jsonSchema['type'] !== 'object') &&
             !array_intersect(array_keys($jsonSchema), ['anyOf', 'allOf', 'oneOf'])
         ) {
-            throw new SchemaException("JSON-Schema doesn't provide an object " . $jsonSchema['id'] ?? '');
+            throw new SchemaException(
+                "JSON-Schema doesn't provide an object or a composition " . $jsonSchema['id'] ?? ''
+            );
         }
 
         return $this->generateModel($classPath, $className, $jsonSchema, $parentDefinitions);