Merge pull request #36 from wol-soft/PatternProperties

Pattern Properties

Author: wol-soft

.coveralls.yml

@@ -1,3 +1,3 @@
-service_name: travis-ci
+service_name: github-actions
 coverage_clover: build/logs/clover.xml
 json_path: build/logs/coveralls-upload.json

.github/workflows/main.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['7.2', '7.3', '7.4', '8.0']
+
+    name: PHP ${{ matrix.php }} tests
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: mbstring, json
+          coverage: xdebug
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: Prepare codeclimate test reporter
+        if: ${{ matrix.php == '8.0' }}
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+
+      - name: Execute tests
+        run: XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-clover=build/logs/clover.xml --testdox
+
+      - name: Upload the reports to coveralls.io
+        if: ${{ matrix.php == '8.0' }}
+        run: |
+          composer global require php-coveralls/php-coveralls
+          php-coveralls -v
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload the reports to codeclimate
+        if: ${{ matrix.php == '8.0' }}
+        run: sudo ./cc-test-reporter after-build -r $CC_TEST_REPORTER_ID
+        env:
+          CC_TEST_REPORTER_ID: 5e32818628fac9eb11d34e2b35289f88169610cc4a98c6f170c74923342284f1

.travis.yml

@@ -160,8 +160,8 @@ The class generation process basically splits up into three to four steps:
 
 - Scan the given source directory to find all *.json files which should be processed.
 - Loop over all schemas which should be generated. This is the main step of the class generation. Now each schema is parsed and a Schema model class which holds the properties for the generated model is populated. All validation rules defined in the JSON-Schema are translated into plain PHP code. After the model is finished a RenderJob is generated and added to the RenderQueue. If a JSON-Schema contains nested objects or references multiple RenderJobs may be added to the RenderQueue for a given schema file.
+- If post processors are defined for the generation process the post processors will be applied.
 - After all schema files have been parsed without an error the RenderQueue will be worked off. All previous added RenderJobs will be executed and the PHP classes will be saved to the filesystem at the given destination directory.
-- If pretty printing is enabled the generated PHP classes will be cleaned up for a better code formatting. Done.
 
 ## Tests ##
 

README.md

@@ -11,7 +11,7 @@
         }
     ],
     "require": {
-        "wol-soft/php-json-schema-model-generator-production": "^0.16.0",
+        "wol-soft/php-json-schema-model-generator-production": "dev-PatternProperties",
         "wol-soft/php-micro-template": "^1.3.2",
 
         "php": ">=7.2",
@@ -21,9 +21,6 @@
     "require-dev": {
         "phpunit/phpunit": "^8.5 || ^9.4"
     },
-    "suggest": {
-        "symplify/easy-coding-standard": "Allows pretty printing of the generated code"
-    },
     "autoload": {
         "psr-4": {
             "PHPModelGenerator\\": "src"

composer.json

@@ -514,4 +514,48 @@ Multiple violations against the schema dependency may be included.
 Pattern Properties
 ------------------
 
-Pattern properties are currently not supported.
+Using the keyword `patternProperties` further restrictions for properties matching a pattern can be defined.
+
+.. hint::
+
+    If you define constraints via `patternProperties` you may want to use the `PatternPropertiesAccessorPostProcessor <../generator/postProcessor.html#patternpropertiesaccessorpostprocessor>`__ to access your pattern properties.
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": "integer"
+            }
+        },
+        "patternProperties": {
+            "^a": {
+                "type": "string"
+            }
+        }
+    }
+
+Possible exceptions:
+
+If invalid pattern properties are provided a detailed exception will be thrown containing all violations:
+
+.. code-block:: none
+
+    Provided JSON for Example contains invalid pattern properties.
+      - invalid property 'a0' matching pattern '\^a'
+        * Invalid type for pattern property. Requires string, got integer
+
+The thrown exception will be a *PHPModelGenerator\\Exception\\Object\\InvalidPatternPropertiesException* which provides the following methods to get further error details:
+
+.. code-block:: php
+
+    // returns a two-dimensional array which contains all validation exceptions grouped by property names
+    public function getNestedExceptions(): array
+    // get the pattern which lead to the error
+    public function getPattern(): string
+    // get the name of the property which failed
+    public function getPropertyName(): string
+    // get the value provided to the property
+    public function getProvidedValue()

docs/source/complexTypes/object.rst

@@ -25,4 +25,4 @@ The Ebay OpenAPIv3 spec for the sell-inventory API is an around 6000 lines API d
         ->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.
+Measured runtime of the script is around 3 seconds at a memory peak consumption between 5 and 6 MB.

docs/source/examples.rst

@@ -136,14 +136,75 @@ Generated interface with the **AdditionalPropertiesAccessorPostProcessor**:
 
 **getAdditionalProperty**: Returns the current value of a single additional property. If the requested property doesn't exist null will be returned. Returns as well as *getAdditionalProperties* the processed values.
 
-**setAdditionalProperty**: Adds or updates an additional property. Performs all necessary validations like property names or min and max properties validations will be performed. If the additional properties are processed via a transforming filter an already transformed value will be accepted. If a property which is regularly defined in the schema a *RegularPropertyAsAdditionalPropertyException* will be thrown. If the change is valid and performed also the output of *getRawModelDataInput* will be updated.
+**setAdditionalProperty**: Adds or updates an additional property. Performs all necessary validations like property names or min and max properties validations. If the additional properties are processed via a transforming filter an already transformed value will be accepted. If a property which is regularly defined in the schema a *RegularPropertyAsAdditionalPropertyException* will be thrown. If the change is valid and performed also the output of *getRawModelDataInput* will be updated.
 
 **removeAdditionalProperty**: Removes an existing additional property from the model. Returns true if the additional property has been removed, false otherwise (if no additional property with the requested key exists). May throw a *MinPropertiesException* if the change would result in an invalid model state. If the change is valid and performed also the output of *getRawModelDataInput* will be updated.
 
 Serialization
 ~~~~~~~~~~~~~
 
-By default additional properties are not included in serialized models. If the **AdditionalPropertiesAccessorPostProcessor** is applied and `serialization <../gettingStarted.html#serialization-methods>`__ is enabled the additional properties will be merged into the serialization result. If the additional properties are processed via a transforming filter each value will be serialized via the serialisation method of the transforming filter.
+By default additional properties are only included in the serialized models if the *additionalProperties* field is set to true or contains further restrictions. If the option *$addForModelsWithoutAdditionalPropertiesDefinition* is set to true also additional properties for entities which don't define the *additionalProperties* field will be included in the serialization result. If the **AdditionalPropertiesAccessorPostProcessor** is applied and `serialization <../gettingStarted.html#serialization-methods>`__ is enabled the additional properties will be merged into the serialization result. If the additional properties are processed via a transforming filter each value will be serialized via the serialisation method of the transforming filter.
+
+PatternPropertiesAccessorPostProcessor
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: php
+
+    $generator = new ModelGenerator();
+    $generator->addPostProcessor(new PatternPropertiesAccessorPostProcessor());
+
+The **PatternPropertiesAccessorPostProcessor** adds methods to your model to work with `pattern properties <../complexTypes/object.html#pattern-properties>`__ on your objects. The methods will only be added if the schema for the object defines pattern properties.
+
+Added methods
+~~~~~~~~~~~~~
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": "string"
+            }
+        },
+        "patternProperties": {
+            "^a": {
+                "type": "string"
+            },
+            "^b": {
+                "key": "numbers"
+                "type": "integer"
+            },
+        }
+    }
+
+Generated interface with the **AdditionalPropertiesAccessorPostProcessor**:
+
+.. code-block:: php
+
+    public function getRawModelDataInput(): array;
+
+    public function setExample(float $example): self;
+    public function getExample(): float;
+
+    public function getPatternProperties(string $key): array;
+
+The added method **getPatternProperties** can be used to fetch a list of all properties matching the given pattern. As *$key* you have to provide the pattern you want to fetch. Alternatively you can define a key in your schema and use the key to fetch the properties.
+
+.. code-block:: php
+
+    $myObject = new Example('a1' => 'Hello', 'b1' => 100);
+
+    // fetches all properties matching the pattern '^a', consequently will return ['a1' => 'Hello']
+    $myObject->getPatternProperties('^a');
+
+    // fetches all properties matching the pattern '^b' (which has a defined key), consequently will return ['b1' => 100]
+    $myObject->getPatternProperties('numbers');
+
+.. note::
+
+    If you want to add or remove pattern properties to your object after the object instantiation you can use the `AdditionalPropertiesAccessorPostProcessor <generator/postProcessor.html#additionalpropertiesaccessorpostprocessor>`__ or the `PopulatePostProcessor <generator/postProcessor.html#populatepostprocessor>`__
 
 Custom Post Processors
 ----------------------

docs/source/generator/postProcessor.rst

@@ -11,7 +11,7 @@ The recommended way to install php-json-model-generator is through `Composer <ht
     composer require --dev wol-soft/php-json-schema-model-generator
     composer require wol-soft/php-json-schema-model-generator-production
 
-To avoid adding all dependencies of the php-json-model-generator to your production dependencies it's recommended to add the library as a dev-dependency and include the php-json-model-generator-exception library. The exception library provides all classes to run the generated code. Generating the classes should either be a step done in the development environment or as a build step of your application (which is the recommended workflow).
+To avoid adding all dependencies of the php-json-model-generator to your production dependencies it's recommended to add the library as a dev-dependency and include the php-json-model-generator-production library. The production library provides all classes to run the generated code. Generating the classes should either be a step done in the development environment or as a build step of your application (which is the recommended workflow).
 
 Generating classes
 ------------------
@@ -254,24 +254,6 @@ If you want to customize the exception handling you can set an own ErrorRegistry
     (new GeneratorConfiguration())
         ->setErrorRegistryClass(MyCustomException::class);
 
-Code style of the generated classes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: php
-
-    setPrettyPrint(bool $prettyPrint);
-
-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.
-
-.. code-block:: php
-
-    (new GeneratorConfiguration())
-        ->setPrettyPrint(true);
-
-.. warning::
-
-    The ECS package must be installed manually: `composer require --dev symplify/easy-coding-standard`
-
 Serialization methods
 ^^^^^^^^^^^^^^^^^^^^^
 

docs/source/gettingStarted.rst

@@ -7,7 +7,6 @@
 use PHPModelGenerator\Exception\InvalidFilterException;
 use PHPModelGenerator\Filter\FilterInterface;
 use PHPModelGenerator\Filter\TransformingFilterInterface;
-use PHPModelGenerator\Format\FormatValidatorFromRegEx;
 use PHPModelGenerator\Format\FormatValidatorInterface;
 use PHPModelGenerator\PropertyProcessor\Filter\DateTimeFilter;
 use PHPModelGenerator\PropertyProcessor\Filter\NotEmptyFilter;
@@ -34,8 +33,6 @@ class GeneratorConfiguration
     /** @var bool */
     protected $denyAdditionalProperties = false;
     /** @var bool */
-    protected $prettyPrint = false;
-    /** @var bool */
     protected $outputEnabled = true;
     /** @var bool */
     protected $collectErrors = true;
@@ -76,7 +73,10 @@ public function __construct()
     public function addFilter(FilterInterface ...$additionalFilter): self
     {
         foreach ($additionalFilter as $filter) {
-            $this->validateFilterCallback($filter->getFilter(), "Invalid filter callback for filter {$filter->getToken()}");
+            $this->validateFilterCallback(
+                $filter->getFilter(),
+                "Invalid filter callback for filter {$filter->getToken()}"
+            );
 
             if ($filter instanceof TransformingFilterInterface) {
                 $this->validateFilterCallback(
@@ -253,26 +253,6 @@ public function setDenyAdditionalProperties(bool $denyAdditionalProperties): sel
         return $this;
     }
 
-    /**
-     * @return bool
-     */
-    public function hasPrettyPrintEnabled(): bool
-    {
-        return $this->prettyPrint;
-    }
-
-    /**
-     * @param bool $prettyPrint
-     *
-     * @return $this
-     */
-    public function setPrettyPrint(bool $prettyPrint): self
-    {
-        $this->prettyPrint = $prettyPrint;
-
-        return $this;
-    }
-
     /**
      * @return bool
      */

src/Model/GeneratorConfiguration.php

@@ -61,16 +61,17 @@ public function __construct(
             $propertiesStructure->withJson($propertiesStructure->getJson()[static::ADDITIONAL_PROPERTIES_KEY])
         );
 
+        $patternProperties = array_keys($schema->getJsonSchema()->getJson()['patternProperties'] ?? []);
+
         parent::__construct(
             new Property($propertyName ?? $schema->getClassName(), null, $propertiesStructure),
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'AdditionalProperties.phptpl',
             [
                 'validationProperty' => $this->validationProperty,
-                'additionalProperties' => preg_replace(
-                    '(\d+\s=>)',
-                    '',
-                    var_export(array_keys($propertiesStructure->getJson()[static::PROPERTIES_KEY] ?? []), true)
+                'additionalProperties' => RenderHelper::varExportArray(
+                    array_keys($propertiesStructure->getJson()[static::PROPERTIES_KEY] ?? [])
                 ),
+                'patternProperties' => $patternProperties ? RenderHelper::varExportArray($patternProperties) : null,
                 'generatorConfiguration' => $schemaProcessor->getGeneratorConfiguration(),
                 'viewHelper' => new RenderHelper($schemaProcessor->getGeneratorConfiguration()),
                 // by default don't collect additional property data

src/Model/Validator/AdditionalPropertiesValidator.php

@@ -6,6 +6,7 @@
 
 use PHPModelGenerator\Exception\Generic\EnumException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Utils\RenderHelper;
 
 /**
  * Class EnumValidator
@@ -25,9 +26,7 @@ public function __construct(PropertyInterface $property, array $allowedValues)
 
         parent::__construct(
             $property,
-            '!in_array($value, ' .
-                preg_replace('(\d+\s=>)', '', var_export($allowedValues, true)) .
-            ', true)',
+            '!in_array($value, ' . RenderHelper::varExportArray($allowedValues) . ', true)',
             EnumException::class,
             [$allowedValues]
         );