Update serialization documentation

Added more namespaced tests

Author: wol-soft

.github/ISSUE_TEMPLATE/bug_report.md

@@ -16,8 +16,10 @@ A clear and concise description of what you expected to happen.
 **Schema**
 Please provide the schema which causes the issue. If multiple schemas are involved (eg. referenced schemas) please append a zip file with the complete structure.
 
+Additionally include custom GeneratorConfiguration settings.
+
 **Version:**
 Which version of the library do you use?
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here which might help to solve the issue.

docs/source/gettingStarted.rst

@@ -237,11 +237,11 @@ Generated interface:
 
 .. code-block:: php
 
-    public function toArray([int $depth = 512]): array;
-    public function toJSON([int $options = 0 [, int $depth = 512]]): string;
+    public function toArray([array $except = [] [, int $depth = 512]]): array;
+    public function toJSON([array $except = [] [, int $options = 0 [, int $depth = 512]]]): string;
     public function jsonSerialize(): array;
 
-The generated class will implement the interface **PHPModelGenerator\\Interfaces\\SerializationInterface** implemented in the php-json-schema-model-generator-production repository. This interface can be used to write additional generic modules to handle the generated models. The $depth parameter defines the maximum amount of nested objects which are serialized. The $options parameter for the toJSON method provides access to the underlying option bitmask of `json_encode <https://www.php.net/manual/de/function.json-encode.php>`_.
+The generated class will implement the interface **PHPModelGenerator\\Interfaces\\SerializationInterface** implemented in the php-json-schema-model-generator-production repository. This interface can be used to write additional generic modules to handle the generated models. Via the $except parameter you can pass an array of properties which will not be serialized (eg. password data for a user object). The $depth parameter defines the maximum amount of nested objects which are serialized. The $options parameter for the toJSON method provides access to the underlying option bitmask of `json_encode <https://www.php.net/manual/de/function.json-encode.php>`_.
 
 Additionally the class will implement the PHP builtin interface **\JsonSerializable** which allows the direct usage of the generated classes in a custom json_encode.
 

src/Model/GeneratorConfiguration.php

@@ -141,7 +141,7 @@ public function getNamespacePrefix(): string
      */
     public function setNamespacePrefix(string $namespacePrefix): self
     {
-        $this->namespacePrefix = $namespacePrefix;
+        $this->namespacePrefix = trim($namespacePrefix, '\\');
 
         return $this;
     }

tests/AbstractPHPModelGeneratorTest.php

@@ -392,6 +392,14 @@ public function implicitNullDataProvider(): array
         ];
     }
 
+    public function namespaceDataProvider(): array
+    {
+        return [
+            'No namespace' => [''],
+            'Custom namespace' => ['\MyApp\Model\\'],
+        ];
+    }
+
     /**
      * Get the annotated type for an object property
      *

tests/Basic/FilterTest.php

@@ -459,14 +459,20 @@ public function testFilterExceptionsAreCaught(): void
         new $className(['created' => 'Hello', 'name' => 12]);
     }
 
-    public function testAdditionalFilterOptions(): void
+    /**
+     * @dataProvider namespaceDataProvider
+     *
+     * @param string $namespace
+     */
+    public function testAdditionalFilterOptions(string $namespace): void
     {
         $className = $this->generateClassFromFile(
             'FilterOptions.json',
-            (new GeneratorConfiguration())->setSerialization(true)
+            (new GeneratorConfiguration())->setSerialization(true)->setNamespacePrefix($namespace)
         );
 
-        $object = new $className(['created' => '10122020']);
+        $fqcn = $namespace . $className;
+        $object = new $fqcn(['created' => '10122020']);
 
         $this->assertSame((new DateTime('2020-12-10'))->format(DATE_ATOM), $object->getCreated()->format(DATE_ATOM));
 
@@ -566,12 +572,17 @@ public static function exceptionFilter(string $value): void
         throw new Exception("Exception filter called with $value");
     }
 
-    public function testTransformingToScalarType()
+    /**
+     * @dataProvider namespaceDataProvider
+     *
+     * @param string $namespace
+     */
+    public function testTransformingToScalarType(string $namespace)
     {
         $className = $this->generateClassFromFile(
             'TransformingScalarFilter.json',
             (new GeneratorConfiguration())
-                ->setNamespacePrefix('\MyApp\Model')
+                ->setNamespacePrefix($namespace)
                 ->setSerialization(true)
                 ->setImmutable(false)
                 ->addFilter(
@@ -584,7 +595,7 @@ public function testTransformingToScalarType()
                 )
         );
 
-        $fqcn = "\\MyApp\\Model\\$className";
+        $fqcn = $namespace . $className;
         $object = new $fqcn(['value' => 9]);
 
         $this->assertSame('1001', $object->getValue());
@@ -645,16 +656,20 @@ public function testFilterChainWithTransformingFilter(): void
     }
 
     /**
-     * @dataProvider implicitNullDataProvider
+     * @dataProvider implicitNullNamespaceDataProvider
      *
      * @param bool $implicitNull
+     * @param string $namespace
      */
-    public function testFilterChainWithTransformingFilterOnMultiTypeProperty(bool $implicitNull): void
-    {
+    public function testFilterChainWithTransformingFilterOnMultiTypeProperty(
+        bool $implicitNull,
+        string $namespace
+    ): void {
         $className = $this->generateClassFromFile(
             'FilterChainMultiType.json',
             (new GeneratorConfiguration())
                 ->setImplicitNull($implicitNull)
+                ->setNamespacePrefix($namespace)
                 ->setSerialization(true)
                 ->setImmutable(false)
                 ->addFilter(
@@ -667,7 +682,8 @@ public function testFilterChainWithTransformingFilterOnMultiTypeProperty(bool $i
             false
         );
 
-        $object = new $className(['filteredProperty' => '2020-12-12 12:12:12']);
+        $fqcn = $namespace . $className;
+        $object = new $fqcn(['filteredProperty' => '2020-12-12 12:12:12']);
 
         $this->assertInstanceOf(DateTime::class, $object->getFilteredProperty());
         $this->assertSame('2020-12-12T00:00:00+00:00', $object->getFilteredProperty()->format(DateTime::ATOM));
@@ -681,6 +697,14 @@ public function testFilterChainWithTransformingFilterOnMultiTypeProperty(bool $i
         $this->assertSame(['filteredProperty' => '2020-12-12T00:00:00+0000'], $object->toArray());
     }
 
+    public function implicitNullNamespaceDataProvider(): array
+    {
+        return $this->combineDataProvider(
+            $this->implicitNullDataProvider(),
+            $this->namespaceDataProvider()
+        );
+    }
+
     public function testFilterAfterTransformingFilterIsSkippedIfTransformingFilterFails(): void
     {
         $this->expectException(ErrorRegistryException::class);