Class re-usage

Namespace documentation

Author: wol-soft

README.md

@@ -0,0 +1,63 @@
+Namespaces
+==========
+
+If a directory with subdirectories is converted into models the directory structure of the JSON-Schema files will be mirrored to the directory structure of the generated models.
+Models located in a subdirectory will contain a PSR-4 compatible namespace based on the directory structure.
+Set a namespace prefix with the `setNamespacePrefix` method of the `GeneratorConfiguration` object for locating the models inside your application or adding them to your composer autoloading configuration.
+
+An example structure of your JSON-Schema files for a user module may look like:
+
+.. code-block:: none
+
+    - Models
+        - Request
+            - Login.json
+            - Register.json
+            - Update.json
+        - Response
+            - Error
+                - UserExists.json
+            - Login.json
+            - Register.json
+            - Update.json
+    - Modules
+        - LoginData.json
+        - User.json
+        - Message.json
+    - generateModels.php
+
+Your model generation code inside `generateModels.php` now could look like:
+
+.. code-block:: php
+
+    $generator = new ModelGenerator((new GeneratorConfiguration())->setNamespacePrefix('MyApp\User'));
+
+    $generator
+        ->generateModelDirectory(__DIR__ . '/build')
+        ->generateModels(__DIR__ . '/Models', __DIR__ . '/build');
+
+The generated main classes will be:
+
+.. code-block:: none
+
+    - build
+        - Request
+            - Login.php (FQCN: `MyApp\User\Request\Login`)
+            - Register.php (FQCN: `MyApp\User\Request\Register`)
+            - Update.php (FQCN: `MyApp\User\Request\Update`)
+        - Response
+            - Error
+                - UserExists.php (FQCN: `MyApp\User\Response\Error\UserExists`)
+            - Login.php (FQCN: `MyApp\User\Response\Login`)
+            - Register.php (FQCN: `MyApp\User\Response\Register`)
+            - Update.php (FQCN: `MyApp\User\Response\Update`)
+
+Class re-usage
+--------------
+
+If referenced classes (eg. in the example given above the modules which may be used in multiple schemas) or nested classes occur multiple times the generator will detect the re-used class and link to the already generated object.
+The generator gives a `duplicated signature` hint in the output.
+
+The detection is not bound to namespace limits so a nested object which occurs in `Request\Register.json` as well as in `Response\Register.json` will be generated only once.
+Consequently the class generated to `Response\Register.php` may use classes from the `Request` namespace.
+A duplicated class is not linked to an already generated class if it's a primary object. The detection only links nested classes.

docs/source/generic/namespaces.rst

@@ -119,7 +119,8 @@ Namespace prefix
 
     setNamespacePrefix(string $prefix);
 
-Configures a namespace prefix for all generated classes. The namespaces will be extended with the directory structure of the source directory. By default no namespace prefix will be set.
+Configures a namespace prefix for all generated classes. By default no namespace prefix will be set. Generated namespaces are PSR-4 compatible.
+Further information about the generated namespaces can be found at `Namespaces <generic/namespaces.html>`__.
 
 .. code-block:: php
 
@@ -222,3 +223,14 @@ Enable or disable output of the generation process to STDOUT. By default the out
 
     (new GeneratorConfiguration())
         ->setOutputEnabled(false);
+
+The output contains information about generated classes, rendered classes, hints and warnings concerning the internal handling or the given schema files.
+The output of a generation process may look like:
+
+.. code-block:: none
+
+    Generated class MyApp\User\Response\Login
+    Generated class MyApp\User\Response\Register
+    Duplicated signature 444fd086d8d1f186145a6f81a3ac3f7a for class Register_Message. Redirecting to Login_Message
+    Rendered class MyApp\User\Response\Login
+    Rendered class MyApp\User\Response\Register

docs/source/gettingStarted.rst

@@ -4,5 +4,6 @@
 
     generic/required
     generic/default
+    generic/namespaces
     generic/meta
     generic/combinedException

docs/source/toc-generic.rst

@@ -188,8 +188,15 @@ protected function transferPropertiesToMergedSchema(Schema $mergedPropertySchema
                         return false;
                     })
                 );
+
+                // the parent schema needs to know about all imports of the nested classes as all properties of the
+                // nested classes are available in the parent schema (combined schema merging)
+                $this->schema->addNamespaceTransferDecorator(
+                    new SchemaNamespaceTransferDecorator($property->getNestedSchema())
+                );
             }
 
+            // make sure the merged schema knows all imports of the parent schema
             $mergedPropertySchema->addNamespaceTransferDecorator(new SchemaNamespaceTransferDecorator($this->schema));
         }
     }

src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php

@@ -41,6 +41,10 @@ public function process(string $propertyName, array $propertyData): PropertyInte
             $this->schema->getSchemaDictionary()
         );
 
+        // if the generated schema is located in a different namespace (the schema for the given structure in
+        // $propertyData is duplicated) add used classes to the current schema. By importing the class which is
+        // represented by $schema and by transferring all imports of $schema as well as imports for all properties
+        // of $schema to $this->schema the already generated schema can be used
         if ($schema->getClassPath() !== $this->schema->getClassPath()) {
             $this->schema->addUsedClass("{$schema->getClassPath()}\\{$schema->getClassName()}");
             $this->schema->addNamespaceTransferDecorator(new SchemaNamespaceTransferDecorator($schema, true));

src/PropertyProcessor/Property/ObjectProcessor.php

@@ -32,8 +32,10 @@ abstract class AbstractPHPModelGeneratorTest extends TestCase
     /**
      * Set up an empty directory for the tests
      */
-    public static function setUpBeforeClass(): void
+    public function setUp(): void
     {
+        parent::setUp();
+
         if (is_dir(sys_get_temp_dir() . '/PHPModelGeneratorTest')) {
             $di = new RecursiveDirectoryIterator(sys_get_temp_dir() . '/PHPModelGeneratorTest', FilesystemIterator::SKIP_DOTS);
             $ri = new RecursiveIteratorIterator($di, RecursiveIteratorIterator::CHILD_FIRST);
@@ -74,16 +76,6 @@ public function tearDown(): void
             }
         }
 
-        // clear the JSON schema definitions
-        foreach ($this->names as $name) {
-            @unlink(sys_get_temp_dir() . '/PHPModelGeneratorTest/' . $name . '.json');
-        }
-
-        // clear the generated class files
-        foreach ($this->generatedFiles as $file) {
-            @unlink($file);
-        }
-
         $this->names = [];
         $this->generatedFiles = [];
     }
@@ -119,7 +111,7 @@ private function copyExternalJSON(): void
      * @throws RenderException
      * @throws SchemaException
      */
-    public function generateClassFromFile(
+    protected function generateClassFromFile(
         string $file,
         GeneratorConfiguration $generatorConfiguration = null,
         bool $originalClassNames = false
@@ -145,7 +137,7 @@ public function generateClassFromFile(
      * @throws RenderException
      * @throws SchemaException
      */
-    public function generateClassFromFileTemplate(
+    protected function generateClassFromFileTemplate(
         string $file,
         array $values,
         GeneratorConfiguration $generatorConfiguration = null,
@@ -181,7 +173,7 @@ function ($item) use ($escape) {
      * @throws RenderException
      * @throws SchemaException
      */
-    public function generateClass(
+    protected function generateClass(
         string $jsonSchema,
         GeneratorConfiguration $generatorConfiguration = null,
         bool $originalClassNames = false
@@ -231,12 +223,39 @@ public function getClassName(
         foreach ($generatedFiles as $path) {
             $this->generatedFiles[] = $path;
 
-            require_once $path;
+            require $path;
         }
 
         return $className;
     }
 
+    /**
+     * Generate objects for all JSON-Schema files in the given directory
+     *
+     * @param string                 $directory
+     * @param GeneratorConfiguration $configuration
+     * @return array
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
+     */
+    protected function generateDirectory(string $directory, GeneratorConfiguration $configuration): array
+    {
+        $generatedClasses = (new ModelGenerator($configuration))->generateModels(
+            __DIR__ . '/Schema/' . $this->getStaticClassName() . '/' . $directory,
+            MODEL_TEMP_PATH
+        );
+
+        foreach ($generatedClasses as $path) {
+            $this->generatedFiles[] = $path;
+
+            require $path;
+        }
+
+        return $generatedClasses;
+    }
+
     /**
      * Combine two data providers
      *

tests/AbstractPHPModelGeneratorTest.php

@@ -168,22 +168,11 @@ public function testNamespacePrefix(): void
 
     public function testFolderIsGeneratedRecursively(): void
     {
-        (new ModelGenerator(
-            (new GeneratorConfiguration())
-                ->setNamespacePrefix('\\Application')
-                ->setPrettyPrint(false)
-                ->setOutputEnabled(false)
-        ))->generateModels(
-            __DIR__ . '/../Schema/BasicSchemaGenerationTest/RecursiveTest',
-            MODEL_TEMP_PATH
+        $this->generateDirectory(
+            'RecursiveTest',
+            (new GeneratorConfiguration())->setNamespacePrefix('\\Application')->setOutputEnabled(false)
         );
 
-        $mainClassFile = MODEL_TEMP_PATH . DIRECTORY_SEPARATOR . 'MainClass.php';
-        $subClassFile = MODEL_TEMP_PATH . DIRECTORY_SEPARATOR . 'SubFolder' . DIRECTORY_SEPARATOR . 'SubClass.php';
-
-        require_once $mainClassFile;
-        require_once $subClassFile;
-
         $mainClassFQCN = '\\Application\\MainClass';
         $mainObject = new $mainClassFQCN(['property' => 'Hello']);
 
@@ -193,10 +182,6 @@ public function testFolderIsGeneratedRecursively(): void
         $subObject = new $subClassFQCN(['property' => 3]);
 
         $this->assertSame(3, $subObject->getProperty());
-
-        unlink($mainClassFile);
-        unlink($subClassFile);
-        rmdir(MODEL_TEMP_PATH . DIRECTORY_SEPARATOR . 'SubFolder');
     }
 
     public function testInvalidJsonSchemaFileThrowsAnException(): void
@@ -223,80 +208,6 @@ public function testJsonSchemaWithInvalidPropertyTypeDefinitionThrowsAnException
         $this->generateClassFromFile('JSONSchemaWithInvalidPropertyTypeDefinition.json');
     }
 
-    public function testIdenticalSchemasAreMappedToOneClass(): void
-    {
-        $className = $this->generateClassFromFile('IdenticalSubSchema.json');
-
-        $reflection = new ReflectionClass($className);
-
-        $this->assertSame(
-            $reflection->getProperty('object1')->getDocComment(),
-            $reflection->getProperty('object2')->getDocComment()
-        );
-
-        $object = new $className([
-            'object1' => ['property1' => 'Hello'],
-            'object2' => ['property1' => 'Goodbye'],
-        ]);
-
-        $this->assertSame('Hello', $object->getObject1()->getProperty1());
-        $this->assertSame('Goodbye', $object->getObject2()->getProperty1());
-
-        $this->assertSame(get_class($object->getObject1()), get_class($object->getObject2()));
-    }
-
-    public function testIdenticalSchemasAreMappedToOneClassFromDifferentNamespaces(): void
-    {
-        ob_start();
-
-        $generatedClasses = (new ModelGenerator(
-            (new GeneratorConfiguration())
-                ->setNamespacePrefix('Application')
-                ->setPrettyPrint(false)
-        ))->generateModels(
-            __DIR__ . '/../Schema/BasicSchemaGenerationTest/IdenticalSubSchemaDifferentNamespace',
-            MODEL_TEMP_PATH
-        );
-
-        $output = ob_get_contents();
-
-        // check for output warnings/messages
-        $this->assertRegExp('/(.*)Generated class Application\\\SubFolder1\\\SubSchema(.*)/m', $output);
-        $this->assertRegExp('/(.*)Rendered class Application\\\SubFolder1\\\SubSchema(.*)/m', $output);
-        $this->assertRegExp('/(.*)Duplicated signature (.*) for class (.*) Redirecting to(.*)/m', $output);
-        $this->assertRegExp(
-            '/(.*)Warning: empty composition for property2 may lead to unexpected results(.*)/m',
-            $output
-        );
-
-        ob_end_clean();
-
-        foreach ($generatedClasses as $path) {
-            require_once $path;
-        }
-
-        $subClass1FQCN = '\\Application\\SubFolder1\\SubSchema';
-        $subObject1 = new $subClass1FQCN(['object1' => ['property1' => 'Hello'], 'property3' => 3]);
-
-        $this->assertSame('Hello', $subObject1->getObject1()->getProperty1());
-        $this->assertSame(3, $subObject1->getProperty3());
-
-        $subClass2FQCN = '\\Application\\SubFolder2\\SubSchema';
-        $subObject2 = new $subClass2FQCN(['object1' => ['property1' => 'Goodbye'], 'property3' => true]);
-
-        $this->assertSame('Goodbye', $subObject2->getObject1()->getProperty1());
-        $this->assertSame(true, $subObject2->getProperty3());
-
-        $this->assertSame(get_class($subObject1->getObject1()), get_class($subObject2->getObject1()));
-
-        foreach ($generatedClasses as $path) {
-            unlink($path);
-        }
-
-        rmdir(MODEL_TEMP_PATH . DIRECTORY_SEPARATOR . 'SubFolder1');
-        rmdir(MODEL_TEMP_PATH . DIRECTORY_SEPARATOR . 'SubFolder2');
-    }
-
     public function testDuplicateIdThrowsAnException(): void
     {
         $this->expectException(FileSystemException::class);