Add ReferenceProcessor test cases

Enno Woortmann · Enno Woortmann · commit 775537c6f608 · 2018-11-20T14:17:23.000+01:00
Fix decorator functionality for array items
diff --git a/src/Model/Property/Property.php b/src/Model/Property/Property.php
@@ -153,7 +153,7 @@ public function addDecorator(PropertyDecoratorInterface $decorator): PropertyInt
     public function resolveDecorator(string $input): string
     {
         foreach ($this->decorators as $decorator) {
-            $input = $decorator->decorate($input);
+            $input = $decorator->decorate($input, $this);
         }
 
         return $input;
diff --git a/src/Model/Schema.php b/src/Model/Schema.php
@@ -126,7 +126,7 @@ public function addDefinition(string $key, SchemaDefinition $definition)
      *
      * @return SchemaDefinition
      */
-    public function getDefinition(string $key): SchemaDefinition
+    public function getDefinition(string $key): ?SchemaDefinition
     {
         return $this->definitions[$key] ?? null;
     }
diff --git a/src/PropertyProcessor/Decorator/IntToFloatCastDecorator.php b/src/PropertyProcessor/Decorator/IntToFloatCastDecorator.php
@@ -4,6 +4,8 @@
 
 namespace PHPModelGenerator\PropertyProcessor\Decorator;
 
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
 /**
  * Class IntToFloatCastDecorator
  *
@@ -14,7 +16,7 @@ class IntToFloatCastDecorator implements PropertyDecoratorInterface
     /**
      * @inheritdoc
      */
-    public function decorate(string $input): string
+    public function decorate(string $input, PropertyInterface $property): string
     {
         return "is_int($input) ? (float) $input : $input";
     }
diff --git a/src/PropertyProcessor/Decorator/ObjectInstantiationDecorator.php b/src/PropertyProcessor/Decorator/ObjectInstantiationDecorator.php
@@ -6,6 +6,7 @@
 
 use PHPMicroTemplate\Render;
 use PHPModelGenerator\Exception\InvalidArgumentException;
+use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
  * Class ObjectInstantiationDecorator
@@ -38,13 +39,14 @@ public function __construct(string $className)
     /**
      * @inheritdoc
      */
-    public function decorate(string $input): string
+    public function decorate(string $input, PropertyInterface $property): string
     {
         return static::$renderer->renderTemplate(
             DIRECTORY_SEPARATOR . 'Decorator' . DIRECTORY_SEPARATOR . 'ObjectInstantiationDecorator.phptpl',
             [
                 'input' => $input,
-                'className' => $this->className
+                'className' => $this->className,
+                'property' => $property,
             ]
         );
     }
diff --git a/src/PropertyProcessor/Decorator/PropertyDecoratorInterface.php b/src/PropertyProcessor/Decorator/PropertyDecoratorInterface.php
@@ -4,6 +4,8 @@
 
 namespace PHPModelGenerator\PropertyProcessor\Decorator;
 
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
 /**
  * Interface PropertyDecoratorInterface
  *
@@ -14,11 +16,12 @@ interface PropertyDecoratorInterface
     /**
      * Decorate a given string
      *
-     * @param string $input
+     * @param string            $input
+     * @param PropertyInterface $property The property getting decorated
      *
      * @return string
      */
-    public function decorate(string $input): string;
+    public function decorate(string $input, PropertyInterface $property): string;
 
     /**
      * Return a list of all exception classes which may be thrown by the decorator
diff --git a/src/PropertyProcessor/Decorator/PropertyTransferDecorator.php b/src/PropertyProcessor/Decorator/PropertyTransferDecorator.php
@@ -32,7 +32,7 @@ public function __construct(PropertyInterface $property)
     /**
      * @inheritdoc
      */
-    public function decorate(string $input): string
+    public function decorate(string $input, PropertyInterface $property): string
     {
         return $this->property->resolveDecorator($input);
     }
diff --git a/src/Templates/Decorator/ObjectInstantiationDecorator.phptpl b/src/Templates/Decorator/ObjectInstantiationDecorator.phptpl
@@ -1,6 +1,6 @@
 (is_array($param = {{ input }})
    ? new {{ className }}($param)
    : (function() {
-        throw new InvalidArgumentException('invalid type for property');
+        throw new InvalidArgumentException('invalid type for {{ property.getName() }}');
      })()
 )
diff --git a/src/Templates/Validator/ArrayItem.phptpl b/src/Templates/Validator/ArrayItem.phptpl
@@ -1,9 +1,9 @@
-is_array($value) && (function ($items) {
+is_array($value) && (function (&$items) {
     if (empty($items)) {
         return false;
     }
 
-    foreach ($items as $value) {
+    foreach ($items as &$value) {
         {{ viewHelper.resolvePropertyDecorator(property) }}
 
         {% foreach property.getOrderedValidators() as validator %}
diff --git a/tests/Objects/ArrayPropertyTest.php b/tests/Objects/ArrayPropertyTest.php
@@ -205,14 +205,15 @@ public function invalidItemAmountDataProvider(): array
      * @dataProvider validTypedArrayDataProvider
      *
      * @param string $type
-     * @param $propertyValue
+     * @param        $propertyValue
+     * @param        $expectedValue
      */
-    public function testTypedArrayIsValid(string $type, $propertyValue): void
+    public function testTypedArrayIsValid(string $type, $propertyValue, $expectedValue = null): void
     {
         $className = $this->generateObjectFromFileTemplate('ArrayPropertyTyped.json', [$type], null, false);
 
         $object = new $className(['property' => $propertyValue]);
-        $this->assertSame($propertyValue, $object->getProperty());
+        $this->assertSame($expectedValue ?? $propertyValue, $object->getProperty());
     }
 
     public function validTypedArrayDataProvider(): array
@@ -224,7 +225,8 @@ public function validTypedArrayDataProvider(): array
             'String array with null' => ['string', ['a', 'b', null]],
             'Int array' => ['int', [1, 2, 3]],
             'Int array with null' => ['int', [1, 2, 3, null]],
-            'Number array' => ['number', [1, 1.1, 4.5, 6]],
+            // Number array will cast int to float
+            'Number array' => ['number', [1, 1.1, 4.5, 6], [1.0, 1.1, 4.5, 6.0]],
             'Boolean array' => ['boolean', [true, false, true]],
             'Null array' => ['null', [null, null]],
             'Nested array' => ['array","items":{"type":"int"},"injection":"yes we can', [[1, 2], [], [3], null]]
diff --git a/tests/Objects/ObjectPropertyTest.php b/tests/Objects/ObjectPropertyTest.php
@@ -10,7 +10,7 @@
 use stdClass;
 
 /**
- * Class AnyPropertyTest
+ * Class ObjectPropertyTest
  *
  * @package PHPModelGenerator\Tests\Objects
  */
diff --git a/tests/Objects/ReferencePropertyTest.php b/tests/Objects/ReferencePropertyTest.php
@@ -0,0 +1,221 @@
+<?php
+
+namespace PHPModelGenerator\Tests\Objects;
+
+use PHPModelGenerator\Exception\FileSystemException;
+use PHPModelGenerator\Exception\InvalidArgumentException;
+use PHPModelGenerator\Exception\RenderException;
+use PHPModelGenerator\Exception\SchemaException;
+use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
+use stdClass;
+
+/**
+ * Class ReferencePropertyTest
+ *
+ * @package PHPModelGenerator\Tests\Objects
+ */
+class ReferencePropertyTest extends AbstractPHPModelGeneratorTest
+{
+    /**
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    public function testNotResolvedReferenceThrowsAnException(): void
+    {
+        $this->expectException(SchemaException::class);
+        $this->expectExceptionMessage('Unresolved Reference: #/definitions/person');
+
+        $this->generateObjectFromFile('NotResolvedReference.json');
+    }
+
+    /**
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    public function testNotProvidedOptionalReferenceObjectPropertyIsValid(): void
+    {
+        $className = $this->generateObjectFromFile('ObjectReference.json');
+
+        $object = new $className([]);
+        $this->assertNull($object->getPerson());
+    }
+
+    /**
+     * @dataProvider validReferenceObjectInputProvider
+     *
+     * @param array  $input
+     * @param string $typeCheck
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    public function testProvidedReferenceObjectPropertyIsValid(?array $input, string $typeCheck): void
+    {
+        $className = $this->generateObjectFromFile('ObjectReference.json');
+
+        $object = new $className(['person' => $input]);
+        $this->assertTrue(('is_' . $typeCheck)($object->getPerson()));
+
+        if ($object->getPerson() !== null) {
+            $this->assertSame($input['name'] ?? null, ($object->getPerson()->getName()));
+            $this->assertSame($input['age'] ?? null, ($object->getPerson()->getAge()));
+            $this->assertSame($input, ($object->getPerson()->getRawModelDataInput()));
+        }
+    }
+
+    public function validReferenceObjectInputProvider(): array
+    {
+        return [
+            'Empty object' => [[], 'object'],
+            'Object with property' => [['name' => 'Hannes', 'age' => 42, 'stringProperty' => 'Hello'], 'object'],
+            'Null' => [null, 'null'],
+        ];
+    }
+
+    /**
+     * @dataProvider invalidReferenceObjectPropertyTypeDataProvider
+     *
+     * @param $propertyValue
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    public function testInvalidReferenceObjectPropertyTypeThrowsAnException($propertyValue): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('invalid type for person');
+
+        $className = $this->generateObjectFromFile('ObjectReference.json');
+
+        new $className(['person' => $propertyValue]);
+    }
+
+    public function invalidReferenceObjectPropertyTypeDataProvider(): array
+    {
+        return [
+            'bool' => [true],
+            'float' => [0.92],
+            'int' => [2],
+            'object' => [new stdClass()],
+            'string' => ['1']
+        ];
+    }
+
+    /**
+     * @dataProvider validReferenceIntInputProvider
+     *
+     * @param int|null $input
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    public function testProvidedReferenceIntPropertyIsValid(?int $input): void
+    {
+        $className = $this->generateObjectFromFile('IntReference.json');
+
+        $object = new $className(['year' => $input]);
+        $this->assertSame($input, $object->getYear());
+    }
+
+    public function validReferenceIntInputProvider(): array
+    {
+        return [
+            'Null' => [null],
+            'Upper limit' => [2000],
+            'Lower limit' => [1900],
+        ];
+    }
+
+    /**
+     * @dataProvider invalidReferenceIntPropertyTypeDataProvider
+     *
+     * @param        $propertyValue
+     * @param string $message
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    public function testInvalidReferenceIntPropertyTypeThrowsAnException($propertyValue, string $message): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage($message);
+
+        $className = $this->generateObjectFromFile('IntReference.json');
+
+        new $className(['year' => $propertyValue]);
+    }
+
+    public function invalidReferenceIntPropertyTypeDataProvider(): array
+    {
+        return [
+            'bool' => [true, 'invalid type for year'],
+            'float' => [0.92, 'invalid type for year'],
+            'array' => [[2], 'invalid type for year'],
+            'object' => [new stdClass(), 'invalid type for year'],
+            'string' => ['1', 'invalid type for year'],
+            'int too low' => [1899, 'Value for year must not be smaller than 1900'],
+            'int too high' => [2001, 'Value for year must not be larger than 2000'],
+        ];
+    }
+
+    public function testNotProvidedOptionalRecursiveReferenceObjectPropertyIsValid()
+    {
+        $className = $this->generateObjectFromFile('RecursiveObjectReference.json');
+
+        $object = new $className(['person' => ['name' => 'Hannes']]);
+        $this->assertSame('Hannes', $object->getPerson()->getName());
+        $this->assertEmpty($object->getPerson()->getChildren());
+    }
+
+    public function testProvidedRecursiveReferenceObjectPropertyIsValid()
+    {
+        $className = $this->generateObjectFromFile('RecursiveObjectReference.json');
+
+        $object = new $className([
+            'person' => [
+                'name' => 'Hannes',
+                'children' => [
+                    ['name' => 'Louis'],
+                    ['name' => 'Karl']
+                ]
+            ]
+        ]);
+
+        $this->assertSame('Hannes', $object->getPerson()->getName());
+        $this->assertSame(2, count($object->getPerson()->getChildren()));
+        $this->assertSame('Louis', $object->getPerson()->getChildren()[0]->getName());
+        $this->assertEmpty($object->getPerson()->getChildren()[0]->getChildren());
+        $this->assertSame('Karl', $object->getPerson()->getChildren()[1]->getName());
+        $this->assertEmpty($object->getPerson()->getChildren()[1]->getChildren());
+    }
+
+    /**
+     * @dataProvider invalidReferenceObjectPropertyTypeDataProvider
+     *
+     * @param $propertyValue
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    public function testInvalidProvidedRecursiveReferenceObjectPropertyValueIsInvalid($propertyValue): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('invalid type for person');
+
+        $className = $this->generateObjectFromFile('RecursiveObjectReference.json');
+
+        new $className([
+            'person' => [
+                'name' => 'Hannes',
+                'children' => [$propertyValue]
+            ]
+        ]);
+    }
+}
diff --git a/tests/Schema/ReferencePropertyTest/IntReference.json b/tests/Schema/ReferencePropertyTest/IntReference.json
@@ -0,0 +1,15 @@
+{
+  "definitions": {
+    "yearBetween1900and2000": {
+      "type": "int",
+      "minimum": 1900,
+      "maximum": 2000
+    }
+  },
+  "type": "object",
+  "properties": {
+    "year": {
+      "$ref": "#/definitions/yearBetween1900and2000"
+    }
+  }
+}
diff --git a/tests/Schema/ReferencePropertyTest/NotResolvedReference.json b/tests/Schema/ReferencePropertyTest/NotResolvedReference.json
diff --git a/tests/Schema/ReferencePropertyTest/ObjectReference.json b/tests/Schema/ReferencePropertyTest/ObjectReference.json
diff --git a/tests/Schema/ReferencePropertyTest/RecursiveObjectReference.json b/tests/Schema/ReferencePropertyTest/RecursiveObjectReference.json

Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ public function addDecorator(PropertyDecoratorInterface $decorator): PropertyInt`
`153`	`153`	`public function resolveDecorator(string $input): string`
`154`	`154`	`{`
`155`	`155`	`foreach ($this->decorators as $decorator) {`
`156`		`- $input = $decorator->decorate($input);`
	`156`	`+ $input = $decorator->decorate($input, $this);`
`157`	`157`	`}`
`158`	`158`
`159`	`159`	`return $input;`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public function addDefinition(string $key, SchemaDefinition $definition)`
`126`	`126`	`*`
`127`	`127`	`* @return SchemaDefinition`
`128`	`128`	`*/`
`129`		`- public function getDefinition(string $key): SchemaDefinition`
	`129`	`+ public function getDefinition(string $key): ?SchemaDefinition`
`130`	`130`	`{`
`131`	`131`	`return $this->definitions[$key] ?? null;`
`132`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace PHPModelGenerator\PropertyProcessor\Decorator;`
`6`	`6`
	`7`	`+use PHPModelGenerator\Model\Property\PropertyInterface;`
	`8`	`+`
`7`	`9`	`/**`
`8`	`10`	`* Class IntToFloatCastDecorator`
`9`	`11`	`*`
`@@ -14,7 +16,7 @@ class IntToFloatCastDecorator implements PropertyDecoratorInterface`
`14`	`16`	`/**`
`15`	`17`	`* @inheritdoc`
`16`	`18`	`*/`
`17`		`- public function decorate(string $input): string`
	`19`	`+ public function decorate(string $input, PropertyInterface $property): string`
`18`	`20`	`{`
`19`	`21`	`return "is_int($input) ? (float) $input : $input";`
`20`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`use PHPMicroTemplate\Render;`
`8`	`8`	`use PHPModelGenerator\Exception\InvalidArgumentException;`
	`9`	`+use PHPModelGenerator\Model\Property\PropertyInterface;`
`9`	`10`
`10`	`11`	`/**`
`11`	`12`	`* Class ObjectInstantiationDecorator`
`@@ -38,13 +39,14 @@ public function __construct(string $className)`
`38`	`39`	`/**`
`39`	`40`	`* @inheritdoc`
`40`	`41`	`*/`
`41`		`- public function decorate(string $input): string`
	`42`	`+ public function decorate(string $input, PropertyInterface $property): string`
`42`	`43`	`{`
`43`	`44`	`return static::$renderer->renderTemplate(`
`44`	`45`	`DIRECTORY_SEPARATOR . 'Decorator' . DIRECTORY_SEPARATOR . 'ObjectInstantiationDecorator.phptpl',`
`45`	`46`	`[`
`46`	`47`	`'input' => $input,`
`47`		`- 'className' => $this->className`
	`48`	`+ 'className' => $this->className,`
	`49`	`+ 'property' => $property,`
`48`	`50`	`]`
`49`	`51`	`);`
`50`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function __construct(PropertyInterface $property)`
`32`	`32`	`/**`
`33`	`33`	`* @inheritdoc`
`34`	`34`	`*/`
`35`		`- public function decorate(string $input): string`
	`35`	`+ public function decorate(string $input, PropertyInterface $property): string`
`36`	`36`	`{`
`37`	`37`	`return $this->property->resolveDecorator($input);`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`(is_array($param = {{ input }})`
`2`	`2`	`? new {{ className }}($param)`
`3`	`3`	`: (function() {`
`4`		`- throw new InvalidArgumentException('invalid type for property');`
	`4`	`+ throw new InvalidArgumentException('invalid type for {{ property.getName() }}');`
`5`	`5`	`})()`
`6`	`6`	`)`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`use stdClass;`
`11`	`11`
`12`	`12`	`/**`
`13`		`- * Class AnyPropertyTest`
	`13`	`+ * Class ObjectPropertyTest`
`14`	`14`	`*`
`15`	`15`	`* @package PHPModelGenerator\Tests\Objects`
`16`	`16`	`*/`