Merge pull request #21 from wol-soft/CompositionValidationOnMutableObjects

Validation for composition validators in setter methods

Author: wol-soft

.travis.yml

@@ -10,6 +10,7 @@ php:
   - 7.2
   - 7.3
   - 7.4
+  - nightly
 
 install:
   # Install coveralls.phar

README.md

@@ -65,7 +65,7 @@ As an optional parameter you can set up a *GeneratorConfiguration* object to con
 ```php
 $generator = new Generator(
     (new GeneratorConfiguration())
-        ->setNamespacePrefix('\MyApp\Model')
+        ->setNamespacePrefix('MyApp\Model')
         ->setImmutable(false)
 );
 
@@ -82,11 +82,11 @@ The *GeneratorConfiguration* object offers the following methods to configure th
 
 Method | Configuration | Default
 --- | --- | ---
-``` setNamespacePrefix(string $prefix) ``` <br><br>Example:<br> ``` setNamespacePrefix('\MyApp\Model') ``` | Configures a namespace prefix for all generated classes. The namespaces will be extended with the directory structure of the source directory. | Empty string so no namespace prefix will be used
+``` setNamespacePrefix(string $prefix) ``` <br><br>Example:<br> ``` setNamespacePrefix('MyApp\Model') ``` | Configures a namespace prefix for all generated classes. The namespaces will be extended with the directory structure of the source directory. | Empty string so no namespace prefix will be used
 ``` setImmutable(bool $immutable) ``` <br><br>Example:<br> ``` setImmutable(false) ``` | If set to true the generated model classes will be delivered without setter methods for the object properties. | true
 ``` setImplicitNull(bool $allowImplicitNull) ``` <br><br>Example:<br> ``` setImplicitNull(true) ``` | By setting the implicit null option to true all of your object properties which aren't required will implicitly accept null. | false
 ``` setCollectErrors(bool $collectErrors) ``` <br><br>Example:<br> ``` setCollectErrors(false) ``` | By default the complete input is validated and in case of failing validations all error messages will be thrown in a single exception. If set to false the first failing validation will throw an exception. | true
-``` setPrettyPrint(bool $prettyPrint) ``` <br><br>Example:<br> ``` setPrettyPrint(true) ``` | If set to false, the generated model classes won't follow coding guidelines (but the generation is faster). If enabled the package [Symplify/EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard) will be used to clean up the generated code. By default pretty printing is disabled. | false
+``` setPrettyPrint(bool $prettyPrint) ``` <br><br>Example:<br> ``` setPrettyPrint(true) ``` | If set to false, the generated model classes won't follow coding guidelines (but the generation is faster). If enabled the package [Symplify/EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard) will be used to clean up the generated code (the package must be installed manually: `composer require --dev symplify/easy-coding-standard`). By default pretty printing is disabled. | false
 ``` setSerialization(bool $serialization) ``` <br><br>Example:<br> ``` setSerialization(true) ``` | If set to true the serialization methods `toArray` and `toJSON` will be added to the public interface of the generated classes. | false
 ``` setOutputEnabled(bool $outputEnabled) ``` <br><br>Example:<br> ``` setOutputEnabled(false) ``` | Enable or disable output of the generation process to STDOUT | true
 ``` setErrorRegistryClass(string $exceptionClass) ``` <br><br>Example:<br> ``` setErrorRegistryClass(CustomException::class) ``` | Define a custom exception implementing the ErrorRegistryExceptionInterface to be used. The exception will be thrown if a validation fails and error collection is **enabled** | ErrorRegistryException::class

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "wol-soft/php-json-schema-model-generator",
     "homepage": "https://github.com/wol-soft/php-json-schema-model-generator",
-    "description": "Creates immutable PHP model classes from JSON-Schema files",
+    "description": "Creates (immutable) PHP model classes from JSON-Schema files",
     "type": "library",
     "license": "MIT",
     "authors": [
@@ -11,16 +11,18 @@
         }
     ],
     "require": {
-        "symplify/easy-coding-standard": "^7.2.3",
-        "wol-soft/php-json-schema-model-generator-production": "0.14.0",
+        "wol-soft/php-json-schema-model-generator-production": "dev-SkipSerializationOfInternalProperties",
         "wol-soft/php-micro-template": "^1.3.2",
 
         "php": ">=7.2",
         "ext-json": "*",
         "ext-mbstring": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.5"
+        "phpunit/phpunit": "^8.5 || ^9.4"
+    },
+    "suggest": {
+        "symplify/easy-coding-standard": "Allows pretty printing of the generated code"
     },
     "autoload": {
         "psr-4": {

docs/source/conf.py

@@ -20,13 +20,13 @@
 # -- Project information -----------------------------------------------------
 
 project = u'php-json-schema-model-generator'
-copyright = u'2019, Enno Woortmann'
+copyright = u'2020, Enno Woortmann'
 author = u'Enno Woortmann'
 
 # The short X.Y version
-version = u''
+version = u'0.19'
 # The full version, including alpha/beta/rc tags
-release = u'0.6.0'
+release = u'0.19.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/examples.rst

@@ -0,0 +1,29 @@
+Examples
+========
+
+Ebay OpenAPIv3 spec
+-------------------
+
+The Ebay OpenAPIv3 spec for the sell-inventory API is an around 6000 lines API definition. Using a script like the example below you can create ~120 PHP classes to handle requests, responses and all nested objects from the API spec:
+
+.. code-block:: php
+
+    $generator = new ModelGenerator((new GeneratorConfiguration())
+        ->setNamespacePrefix('Ebay')
+        ->setImmutable(false)
+    );
+
+    $file = __DIR__ . '/api-definition.json';
+    $resultDir = __DIR__ . '/result';
+
+    file_put_contents(
+        $file,
+        file_get_contents('https://developer.ebay.com/api-docs/master/sell/inventory/openapi/3/sell_inventory_v1_oas3.json')
+    );
+
+    $start = microtime(true);
+    $generator
+        ->generateModelDirectory($resultDir)
+        ->generateModels(new OpenAPIv3Provider($file), $resultDir);
+
+Measured runtime of the script (Pretty printing is disabled) is around 3 seconds at a memory peak consumption between 5 and 6 MB.

docs/source/generator/postProcessor.rst

@@ -43,11 +43,12 @@ Generated interface with the **PopulatePostProcessor**:
 .. code-block:: php
 
     public function getRawModelDataInput(): array;
-    public function populate(array $modelData): self;
 
     public function setExample(float $example): self;
     public function getExample(): float;
 
+    public function populate(array $modelData): self;
+
 Now let's have a look at the behaviour of the generated model:
 
 .. code-block:: php
@@ -79,7 +80,7 @@ Now let's have a look at the behaviour of the generated model:
 
     If the **PopulatePostProcessor** is added to your model generator the populate method will be added to the model independently of the `immutable setting <../gettingStarted.html#immutable-classes>`__.
 
-The **PopulatePostProcessor** will also resolve all hooks which are applied to setters. Added code will be executed for all properties changed by a populate call.
+The **PopulatePostProcessor** will also resolve all hooks which are applied to setters. Added code will be executed for all properties changed by a populate call. Schema hooks which implement the **SetterAfterValidationHookInterface** will only be executed if all provided properties pass the validation.
 
 AdditionalPropertiesAccessorPostProcessor
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -170,10 +171,16 @@ What can you do inside your custom post processor?
 
 * Add additional traits and interfaces to your models
 * Add additional methods and properties to your models
-* Hook via SchemaHooks into the generated source code and add your snippets at defined places inside the model:
+* Hook via **SchemaHooks** into the generated source code and add your snippets at defined places inside the model:
 
     * Implement the **ConstructorBeforeValidationHookInterface** to add code to the beginning of your constructor
     * Implement the **ConstructorAfterValidationHookInterface** to add code to the end of your constructor
     * Implement the **GetterHookInterface** to add code to your getter methods
     * Implement the **SetterBeforeValidationHookInterface** to add code to the beginning of your setter methods
     * Implement the **SetterAfterValidationHookInterface** to add code to the end of your setter methods
+
+.. warning::
+
+    If a setter for a property is called with the same value which is already stored internally (consequently no update of the property is required), the setters will return directly and as a result of that the setter hooks will not be executed.
+
+    This behaviour also applies also to properties changed via the *populate* method added by the `PopulatePostProcessor <#populatepostprocessor>`__ and the *setAdditionalProperty* method added by the `AdditionalPropertiesAccessorPostProcessor <#additionalpropertiesaccessorpostprocessor>`__

docs/source/gettingStarted.rst

@@ -40,7 +40,7 @@ As an optional parameter you can set up a *GeneratorConfiguration* object to con
 
     $generator = new Generator(
         (new GeneratorConfiguration())
-            ->setNamespacePrefix('\MyApp\Model')
+            ->setNamespacePrefix('MyApp\Model')
             ->setImmutable(false)
     );
 
@@ -138,7 +138,7 @@ Further information about the generated namespaces can be found at `Namespaces <
 .. code-block:: php
 
     (new GeneratorConfiguration())
-        ->setNamespacePrefix('\MyApp\Model');
+        ->setNamespacePrefix('MyApp\Model');
 
 Immutable classes
 ^^^^^^^^^^^^^^^^^
@@ -225,6 +225,10 @@ If set to false, the generated model classes won't follow coding guidelines (but
     (new GeneratorConfiguration())
         ->setPrettyPrint(true);
 
+.. warning::
+
+    The ECS package must be installed manually: `composer require --dev symplify/easy-coding-standard`
+
 Serialization methods
 ^^^^^^^^^^^^^^^^^^^^^
 

docs/source/index.rst

@@ -7,6 +7,7 @@ Generates PHP model classes from JSON-Schema files including validation and prov
     :maxdepth: 2
 
     gettingStarted
+    examples
 
 .. include:: toc-generic.rst
 .. include:: toc-types.rst

phpunit.xml

@@ -1,23 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit backupGlobals="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         backupGlobals="false"
          backupStaticAttributes="false"
          colors="true"
          convertErrorsToExceptions="true"
          convertWarningsToExceptions="true"
          convertNoticesToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         bootstrap="tests/bootstrap.php">
-
-    <testsuite name="PHPModelGenerator">
-        <directory>tests</directory>
-        <exclude>tests/manual</exclude>
-    </testsuite>
-
-    <filter>
-        <whitelist>
-            <directory>src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+         bootstrap="tests/bootstrap.php"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+>
+  <coverage>
+    <include>
+      <directory>src</directory>
+    </include>
+  </coverage>
+  <testsuite name="PHPModelGenerator">
+    <directory>tests</directory>
+    <exclude>tests/manual</exclude>
+  </testsuite>
+</phpunit>

src/Model/Property/Property.php

@@ -34,6 +34,8 @@ class Property implements PropertyInterface
     protected $isPropertyRequired = true;
     /** @var bool */
     protected $isPropertyReadOnly = false;
+    /** @var bool */
+    protected $isPropertyInternal = false;
     /** @var string */
     protected $description = '';
     /** @var mixed */
@@ -81,7 +83,7 @@ public function getName(): string
      */
     public function getAttribute(): string
     {
-        return $this->attribute;
+        return ($this->isInternal() ? '_' : '') . $this->attribute;
     }
 
     /**
@@ -343,4 +345,21 @@ public function getNestedSchema(): ?Schema
     {
         return $this->schema;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function setInternal(bool $isPropertyInternal): PropertyInterface
+    {
+        $this->isPropertyInternal = $isPropertyInternal;
+        return $this;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isInternal(): bool
+    {
+        return $this->isPropertyInternal;
+    }
 }

src/Model/Property/PropertyInterface.php

@@ -144,6 +144,13 @@ public function setRequired(bool $isPropertyRequired): PropertyInterface;
      */
     public function setReadOnly(bool $isPropertyReadOnly): PropertyInterface;
 
+    /**
+     * @param bool $isPropertyInternal
+     *
+     * @return PropertyInterface
+     */
+    public function setInternal(bool $isPropertyInternal): PropertyInterface;
+
     /**
      * @param mixed $defaultValue
      *
@@ -166,6 +173,11 @@ public function isRequired(): bool;
      */
     public function isReadOnly(): bool;
 
+    /**
+     * @return bool
+     */
+    public function isInternal(): bool;
+
     /**
      * Set a nested schema
      *

src/Model/Property/PropertyProxy.php

@@ -228,4 +228,20 @@ public function getJsonSchema(): JsonSchema
     {
         return $this->getProperty()->getJsonSchema();
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function setInternal(bool $isPropertyInternal): PropertyInterface
+    {
+        return $this->getProperty()->setInternal($isPropertyInternal);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isInternal(): bool
+    {
+        return $this->getProperty()->isInternal();
+    }
 }

src/Model/RenderJob.php

@@ -9,6 +9,7 @@
 use PHPModelGenerator\Exception\FileSystemException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGenerator\Model\Validator\AbstractComposedPropertyValidator;
 use PHPModelGenerator\SchemaProcessor\Hook\SchemaHookResolver;
 use PHPModelGenerator\SchemaProcessor\PostProcessor\PostProcessorInterface;
 use PHPModelGenerator\Utils\RenderHelper;
@@ -124,32 +125,40 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
         $render = new Render(__DIR__ . '/../Templates/');
         $namespace = trim(join('\\', [$generatorConfiguration->getNamespacePrefix(), $this->classPath]), '\\');
 
-        $use = array_merge(
-            $this->schema->getUsedClasses(),
-            $generatorConfiguration->collectErrors()
-                ? [$generatorConfiguration->getErrorRegistryClass()]
-                : [ValidationException::class]
+        $use = array_unique(
+            array_merge(
+                $this->schema->getUsedClasses(),
+                $generatorConfiguration->collectErrors()
+                    ? [$generatorConfiguration->getErrorRegistryClass()]
+                    : [ValidationException::class]
+            )
         );
 
         // filter out non-compound uses and uses which link to the current namespace
         $use = array_filter($use, function ($classPath) use ($namespace) {
-            return strstr(str_replace($namespace, '', $classPath), '\\') ||
+            return strstr(trim(str_replace("$namespace", '', $classPath), '\\'), '\\') ||
                 (!strstr($classPath, '\\') && !empty($namespace));
         });
 
         try {
             $class = $render->renderTemplate(
                 'Model.phptpl',
                 [
-                    'namespace'              => $namespace,
-                    'use'                    => 'use ' . join(";\nuse ", array_unique($use)) . ';',
-                    'class'                  => $this->className,
-                    'schema'                 => $this->schema,
-                    'schemaHookResolver'     => new SchemaHookResolver($this->schema),
-                    'generatorConfiguration' => $generatorConfiguration,
-                    'viewHelper'             => new RenderHelper($generatorConfiguration),
+                    'namespace'                         => $namespace,
+                    'use'                               => $use,
+                    'class'                             => $this->className,
+                    'schema'                            => $this->schema,
+                    'schemaHookResolver'                => new SchemaHookResolver($this->schema),
+                    'generatorConfiguration'            => $generatorConfiguration,
+                    'viewHelper'                        => new RenderHelper($generatorConfiguration),
                     // one hack a day keeps the problems away. Make true literal available for the templating. Easy fix
-                    'true'                   => true,
+                    'true'                              => true,
+                    'baseValidatorsWithoutCompositions' => array_filter(
+                        $this->schema->getBaseValidators(),
+                        function ($validator) {
+                            return !is_a($validator, AbstractComposedPropertyValidator::class);
+                        }
+                    ),
                 ]
             );
         } catch (PHPMicroTemplateException $exception) {