improved dulicate names detection in bean descriptor

Author: Kharhamel

src/Utils/BeanDescriptor.php

@@ -110,6 +110,18 @@ class BeanDescriptor implements BeanDescriptorInterface
      * @var BeanRegistry
      */
     private $registry;
+    /**
+     * @var int[]
+     */
+    private $descriptorsByMethodName = [];
+    /**
+     * @var DirectForeignKeyMethodDescriptor[]|null
+     */
+    private $directForeignKeysDescriptors = null;
+    /**
+     * @var PivotTableMethodsDescriptor[]|null
+     */
+    private $pivotTableDescriptors = null;
 
     public function __construct(
         Table $table,
@@ -144,6 +156,18 @@ public function __construct(
     public function initBeanPropertyDescriptors(): void
     {
         $this->beanPropertyDescriptors = $this->getProperties($this->table);
+
+        //init the list of method names with regular properties names
+        foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
+            $name = $beanPropertyDescriptor->getGetterName();
+            if (!isset($this->descriptorsByMethodName[$name])) {
+                $this->descriptorsByMethodName[$name] = 0;
+            }
+            $this->descriptorsByMethodName[$name] ++;
+            if ($this->descriptorsByMethodName[$name] > 1) {
+                $beanPropertyDescriptor->useAlternativeName();
+            }
+        }
     }
 
     /**
@@ -373,38 +397,68 @@ private function generateBeanConstructor() : MethodGenerator
      */
     private function getDirectForeignKeysDescriptors(): array
     {
+        if ($this->directForeignKeysDescriptors !== null) {
+            return $this->directForeignKeysDescriptors;
+        }
         $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
 
         $descriptors = [];
 
         foreach ($fks as $fk) {
-            $descriptors[] = new DirectForeignKeyMethodDescriptor($fk, $this->table, $this->namingStrategy, $this->annotationParser, $this->beanNamespace);
+            /** @var DirectForeignKeyMethodDescriptor $desc */
+            $desc = $this->checkForDuplicate(new DirectForeignKeyMethodDescriptor($fk, $this->table, $this->namingStrategy, $this->annotationParser, $this->beanNamespace));
+            $descriptors[] = $desc;
         }
 
-        return $descriptors;
+        $this->directForeignKeysDescriptors = $descriptors;
+        return $this->directForeignKeysDescriptors;
     }
 
     /**
      * @return PivotTableMethodsDescriptor[]
      */
     private function getPivotTableDescriptors(): array
     {
+        if ($this->pivotTableDescriptors !== null) {
+            return $this->pivotTableDescriptors;
+        }
         $descs = [];
         foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) {
             // There are exactly 2 FKs since this is a pivot table.
             $fks = array_values($table->getForeignKeys());
 
             if ($fks[0]->getForeignTableName() === $this->table->getName()) {
                 list($localFk, $remoteFk) = $fks;
-                $descs[] = new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser);
+                /** @var PivotTableMethodsDescriptor $desc */
+                $desc = $this->checkForDuplicate(new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser));
+                $descs[] = $desc;
             }
             if ($fks[1]->getForeignTableName() === $this->table->getName()) {
                 list($remoteFk, $localFk) = $fks;
-                $descs[] = new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser);
+                /** @var PivotTableMethodsDescriptor $desc */
+                $desc = $this->checkForDuplicate(new PivotTableMethodsDescriptor($table, $localFk, $remoteFk, $this->namingStrategy, $this->beanNamespace, $this->annotationParser));
+                $descs[] = $desc;
             }
         }
 
-        return $descs;
+        $this->pivotTableDescriptors = $descs;
+        return $this->pivotTableDescriptors;
+    }
+
+    /**
+     * Check the method name isn't already used and flag the $descriptor to use its alternative name if it is the case
+     */
+    public function checkForDuplicate(MethodDescriptorInterface $descriptor): MethodDescriptorInterface
+    {
+        $name = $descriptor->getName();
+        if (!isset($this->descriptorsByMethodName[$name])) {
+            $this->descriptorsByMethodName[$name] = 0;
+        }
+        $this->descriptorsByMethodName[$name] ++;
+        if ($this->descriptorsByMethodName[$name] > 1) {
+            $descriptor->useAlternativeName();
+        }
+        return $descriptor;
     }
 
     /**
@@ -417,24 +471,7 @@ public function getMethodDescriptors(): array
         $directForeignKeyDescriptors = $this->getDirectForeignKeysDescriptors();
         $pivotTableDescriptors = $this->getPivotTableDescriptors();
 
-        $descriptors = array_merge($directForeignKeyDescriptors, $pivotTableDescriptors);
-
-        // Descriptors by method names
-        $descriptorsByMethodName = [];
-
-        foreach ($descriptors as $descriptor) {
-            $descriptorsByMethodName[$descriptor->getName()][] = $descriptor;
-        }
-
-        foreach ($descriptorsByMethodName as $descriptorsForMethodName) {
-            if (count($descriptorsForMethodName) > 1) {
-                foreach ($descriptorsForMethodName as $descriptor) {
-                    $descriptor->useAlternativeName();
-                }
-            }
-        }
-
-        return $descriptors;
+        return array_merge($directForeignKeyDescriptors, $pivotTableDescriptors);
     }
 
     public function generateJsonSerialize(): MethodGenerator

tests/TDBMDaoGeneratorTest.php

@@ -2008,7 +2008,7 @@ public function testFloydHasOneChild(): void
     {
         $artists = new ArtistDao($this->tdbmService);
         $pinkFloyd = $artists->getById(1);
-        $children = $pinkFloyd->getChildren();
+        $children = $pinkFloyd->getChildrenByArtistsRelations();
 
         $this->assertEquals(1, count($children));
         $this->assertEquals(2, $children[0]->getId());