* Extended type hints for properties which are composed to contain all possible types (eg. int|string|null) yad! Yet Another Decorator

wol-soft · wol-soft · commit bc569e3d5b27 · 2019-07-23T21:55:40.000+02:00
* Fix SplObject access
* Fix Out of memory error due to recursive logging
diff --git a/src/Model/Property/Property.php b/src/Model/Property/Property.php
@@ -7,8 +7,8 @@
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\PropertyDecoratorInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\TypeHintDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\Property\PropertyDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\TypeHintDecoratorInterface;
 
 /**
  * Class Property
@@ -93,13 +93,13 @@ public function setType(string $type): PropertyInterface
      */
     public function getTypeHint(): string
     {
-        $input =  $this->type ?: 'mixed';
+        $input = $this->type;
 
         foreach ($this->typeHintDecorators as $decorator) {
             $input = $decorator->decorate($input);
         }
 
-        return $input;
+        return $input ?? 'mixed';
     }
 
     /**
diff --git a/src/Model/Property/PropertyInterface.php b/src/Model/Property/PropertyInterface.php
@@ -7,8 +7,8 @@
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\PropertyDecoratorInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\TypeHintDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\Property\PropertyDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\TypeHintDecoratorInterface;
 
 /**
  * Interface PropertyInterface
diff --git a/src/Model/Property/PropertyProxy.php b/src/Model/Property/PropertyProxy.php
@@ -7,8 +7,8 @@
 use PHPModelGenerator\Model\SchemaDefinition\ResolvedDefinitionsCollection;
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\PropertyDecoratorInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\TypeHintDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\Property\PropertyDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\TypeHintDecoratorInterface;
 
 /**
  * Class PropertyProxy
diff --git a/src/Model/Validator/PropertyTemplateValidator.php b/src/Model/Validator/PropertyTemplateValidator.php
@@ -60,12 +60,7 @@ public function getCheck(): string
         try {
             return static::$renderer->renderTemplate($this->template, $this->templateValues);
         } catch (PHPMicroTemplateException $exception) {
-            throw new RenderException(
-                "Can't render property validation template {$this->template} with values " .
-                    print_r($this->templateValues, true),
-                0,
-                $exception
-            );
+            throw new RenderException("Can't render property validation template {$this->template}", 0, $exception);
         }
     }
 }
diff --git a/src/ModelGenerator.php b/src/ModelGenerator.php
@@ -52,11 +52,10 @@ public function generateModelDirectory(string $modelPath, int $directoryMode = 0
         }
 
         $di = new RecursiveDirectoryIterator($modelPath, FilesystemIterator::SKIP_DOTS);
-
         $ri = new RecursiveIteratorIterator($di, RecursiveIteratorIterator::CHILD_FIRST);
 
-        foreach ($ri as $file ) {
-            $file->isDir() ?  rmdir($file) : unlink($file);
+        foreach ($ri as $file) {
+            $file->isDir() ?  rmdir($file->getRealPath()) : unlink($file->getRealPath());
         }
 
         return $this;
diff --git a/src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php b/src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php
@@ -9,6 +9,7 @@
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\ComposedPropertyValidator;
 use PHPModelGenerator\Model\Validator\RequiredPropertyValidator;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\CompositionTypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\Property\AbstractValueProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyCollectionProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyFactory;
@@ -48,6 +49,8 @@ protected function generateValidators(PropertyInterface $property, array $proper
                     !is_a($validator->getValidator(), ComposedPropertyValidator::class);
             });
 
+            $property->addTypeHintDecorator(new CompositionTypeHintDecorator($compositionProperty));
+
             $properties[] = $compositionProperty;
         }
 
diff --git a/src/PropertyProcessor/Decorator/Property/IntToFloatCastDecorator.php b/src/PropertyProcessor/Decorator/Property/IntToFloatCastDecorator.php
@@ -2,14 +2,14 @@
 
 declare(strict_types = 1);
 
-namespace PHPModelGenerator\PropertyProcessor\Decorator;
+namespace PHPModelGenerator\PropertyProcessor\Decorator\Property;
 
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
  * Class IntToFloatCastDecorator
  *
- * @package PHPModelGenerator\PropertyProcessor\Decorator
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
  */
 class IntToFloatCastDecorator implements PropertyDecoratorInterface
 {
diff --git a/src/PropertyProcessor/Decorator/Property/ObjectInstantiationDecorator.php b/src/PropertyProcessor/Decorator/Property/ObjectInstantiationDecorator.php
@@ -2,7 +2,7 @@
 
 declare(strict_types = 1);
 
-namespace PHPModelGenerator\PropertyProcessor\Decorator;
+namespace PHPModelGenerator\PropertyProcessor\Decorator\Property;
 
 use PHPMicroTemplate\Render;
 use PHPModelGenerator\Exception\InvalidArgumentException;
@@ -11,7 +11,7 @@
 /**
  * Class ObjectInstantiationDecorator
  *
- * @package PHPModelGenerator\PropertyProcessor\Decorator
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
  */
 class ObjectInstantiationDecorator implements PropertyDecoratorInterface
 {
@@ -31,7 +31,7 @@ public function __construct(string $className)
 
         if (!static::$renderer) {
             static::$renderer = new Render(
-                join(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', 'Templates']) . DIRECTORY_SEPARATOR
+                join(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', '..', 'Templates']) . DIRECTORY_SEPARATOR
             );
         }
     }
diff --git a/src/PropertyProcessor/Decorator/Property/PropertyDecoratorInterface.php b/src/PropertyProcessor/Decorator/Property/PropertyDecoratorInterface.php
@@ -2,14 +2,14 @@
 
 declare(strict_types = 1);
 
-namespace PHPModelGenerator\PropertyProcessor\Decorator;
+namespace PHPModelGenerator\PropertyProcessor\Decorator\Property;
 
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
  * Interface PropertyDecoratorInterface
  *
- * @package PHPModelGenerator\PropertyProcessor\Decorator
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
  */
 interface PropertyDecoratorInterface
 {
diff --git a/src/PropertyProcessor/Decorator/Property/PropertyTransferDecorator.php b/src/PropertyProcessor/Decorator/Property/PropertyTransferDecorator.php
@@ -2,7 +2,7 @@
 
 declare(strict_types = 1);
 
-namespace PHPModelGenerator\PropertyProcessor\Decorator;
+namespace PHPModelGenerator\PropertyProcessor\Decorator\Property;
 
 use PHPModelGenerator\Model\Property\Property;
 use PHPModelGenerator\Model\Property\PropertyInterface;
@@ -12,7 +12,7 @@
  *
  * Can be used to transfer the decorators of one property to another
  *
- * @package PHPModelGenerator\PropertyProcessor\Decorator
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
  */
 class PropertyTransferDecorator implements PropertyDecoratorInterface
 {
diff --git a/src/PropertyProcessor/Decorator/TypeHint/ArrayTypeHintDecorator.php b/src/PropertyProcessor/Decorator/TypeHint/ArrayTypeHintDecorator.php
@@ -2,14 +2,14 @@
 
 declare(strict_types = 1);
 
-namespace PHPModelGenerator\PropertyProcessor\Decorator;
+namespace PHPModelGenerator\PropertyProcessor\Decorator\TypeHint;
 
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
  * Class ArrayTypeHintDecorator
  *
- * @package PHPModelGenerator\PropertyProcessor\Decorator
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
  */
 class ArrayTypeHintDecorator implements TypeHintDecoratorInterface
 {
diff --git a/src/PropertyProcessor/Decorator/TypeHint/CompositionTypeHintDecorator.php b/src/PropertyProcessor/Decorator/TypeHint/CompositionTypeHintDecorator.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\Decorator\TypeHint;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
+/**
+ * Class ArrayTypeHintDecorator
+ *
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
+ */
+class CompositionTypeHintDecorator implements TypeHintDecoratorInterface
+{
+    /** @var PropertyInterface */
+    protected $nestedProperty;
+
+    /**
+     * ArrayTypeHintDecorator constructor.
+     *
+     * @param PropertyInterface $nestedProperty
+     */
+    public function __construct(PropertyInterface $nestedProperty)
+    {
+        $this->nestedProperty = $nestedProperty;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function decorate(string $input): string
+    {
+        return ($input ? "$input|" : '') . $this->nestedProperty->getTypeHint();
+    }
+}
diff --git a/src/PropertyProcessor/Decorator/TypeHint/TypeHintDecoratorInterface.php b/src/PropertyProcessor/Decorator/TypeHint/TypeHintDecoratorInterface.php
@@ -2,12 +2,12 @@
 
 declare(strict_types = 1);
 
-namespace PHPModelGenerator\PropertyProcessor\Decorator;
+namespace PHPModelGenerator\PropertyProcessor\Decorator\TypeHint;
 
 /**
  * Interface TypeHintDecoratorInterface
  *
- * @package PHPModelGenerator\PropertyProcessor\Decorator
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
  */
 interface TypeHintDecoratorInterface
 {
diff --git a/src/PropertyProcessor/Decorator/TypeHint/TypeHintTransferDecorator.php b/src/PropertyProcessor/Decorator/TypeHint/TypeHintTransferDecorator.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\Decorator\TypeHint;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
+/**
+ * Class ArrayTypeHintDecorator
+ *
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
+ */
+class TypeHintTransferDecorator implements TypeHintDecoratorInterface
+{
+    /** @var PropertyInterface */
+    protected $property;
+
+    /**
+     * ArrayTypeHintDecorator constructor.
+     *
+     * @param PropertyInterface $property
+     */
+    public function __construct(PropertyInterface $property)
+    {
+        $this->property = $property;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function decorate(string $input): string
+    {
+        return $this->property->getTypeHint();
+    }
+}
diff --git a/src/PropertyProcessor/Property/AbstractPropertyProcessor.php b/src/PropertyProcessor/Property/AbstractPropertyProcessor.php
@@ -11,6 +11,7 @@
 use PHPModelGenerator\Model\Validator\PropertyValidator;
 use PHPModelGenerator\Model\Validator\RequiredPropertyValidator;
 use PHPModelGenerator\PropertyProcessor\ComposedValueProcessorFactory;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\TypeHintTransferDecorator;
 use PHPModelGenerator\PropertyProcessor\PropertyCollectionProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyFactory;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorInterface;
@@ -122,6 +123,8 @@ protected function addComposedValueValidator(PropertyInterface $property, array
             foreach ($composedProperty->getValidators() as $validator) {
                 $property->addValidator($validator->getValidator(), $validator->getPriority());
             }
+
+            $property->addTypeHintDecorator(new TypeHintTransferDecorator($composedProperty));
         }
     }
 
diff --git a/src/PropertyProcessor/Property/ArrayProcessor.php b/src/PropertyProcessor/Property/ArrayProcessor.php
@@ -9,7 +9,7 @@
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\Validator\PropertyTemplateValidator;
 use PHPModelGenerator\Model\Validator\PropertyValidator;
-use PHPModelGenerator\PropertyProcessor\Decorator\ArrayTypeHintDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\ArrayTypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\PropertyCollectionProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyFactory;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;
diff --git a/src/PropertyProcessor/Property/MultiTypeProcessor.php b/src/PropertyProcessor/Property/MultiTypeProcessor.php
@@ -10,7 +10,7 @@
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator\PropertyValidator;
 use PHPModelGenerator\Model\Validator\TypeCheckValidator;
-use PHPModelGenerator\PropertyProcessor\Decorator\PropertyTransferDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\Property\PropertyTransferDecorator;
 use PHPModelGenerator\PropertyProcessor\PropertyCollectionProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorInterface;
diff --git a/src/PropertyProcessor/Property/NumberProcessor.php b/src/PropertyProcessor/Property/NumberProcessor.php
@@ -5,7 +5,7 @@
 namespace PHPModelGenerator\PropertyProcessor\Property;
 
 use PHPModelGenerator\Model\Property\PropertyInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\IntToFloatCastDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\Property\IntToFloatCastDecorator;
 
 /**
  * Class NumberProcessor
diff --git a/src/PropertyProcessor/Property/ObjectProcessor.php b/src/PropertyProcessor/Property/ObjectProcessor.php
@@ -6,7 +6,7 @@
 
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
-use PHPModelGenerator\PropertyProcessor\Decorator\ObjectInstantiationDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\Property\ObjectInstantiationDecorator;
 
 /**
  * Class ObjectProcessor
diff --git a/tests/AbstractPHPModelGeneratorTest.php b/tests/AbstractPHPModelGeneratorTest.php
@@ -32,7 +32,7 @@ public static function setUpBeforeClass(): void
             $ri = new RecursiveIteratorIterator($di, RecursiveIteratorIterator::CHILD_FIRST);
 
             foreach ($ri as $file) {
-                $file->isDir() ? rmdir($file) : unlink($file);
+                $file->isDir() ? rmdir($file->getRealPath()) : unlink($file->getRealPath());
             }
         }
 
diff --git a/tests/Model/Validator/PropertyTemplateValidatorTest.php b/tests/Model/Validator/PropertyTemplateValidatorTest.php
@@ -17,9 +17,7 @@ class PropertyTemplateValidatorTest extends TestCase
     public function testInvalidRenderExceptionIsConverted(): void
     {
         $this->expectException(RenderException::class);
-        $this->expectExceptionMessageRegExp(
-            '/Can\'t render property validation template UnknownTemplate with values(.*)/'
-        );
+        $this->expectExceptionMessage('Can\'t render property validation template UnknownTemplate');
 
         (new PropertyTemplateValidator(
             InvalidArgumentException::class,
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -7,7 +7,7 @@
     $ri = new RecursiveIteratorIterator($di, RecursiveIteratorIterator::CHILD_FIRST);
 
     foreach ($ri as $file) {
-        $file->isDir() ? rmdir($file) : unlink($file);
+        $file->isDir() ? rmdir($file->getRealPath()) : unlink($file->getRealPath());
     }
 }
 
diff --git a/tests/manual/test.php b/tests/manual/test.php
@@ -1,29 +1,20 @@
 <?php
 
-use PHPModelGenerator\Generator;
+use PHPModelGenerator\ModelGenerator;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 
 require_once __DIR__ . '/../../vendor/autoload.php';
 
-$generator = new Generator((new GeneratorConfiguration())
+$generator = new ModelGenerator((new GeneratorConfiguration())
     ->setNamespacePrefix('\\ManualSchema')
     ->setImmutable(false)
     ->setPrettyPrint(true)
 );
 
 try {
-    if (!is_dir(__DIR__ . '/result')) {
-        mkdir(__DIR__ . '/result');
-    }
-
-    $di = new RecursiveDirectoryIterator(__DIR__ . '/result', FilesystemIterator::SKIP_DOTS);
-    $ri = new RecursiveIteratorIterator($di, RecursiveIteratorIterator::CHILD_FIRST);
-
-    foreach ($ri as $file ) {
-        $file->isDir() ?  rmdir($file) : unlink($file);
-    }
-
-    $generator->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
+    $generator
+        ->generateModelDirectory(__DIR__ . '/result')
+        ->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
 } catch (Exception $e) {
     echo get_class($e) . "\n";
     echo $e->getMessage() . "\n";

Original file line number	Diff line number	Diff line change
`@@ -60,12 +60,7 @@ public function getCheck(): string`
`60`	`60`	`try {`
`61`	`61`	`return static::$renderer->renderTemplate($this->template, $this->templateValues);`
`62`	`62`	`} catch (PHPMicroTemplateException $exception) {`
`63`		`- throw new RenderException(`
`64`		`- "Can't render property validation template {$this->template} with values " .`
`65`		`- print_r($this->templateValues, true),`
`66`		`- 0,`
`67`		`- $exception`
`68`		`- );`
	`63`	`+ throw new RenderException("Can't render property validation template {$this->template}", 0, $exception);`
`69`	`64`	`}`
`70`	`65`	`}`
`71`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,11 +52,10 @@ public function generateModelDirectory(string $modelPath, int $directoryMode = 0`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`$di = new RecursiveDirectoryIterator($modelPath, FilesystemIterator::SKIP_DOTS);`
`55`		`-`
`56`	`55`	`$ri = new RecursiveIteratorIterator($di, RecursiveIteratorIterator::CHILD_FIRST);`
`57`	`56`
`58`		`- foreach ($ri as $file ) {`
`59`		`- $file->isDir() ? rmdir($file) : unlink($file);`
	`57`	`+ foreach ($ri as $file) {`
	`58`	`+ $file->isDir() ? rmdir($file->getRealPath()) : unlink($file->getRealPath());`
`60`	`59`	`}`
`61`	`60`
`62`	`61`	`return $this;`
Original file line number	Diff line number	Diff line change
`@@ -2,14 +2,14 @@`
`2`	`2`
`3`	`3`	`declare(strict_types = 1);`
`4`	`4`
`5`		`-namespace PHPModelGenerator\PropertyProcessor\Decorator;`
	`5`	`+namespace PHPModelGenerator\PropertyProcessor\Decorator\Property;`
`6`	`6`
`7`	`7`	`use PHPModelGenerator\Model\Property\PropertyInterface;`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* Class IntToFloatCastDecorator`
`11`	`11`	`*`
`12`		`- * @package PHPModelGenerator\PropertyProcessor\Decorator`
	`12`	`+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property`
`13`	`13`	`*/`
`14`	`14`	`class IntToFloatCastDecorator implements PropertyDecoratorInterface`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`declare(strict_types = 1);`
`4`	`4`
`5`		`-namespace PHPModelGenerator\PropertyProcessor\Decorator;`
	`5`	`+namespace PHPModelGenerator\PropertyProcessor\Decorator\Property;`
`6`	`6`
`7`	`7`	`use PHPMicroTemplate\Render;`
`8`	`8`	`use PHPModelGenerator\Exception\InvalidArgumentException;`
`@@ -11,7 +11,7 @@`
`11`	`11`	`/**`
`12`	`12`	`* Class ObjectInstantiationDecorator`
`13`	`13`	`*`
`14`		`- * @package PHPModelGenerator\PropertyProcessor\Decorator`
	`14`	`+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property`
`15`	`15`	`*/`
`16`	`16`	`class ObjectInstantiationDecorator implements PropertyDecoratorInterface`
`17`	`17`	`{`
`@@ -31,7 +31,7 @@ public function __construct(string $className)`
`31`	`31`
`32`	`32`	`if (!static::$renderer) {`
`33`	`33`	`static::$renderer = new Render(`
`34`		`- join(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', 'Templates']) . DIRECTORY_SEPARATOR`
	`34`	`+ join(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', '..', 'Templates']) . DIRECTORY_SEPARATOR`
`35`	`35`	`);`
`36`	`36`	`}`
`37`	`37`	`}`