Add ObjectProcessor test cases

Enno Woortmann · Enno Woortmann · commit 8d1fddaec9f9 · 2018-11-20T11:18:39.000+01:00
Optimize ObjectInstantiationDecorator to catch invalid constructor calls
diff --git a/src/Generator.php b/src/Generator.php
@@ -61,10 +61,9 @@ public function generateModels(string $source, string $destination): array
 
         $renderProxy = new RenderQueue();
         $schemaProcessor = new SchemaProcessor($source, $destination, $this->generatorConfiguration, $renderProxy);
-        $generatedFiles = [];
 
         foreach ($this->getSchemaFiles($source) as $jsonSchemaFile) {
-            $generatedFiles[] = $schemaProcessor->process($jsonSchemaFile);
+            $schemaProcessor->process($jsonSchemaFile);
         }
 
         // render all collected classes
@@ -77,7 +76,7 @@ public function generateModels(string $source, string $destination): array
             // @codeCoverageIgnoreEnd
         }
 
-        return $generatedFiles;
+        return $schemaProcessor->getGeneratedFiles();
     }
 
     /**
diff --git a/src/Model/Property/Property.php b/src/Model/Property/Property.php
@@ -170,7 +170,7 @@ public function hasDecorators(): bool
     /**
      * @inheritdoc
      */
-    public function getClasses(): array
+    public function getExceptionClasses(): array
     {
         $use = [];
 
@@ -179,7 +179,11 @@ public function getClasses(): array
         }
 
         foreach ($this->getNestedProperties() as $property) {
-            $use = array_merge($use, $property->getClasses());
+            $use = array_merge($use, $property->getExceptionClasses());
+        }
+
+        foreach ($this->decorators as $decorator) {
+            $use = array_merge($use, $decorator->getExceptionClasses());
         }
 
         return $use;
diff --git a/src/Model/Property/PropertyInterface.php b/src/Model/Property/PropertyInterface.php
@@ -99,7 +99,7 @@ public function hasDecorators(): bool;
      *
      * @return array
      */
-    public function getClasses(): array;
+    public function getExceptionClasses(): array;
 
     /**
      * @param bool $isPropertyRequired
diff --git a/src/Model/Property/PropertyProxy.php b/src/Model/Property/PropertyProxy.php
@@ -141,9 +141,9 @@ public function hasDecorators(): bool
     /**
      * @inheritdoc
      */
-    public function getClasses(): array
+    public function getExceptionClasses(): array
     {
-        return $this->getProperty()->getClasses();
+        return $this->getProperty()->getExceptionClasses();
     }
 
     /**
diff --git a/src/Model/Schema.php b/src/Model/Schema.php
@@ -92,7 +92,7 @@ public function getUseList(bool $skipGlobalNamespace): array
                 continue;
             }
 
-            $use = array_merge($use, [Exception::class], $property->getClasses());
+            $use = array_merge($use, [Exception::class], $property->getExceptionClasses());
         }
 
         if ($skipGlobalNamespace) {
diff --git a/src/PropertyProcessor/Decorator/IntToFloatCastDecorator.php b/src/PropertyProcessor/Decorator/IntToFloatCastDecorator.php
@@ -18,4 +18,12 @@ public function decorate(string $input): string
     {
         return "is_int($input) ? (float) $input : $input";
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getExceptionClasses(): array
+    {
+        return [];
+    }
 }
diff --git a/src/PropertyProcessor/Decorator/ObjectInstantiationDecorator.php b/src/PropertyProcessor/Decorator/ObjectInstantiationDecorator.php
@@ -4,13 +4,18 @@
 
 namespace PHPModelGenerator\PropertyProcessor\Decorator;
 
+use PHPMicroTemplate\Render;
+use PHPModelGenerator\Exception\InvalidArgumentException;
+
 /**
  * Class ObjectInstantiationDecorator
  *
  * @package PHPModelGenerator\PropertyProcessor\Decorator
  */
 class ObjectInstantiationDecorator implements PropertyDecoratorInterface
 {
+    /** @var Render */
+    protected static $renderer;
     /** @var string */
     protected $className;
 
@@ -22,13 +27,33 @@ class ObjectInstantiationDecorator implements PropertyDecoratorInterface
     public function __construct(string $className)
     {
         $this->className = $className;
+
+        if (!static::$renderer) {
+            static::$renderer = new Render(
+                join(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', 'Templates']) . DIRECTORY_SEPARATOR
+            );
+        }
     }
 
     /**
      * @inheritdoc
      */
     public function decorate(string $input): string
     {
-        return "new {$this->className}($input)";
+        return static::$renderer->renderTemplate(
+            DIRECTORY_SEPARATOR . 'Decorator' . DIRECTORY_SEPARATOR . 'ObjectInstantiationDecorator.phptpl',
+            [
+                'input' => $input,
+                'className' => $this->className
+            ]
+        );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getExceptionClasses(): array
+    {
+        return [InvalidArgumentException::class];
     }
 }
diff --git a/src/PropertyProcessor/Decorator/PropertyDecoratorInterface.php b/src/PropertyProcessor/Decorator/PropertyDecoratorInterface.php
@@ -19,4 +19,11 @@ interface PropertyDecoratorInterface
      * @return string
      */
     public function decorate(string $input): string;
+
+    /**
+     * Return a list of all exception classes which may be thrown by the decorator
+     *
+     * @return array
+     */
+    public function getExceptionClasses(): array;
 }
diff --git a/src/PropertyProcessor/Decorator/PropertyTransferDecorator.php b/src/PropertyProcessor/Decorator/PropertyTransferDecorator.php
@@ -36,4 +36,12 @@ public function decorate(string $input): string
     {
         return $this->property->resolveDecorator($input);
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getExceptionClasses(): array
+    {
+        return [];
+    }
 }
diff --git a/src/PropertyProcessor/Property/ArrayProcessor.php b/src/PropertyProcessor/Property/ArrayProcessor.php
@@ -126,7 +126,7 @@ private function addItemsValidation(PropertyInterface $property, array $property
             new PropertyTemplateValidator(
                 InvalidArgumentException::class,
                 'Invalid array item',
-                DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'ArrayItem.vtpl',
+                DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'ArrayItem.phptpl',
                 [
                     'property' => $nestedProperty,
                     'viewHelper' => new RenderHelper(),
diff --git a/src/SchemaProcessor/SchemaProcessor.php b/src/SchemaProcessor/SchemaProcessor.php
@@ -4,15 +4,11 @@
 
 namespace PHPModelGenerator\SchemaProcessor;
 
-use PHPMicroTemplate\Exception\PHPMicroTemplateException;
-use PHPMicroTemplate\Render;
 use PHPModelGenerator\Exception\FileSystemException;
-use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Model\RenderJob;
 use PHPModelGenerator\Model\Schema;
-use PHPModelGenerator\Utils\RenderHelper;
 
 /**
  * Class SchemaProcessor
@@ -35,6 +31,9 @@ class SchemaProcessor
     /** @var string */
     protected $currentClassName;
 
+    /** @var array */
+    protected $generatedFiles = [];
+
     /**
      * SchemaProcessor constructor.
      *
@@ -60,12 +59,10 @@ public function __construct(
      *
      * @param string $jsonSchemaFile
      *
-     * @return string
      * @throws FileSystemException
      * @throws SchemaException
-     * @throws RenderException
      */
-    public function process(string $jsonSchemaFile): string
+    public function process(string $jsonSchemaFile): void
     {
         $jsonSchema = file_get_contents($jsonSchemaFile);
 
@@ -76,7 +73,7 @@ public function process(string $jsonSchemaFile): string
         $this->setCurrentClassPath($jsonSchemaFile);
         $this->currentClassName = ucfirst($jsonSchema['id'] ?? str_ireplace('.json', '', basename($jsonSchemaFile)));
 
-        return $this->processSchema($jsonSchema, $this->currentClassPath, $this->currentClassName);
+        $this->processSchema($jsonSchema, $this->currentClassPath, $this->currentClassName);
     }
 
     /**
@@ -88,22 +85,20 @@ public function process(string $jsonSchemaFile): string
      * @param array  $parentDefinitions If a nested object of a schema is processed import the definitions of the parent
      *                                  schema to make them available for the nested schema as well
      *
-     * @return string
      * @throws FileSystemException
-     * @throws RenderException
      * @throws SchemaException
      */
     public function processSchema(
         array $jsonSchema,
         string $classPath,
         string $className,
         array $parentDefinitions = []
-    ): string {
+    ): void {
         if (!isset($jsonSchema['type']) || $jsonSchema['type'] !== 'object') {
             throw new SchemaException("JSON-Schema doesn't provide an object " . $jsonSchema['id'] ?? '');
         }
 
-        return $this->generateModel($classPath, $className, $jsonSchema, $parentDefinitions);
+        $this->generateModel($classPath, $className, $jsonSchema, $parentDefinitions);
     }
 
     /**
@@ -114,17 +109,15 @@ public function processSchema(
      * @param array  $structure
      * @param array  $parentDefinitions
      *
-     * @return string
      * @throws FileSystemException
      * @throws SchemaException
-     * @throws RenderException
      */
     protected function generateModel(
         string $classPath,
         string $className,
         array $structure,
         array $parentDefinitions = []
-    ): string {
+    ): void {
         $schema = new Schema($parentDefinitions);
         $schemaPropertyProcessorFactory = new SchemaPropertyProcessorFactory();
 
@@ -147,7 +140,7 @@ protected function generateModel(
             // @codeCoverageIgnoreEno
         }
 
-        return $fileName;
+        $this->generatedFiles[] = $fileName;
     }
 
     /**
@@ -183,4 +176,12 @@ public function getCurrentClassName(): string
     {
         return $this->currentClassName;
     }
+
+    /**
+     * @return array
+     */
+    public function getGeneratedFiles(): array
+    {
+        return $this->generatedFiles;
+    }
 }
diff --git a/src/SchemaProcessor/SchemaPropertyProcessorFactory.php b/src/SchemaProcessor/SchemaPropertyProcessorFactory.php
@@ -4,6 +4,7 @@
 
 namespace PHPModelGenerator\SchemaProcessor;
 
+use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\SchemaDefinition;
 
@@ -38,6 +39,13 @@ public function __construct(string $property)
                 $this->property = $property;
             }
 
+            /**
+             * @param SchemaProcessor $schemaProcessor
+             * @param Schema          $schema
+             * @param array           $structure
+             *
+             * @throws SchemaException
+             */
             public function process(SchemaProcessor $schemaProcessor, Schema $schema, array $structure): void
             {
                 if (!is_array($structure[$this->property])) {
diff --git a/src/Templates/Decorator/ObjectInstantiationDecorator.phptpl b/src/Templates/Decorator/ObjectInstantiationDecorator.phptpl
@@ -0,0 +1,6 @@
+(is_array($param = {{ input }})
+   ? new {{ className }}($param)
+   : (function() {
+        throw new InvalidArgumentException('invalid type for property');
+     })()
+)
diff --git a/src/Templates/Validator/ArrayItem.phptpl b/src/Templates/Validator/ArrayItem.phptpl
diff --git a/tests/AbstractPHPModelGeneratorTest.php b/tests/AbstractPHPModelGeneratorTest.php
@@ -21,6 +21,8 @@ abstract class AbstractPHPModelGeneratorTest extends TestCase
 {
     private $names = [];
 
+    private $generatedFiles = [];
+
     public static function setUpBeforeClass()
     {
         if (is_dir(sys_get_temp_dir() . '/PHPModelGeneratorTest')) {
@@ -49,18 +51,28 @@ public function tearDown()
                     sys_get_temp_dir() . '/PHPModelGeneratorTest/' . $name . '.json',
                     $failedResultDir . DIRECTORY_SEPARATOR . $name . '.json'
                 );
+            }
 
+            foreach ($this->generatedFiles as $file) {
                 copy(
-                    sys_get_temp_dir() . '/PHPModelGeneratorTest/Models/' . $name . '.php',
-                    $failedResultDir . DIRECTORY_SEPARATOR . $name . '.php'
+                    $file,
+                    $failedResultDir . DIRECTORY_SEPARATOR . basename($file)
                 );
             }
         }
 
+        // clear the JSON schema definitions
         foreach ($this->names as $name) {
             @unlink(sys_get_temp_dir() . '/PHPModelGeneratorTest/' . $name . '.json');
-            @unlink(sys_get_temp_dir() . '/PHPModelGeneratorTest/Models/' . $name . '.php');
         }
+
+        // clear the generated class files
+        foreach ($this->generatedFiles as $file) {
+            @unlink($file);
+        }
+
+        $this->names = [];
+        $this->generatedFiles = [];
     }
 
     /**
@@ -157,6 +169,8 @@ public function generateObject(string $jsonSchema, GeneratorConfiguration $gener
         );
 
         foreach ($generatedFiles as $path) {
+            $this->generatedFiles[] = $path;
+
             require_once $path;
         }
 
diff --git a/tests/Objects/IntPropertyTest.php b/tests/Objects/IntPropertyTest.php
@@ -54,7 +54,7 @@ public function validInputProvider(): array
             'Null' => [null],
         ];
     }
-    
+
     /**
      * @dataProvider invalidPropertyTypeDataProvider
      *
diff --git a/tests/Objects/ObjectPropertyTest.php b/tests/Objects/ObjectPropertyTest.php
diff --git a/tests/Schema/ObjectPropertyTest/ObjectLevelValidation.json b/tests/Schema/ObjectPropertyTest/ObjectLevelValidation.json
diff --git a/tests/Schema/ObjectPropertyTest/ObjectProperty.json b/tests/Schema/ObjectPropertyTest/ObjectProperty.json

Original file line number	Diff line number	Diff line change
`@@ -61,10 +61,9 @@ public function generateModels(string $source, string $destination): array`
`61`	`61`
`62`	`62`	`$renderProxy = new RenderQueue();`
`63`	`63`	`$schemaProcessor = new SchemaProcessor($source, $destination, $this->generatorConfiguration, $renderProxy);`
`64`		`- $generatedFiles = [];`
`65`	`64`
`66`	`65`	`foreach ($this->getSchemaFiles($source) as $jsonSchemaFile) {`
`67`		`- $generatedFiles[] = $schemaProcessor->process($jsonSchemaFile);`
	`66`	`+ $schemaProcessor->process($jsonSchemaFile);`
`68`	`67`	`}`
`69`	`68`
`70`	`69`	`// render all collected classes`
`@@ -77,7 +76,7 @@ public function generateModels(string $source, string $destination): array`
`77`	`76`	`// @codeCoverageIgnoreEnd`
`78`	`77`	`}`
`79`	`78`
`80`		`- return $generatedFiles;`
	`79`	`+ return $schemaProcessor->getGeneratedFiles();`
`81`	`80`	`}`
`82`	`81`
`83`	`82`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ public function hasDecorators(): bool`
`170`	`170`	`/**`
`171`	`171`	`* @inheritdoc`
`172`	`172`	`*/`
`173`		`- public function getClasses(): array`
	`173`	`+ public function getExceptionClasses(): array`
`174`	`174`	`{`
`175`	`175`	`$use = [];`
`176`	`176`
`@@ -179,7 +179,11 @@ public function getClasses(): array`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`foreach ($this->getNestedProperties() as $property) {`
`182`		`- $use = array_merge($use, $property->getClasses());`
	`182`	`+ $use = array_merge($use, $property->getExceptionClasses());`
	`183`	`+ }`
	`184`	`+`
	`185`	`+ foreach ($this->decorators as $decorator) {`
	`186`	`+ $use = array_merge($use, $decorator->getExceptionClasses());`
`183`	`187`	`}`
`184`	`188`
`185`	`189`	`return $use;`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public function hasDecorators(): bool;`
`99`	`99`	`*`
`100`	`100`	`* @return array`
`101`	`101`	`*/`
`102`		`- public function getClasses(): array;`
	`102`	`+ public function getExceptionClasses(): array;`
`103`	`103`
`104`	`104`	`/**`
`105`	`105`	`* @param bool $isPropertyRequired`
Original file line number	Diff line number	Diff line change
`@@ -141,9 +141,9 @@ public function hasDecorators(): bool`
`141`	`141`	`/**`
`142`	`142`	`* @inheritdoc`
`143`	`143`	`*/`
`144`		`- public function getClasses(): array`
	`144`	`+ public function getExceptionClasses(): array`
`145`	`145`	`{`
`146`		`- return $this->getProperty()->getClasses();`
	`146`	`+ return $this->getProperty()->getExceptionClasses();`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ public function getUseList(bool $skipGlobalNamespace): array`
`92`	`92`	`continue;`
`93`	`93`	`}`
`94`	`94`
`95`		`- $use = array_merge($use, [Exception::class], $property->getClasses());`
	`95`	`+ $use = array_merge($use, [Exception::class], $property->getExceptionClasses());`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`if ($skipGlobalNamespace) {`
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,12 @@ public function decorate(string $input): string`
`18`	`18`	`{`
`19`	`19`	`return "is_int($input) ? (float) $input : $input";`
`20`	`20`	`}`
	`21`	`+`
	`22`	`+ /**`
	`23`	`+ * @inheritdoc`
	`24`	`+ */`
	`25`	`+ public function getExceptionClasses(): array`
	`26`	`+ {`
	`27`	`+ return [];`
	`28`	`+ }`
`21`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,12 @@ public function decorate(string $input): string`
`36`	`36`	`{`
`37`	`37`	`return $this->property->resolveDecorator($input);`
`38`	`38`	`}`
	`39`	`+`
	`40`	`+ /**`
	`41`	`+ * @inheritdoc`
	`42`	`+ */`
	`43`	`+ public function getExceptionClasses(): array`
	`44`	`+ {`
	`45`	`+ return [];`
	`46`	`+ }`
`39`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ private function addItemsValidation(PropertyInterface $property, array $property`
`126`	`126`	`new PropertyTemplateValidator(`
`127`	`127`	`InvalidArgumentException::class,`
`128`	`128`	`'Invalid array item',`
`129`		`- DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'ArrayItem.vtpl',`
	`129`	`+ DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'ArrayItem.phptpl',`
`130`	`130`	`[`
`131`	`131`	`'property' => $nestedProperty,`
`132`	`132`	`'viewHelper' => new RenderHelper(),`