Throw an exception on invalid property name

Add documentation for multi types and objects
Optimize exception messages for object size validation

Author: wol-soft

docs/source/complexTypes/multiType.rst

@@ -0,0 +1,59 @@
+Multi Type
+==========
+
+By providing an array with types for a property multiple types can be allowed.
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": ["number", "string"]
+            }
+        }
+    }
+
+Generated interface (doesn't contain type hints as multiple types are allowed):
+
+.. code-block:: php
+
+    public function setExample($example): self;
+    public function getExample();
+
+Possible exceptions:
+
+* Invalid type for property. Requires [float, string], got __TYPE__
+
+Additional validators
+---------------------
+
+For each type given in the allowed types array additional validators may be added to the property:
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": ["number", "string", "array"],
+                "minimum": 10,
+                "minLength": 4,
+                "items": {
+                    "type": "string"
+                },
+                "minItems": 2
+            }
+        }
+    }
+
+The validators are applied if the given input matches the corresponding type.
+For example if an array **["Hello", 123, "Goodbye"]** is given the validation will fail as numbers aren't allowed in arrays:
+
+.. code-block:: none
+
+    Invalid item in array example:
+      - invalid item #1
+        * Invalid type for item of array example. Requires string, got integer

docs/source/complexTypes/object.rst

@@ -0,0 +1,222 @@
+Object
+======
+
+Properties which contain an object will result in an additional PHP class. The PHP classes will be connected via type hinting to provide autocompletion during the development.
+
+.. code-block:: json
+
+    {
+        "$id": "person",
+        "type": "object",
+        "properties": {
+            "name": {
+                "type": "string"
+            },
+            "car": {
+                "$id": "car",
+                "type": "object",
+                "properties": {
+                    "model": {
+                        "type": "string"
+                    },
+                    "ps": {
+                        "type": "integer"
+                    }
+                }
+            }
+        }
+    }
+
+Generated interface:
+
+.. code-block:: php
+
+    // class Person
+    public function setName(?string $name): self;
+    public function getName(): ?string;
+    public function setCar(?Car $name): self;
+    public function getCar(): ?Car;
+
+    // class Car
+    public function setModel(?string $name): self;
+    public function getModel(): ?string;
+    public function setPs(?int $name): self;
+    public function getPs(): ?int;
+
+Possible exceptions:
+
+* Invalid type for car. Requires object, got __TYPE__
+
+The nested object will be validated in the nested class Car which may throw additional exceptions if invalid data is provided.
+
+Namespaces
+----------
+
+If a nested class is generated the nested class will be located in the same namespace as the parent class.
+If the nested class occurs somewhere else and has already been generated a class from another namespace may be used (compare `namespaces <../generic/namespaces.html>`__ for additional information concerning class re-usage).
+
+Property Name Normalization
+---------------------------
+
+Property names are normalized to provide valid and readable PHP code. All non alpha numeric characters will be removed.
+
+.. code-block:: json
+
+    {
+        "type": "object",
+        "properties": {
+            "underscore_property-minus": {
+                "type": "string"
+            },
+            "CAPS and space 100": {
+                "type": "string"
+            }
+        }
+    }
+
+Generated interface:
+
+.. code-block:: php
+
+    public function setUnderscorePropertyMinus(?string $name): self;
+    public function getUnderscorePropertyMinus(): ?string;
+    public function setCapsAndSpace100(?string $name): self;
+    public function getCapsAndSpace100(): ?string;
+
+If the name normalization results in an empty attribute name (eg. '__ -- __') an exception will be thrown.
+
+Required properties
+-------------------
+
+Using the keyword `required` a list of properties may be defined which must be provided.
+
+
+.. code-block:: json
+
+    {
+        "$id": "person",
+        "type": "object",
+        "properties": {
+            "name": {
+                "type": "string"
+            },
+            "age": {
+                "type": "integer"
+            }
+        },
+        "required": [
+            "name"
+        ]
+    }
+
+Possible exceptions:
+
+* Missing required value for name
+
+.. warning::
+
+    Properties defined in the `required` array but not defined in the `properties` section of the object aren't validated. Consequently provided objects missing these fields may be considered valid.
+
+Size
+----
+
+With the keywords `minProperties` and `maxProperties` the number of allowed properties can be limited:
+
+.. code-block:: json
+
+    {
+        "$id": "person",
+        "type": "object",
+        "properties": {
+            "name": {
+                "type": "string"
+            }
+        },
+        "minProperties": 2,
+        "maxProperties": 3
+    }
+
+Possible exceptions:
+
+* Provided object for person must not contain less than 2 properties
+* Provided object for person must not contain more than 3 properties
+
+Additional Properties
+---------------------
+
+Using the keyword `additionalProperties` the object can be limited to not contain any additional properties by providing `false`. If a schema is provided all additional properties must be valid against the provided schema. Simple checks like 'must provide a string' are possible as well as checks like 'must contain an object with a specific structure'.
+
+.. code-block:: json
+
+    {
+        "$id": "example",
+        "type": "object",
+        "properties": {
+            "example": {
+                "type": "integer"
+            }
+        },
+        "additionalProperties": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "age": {
+                    "type": "integer"
+                }
+            }
+        }
+    }
+
+Possible exceptions:
+
+* Provided JSON contains not allowed additional properties [additional1, additional2]
+
+If invalid additional properties are provided a detailed exception will be thrown containing all violations:
+
+.. code-block:: none
+
+    Provided JSON contains invalid additional properties.
+      - invalid additional property 'additional1'
+        * Invalid type for name. Requires string, got integer
+      - invalid additional property 'additional2'
+        * Invalid type for age. Requires int, got string
+
+Property Names
+--------------
+
+With the keyword `propertyNames` rules can be defined which must be fulfilled by each given property.
+
+.. code-block:: json
+
+    {
+        "type": "object",
+        "propertyNames": {
+            "pattern": "^test[0-9]+$",
+            "maxLength": 8
+        }
+    }
+
+Compare `strings <../types/string.html>`__ for information concerning possible property name validators.
+
+Exceptions contain detailed information about the violations:
+
+.. code-block:: none
+
+    Provided JSON contains properties with invalid names.
+      - invalid property 'test12345a'
+        * Value for property name doesn't match pattern ^test[0-9]+$
+        * Value for property name must not be longer than 8
+      - invalid property 'test123456789'
+        * Value for property name must not be longer than 8
+
+Dependencies
+------------
+
+Object dependencies are currently not supported.
+
+Pattern Properties
+------------------
+
+Pattern properties are currently not supported.

docs/source/toc-complexTypes.rst

@@ -2,5 +2,7 @@
     :caption: Complex Types
     :maxdepth: 1
 
+    complexTypes/object
     complexTypes/array
     complexTypes/enum
+    complexTypes/multiType

docs/source/types/string.rst

@@ -79,4 +79,4 @@ Possible exceptions:
 Format
 ------
 
-String formats are currently not supported
+String formats are currently not supported.

src/Model/Property/Property.php

@@ -4,6 +4,7 @@
 
 namespace PHPModelGenerator\Model\Property;
 
+use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
@@ -46,6 +47,8 @@ class Property implements PropertyInterface
      *
      * @param string $name
      * @param string $type
+     *
+     * @throws SchemaException
      */
     public function __construct(string $name, string $type)
     {
@@ -217,10 +220,12 @@ public function hasDecorators(): bool
      * @param string $name
      *
      * @return string
+     *
+     * @throws SchemaException
      */
     protected function processAttributeName(string $name): string
     {
-        $name = preg_replace_callback(
+        $attributeName = preg_replace_callback(
             '/([a-z][a-z0-9]*)([A-Z])/',
             function ($matches) {
                 return "{$matches[1]}-{$matches[2]}";
@@ -232,10 +237,16 @@ function ($matches) {
             function ($element) {
                 return ucfirst(strtolower($element));
             },
-            preg_split('/[^a-z0-9]/i', $name)
+            preg_split('/[^a-z0-9]/i', $attributeName)
         );
 
-        return lcfirst(join('', $elements));
+        $attributeName = lcfirst(join('', $elements));
+
+        if (empty($attributeName)) {
+            throw new SchemaException("Property name '$name' results in an empty attribute name");
+        }
+
+        return $attributeName;
     }
 
     /**

src/Model/RenderJob.php

@@ -121,6 +121,7 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
                 : [$generatorConfiguration->getExceptionClass()]
         );
 
+        // TODO: filter out uses in the same namespace
         // filter out non-compound namespaces
         $use = array_filter($use, function ($classPath) {
             return strstr($classPath, '\\');