Better class names

Detect duplicated classes

Author: Enno Woortmann

README.md

@@ -157,7 +157,7 @@ Requires to match 3 composition elements but matched 1 elements.
 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. 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.
+- 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.
 - 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.
 

src/Model/Schema.php

@@ -19,6 +19,8 @@
  */
 class Schema
 {
+    /** @var string */
+    protected $className;
     /** @var Property[] The properties which are part of the class */
     protected $properties = [];
     /** @var PropertyValidator[] A Collection of validators which must be applied
@@ -31,13 +33,23 @@ class Schema
     /**
      * Schema constructor.
      *
+     * @param string                     $className
      * @param SchemaDefinitionDictionary $dictionary
      */
-    public function __construct(SchemaDefinitionDictionary $dictionary = null)
+    public function __construct(string $className, SchemaDefinitionDictionary $dictionary = null)
     {
+        $this->className = $className;
         $this->schemaDefinitionDictionary = $dictionary ?? new SchemaDefinitionDictionary('');
     }
 
+    /**
+     * @return string
+     */
+    public function getClassName(): string
+    {
+        return $this->className;
+    }
+
     /**
      * @return PropertyInterface[]
      */

src/Model/SchemaDefinition/SchemaDefinitionDictionary.php

@@ -172,7 +172,8 @@ protected function parseExternalFile(
             throw new SchemaException("Invalid JSON-Schema file $jsonSchemaFilePath");
         }
 
-        $schema = new Schema(new self(dirname($jsonSchemaFilePath)));
+        // set up a dummy schema to fetch the definitions from the external file
+        $schema = new Schema('', new self(dirname($jsonSchemaFilePath)));
         $schema->getSchemaDictionary()->setUpDefinitionDictionary($jsonSchema, $schemaProcessor, $schema);
         $this->parsedExternalFileSchemas[$jsonSchemaFile] = $schema;
 

src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php

@@ -110,12 +110,12 @@ private function createMergedProperty(
         array $properties,
         array $propertyData
     ): PropertyInterface {
-        $mergedPropertySchema = new Schema();
         $mergedClassName = sprintf(
             '%s_Merged_%s', $this->schemaProcessor->getCurrentClassName(),
-            $propertyData['propertyData']['id'] ?? uniqid()
+            $propertyData['propertyData']['id'] ?? $compositionProperty->getName()
         );
 
+        $mergedPropertySchema = new Schema($mergedClassName);
         $mergedProperty = new Property('MergedProperty', $mergedClassName);
 
         foreach ($properties as $property) {

src/PropertyProcessor/Property/ObjectProcessor.php

@@ -27,7 +27,11 @@ public function process(string $propertyName, array $propertyData): PropertyInte
         $property = parent::process($propertyName, $propertyData);
 
         $className = ucfirst(
-            $propertyData['id'] ?? sprintf('%s_%s', $this->schemaProcessor->getCurrentClassName(), uniqid())
+            $propertyData['id'] ?? str_replace(
+                ' ',
+                '_',
+                sprintf('%s_%s_%s', $this->schemaProcessor->getCurrentClassName(), $propertyName, uniqid())
+            )
         );
 
         $schema = $this->schemaProcessor->processSchema(
@@ -39,9 +43,12 @@ public function process(string $propertyName, array $propertyData): PropertyInte
 
         $property
             ->addDecorator(
-                new ObjectInstantiationDecorator($className, $this->schemaProcessor->getGeneratorConfiguration())
+                new ObjectInstantiationDecorator(
+                    $schema->getClassName(),
+                    $this->schemaProcessor->getGeneratorConfiguration()
+                )
             )
-            ->setType($className)
+            ->setType($schema->getClassName())
             ->setNestedSchema($schema);
 
         return $property;

src/SchemaProcessor/SchemaProcessor.php

@@ -34,6 +34,8 @@ class SchemaProcessor
     /** @var string */
     protected $currentClassName;
 
+    /** @var array Collect processed schemas to avoid duplicated classes */
+    protected $processedSchema = [];
     /** @var array */
     protected $generatedFiles = [];
 
@@ -131,8 +133,20 @@ protected function generateModel(
         array $structure,
         SchemaDefinitionDictionary $dictionary
     ): Schema {
-        $schema = new Schema($dictionary);
+        $schemaSignature = md5(json_encode($structure));
+
+        if (isset($this->processedSchema[$schemaSignature])) {
+            if ($this->generatorConfiguration->isOutputEnabled()) {
+                // @codeCoverageIgnoreStart
+                echo "Duplicated signature $schemaSignature for class $className." .
+                    " Redirecting to {$this->processedSchema[$schemaSignature]->getClassName()}\n";
+                // @codeCoverageIgnoreEnd
+            }
+            return $this->processedSchema[$schemaSignature];
+        }
 
+        $schema = new Schema($className, $dictionary);
+        $this->processedSchema[$schemaSignature] = $schema;
         $structure['type'] = 'base';
 
         (new PropertyFactory(new PropertyProcessorFactory()))->create(

tests/Basic/BasicSchemaGenerationTest.php

@@ -6,6 +6,7 @@
 use PHPModelGenerator\ModelGenerator;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Tests\AbstractPHPModelGeneratorTest;
+use ReflectionClass;
 
 /**
  * Class BasicSchemaGenerationTest
@@ -199,4 +200,14 @@ public function testJsonSchemaWithInvalidPropertyTypeDefinitionThrowsAnException
 
         $this->generateClassFromFile('JSONSchemaWithInvalidPropertyTypeDefinition.json');
     }
+
+    public function testIdenticalSchemasAreMappedToOneClass(): void
+    {
+        $reflection = new ReflectionClass($this->generateClassFromFile('IdenticalSubSchema.json'));
+
+        $this->assertSame(
+            $reflection->getProperty('object1')->getDocComment(),
+            $reflection->getProperty('object2')->getDocComment()
+        );
+    }
 }

tests/PropertyProcessor/PropertyProcessorFactoryTest.php

@@ -41,7 +41,7 @@ public function testGetPropertyProcessor(string $type, string $expectedClass): v
             $type,
             new PropertyCollectionProcessor(),
             new SchemaProcessor('', '', new GeneratorConfiguration(), new RenderQueue()),
-            new Schema()
+            new Schema('')
         );
 
         $this->assertInstanceOf($expectedClass, $propertyProcessor);
@@ -79,7 +79,7 @@ public function testGetInvalidPropertyProcessorThrowsAnException()
             'Hello',
             new PropertyCollectionProcessor(),
             new SchemaProcessor('', '', new GeneratorConfiguration(), new RenderQueue()),
-            new Schema()
+            new Schema('')
         );
     }
 }

tests/Schema/BasicSchemaGenerationTest/IdenticalSubSchema.json

@@ -0,0 +1,27 @@
+{
+  "type": "object",
+  "properties": {
+    "object1": {
+      "type": "object",
+      "properties": {
+        "property1": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "property1"
+      ]
+    },
+    "object2": {
+      "type": "object",
+      "properties": {
+        "property1": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "property1"
+      ]
+    }
+  }
+}