Merge pull request #145 from moufmouf/4.3

Adding exceptions in naming strategy
thecodingmachine · May 3, 2017 · 1c6faa3 · 1c6faa3
2 parents 66bb881 + 90a2a5a
commit 1c6faa3
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 5 deletions.
diff --git a/doc/configuring_naming.md b/doc/configuring_naming.md
@@ -44,6 +44,16 @@ $strategy->setBaseDaoPrefix('');
 $strategy->setBaseDaoSuffix('BaseDao');
 ```
 
+Furthermore, you can configure a set of exceptions. This can be useful if your table names are not in English or not in plural form.
+Let's assume you have a table named `chevaux` ('horses' in French). The singular form is 'cheval', so you would want a 'Cheval' bean and a 'ChevalDao'. That easy with the `setExceptions` method:
+
+```php
+$strategy->setExceptions([
+    'chevaux' => 'Cheval'
+]);
+```
+
+
 Implementing your own naming strategy
 -------------------------------------
 

diff --git a/src/Mouf/Database/TDBM/Utils/DefaultNamingStrategy.php b/src/Mouf/Database/TDBM/Utils/DefaultNamingStrategy.php
@@ -15,6 +15,7 @@ class DefaultNamingStrategy implements NamingStrategyInterface
     private $daoSuffix = 'Dao';
     private $baseDaoPrefix = 'Abstract';
     private $baseDaoSuffix = 'Dao';
+    private $exceptions = [];
 
     /**
      * Sets the string prefix to any bean class name.
@@ -105,7 +106,7 @@ public function setBaseDaoSuffix(string $baseDaoSuffix)
      */
     public function getBeanClassName(string $tableName): string
     {
-        return $this->beanPrefix.self::toSingularCamelCase($tableName).$this->beanSuffix;
+        return $this->beanPrefix.$this->toSingularCamelCase($tableName).$this->beanSuffix;
     }
 
     /**
@@ -116,7 +117,7 @@ public function getBeanClassName(string $tableName): string
      */
     public function getBaseBeanClassName(string $tableName): string
     {
-        return $this->baseBeanPrefix.self::toSingularCamelCase($tableName).$this->baseBeanSuffix;
+        return $this->baseBeanPrefix.$this->toSingularCamelCase($tableName).$this->baseBeanSuffix;
     }
 
     /**
@@ -127,7 +128,7 @@ public function getBaseBeanClassName(string $tableName): string
      */
     public function getDaoClassName(string $tableName): string
     {
-        return $this->daoPrefix.self::toSingularCamelCase($tableName).$this->daoSuffix;
+        return $this->daoPrefix.$this->toSingularCamelCase($tableName).$this->daoSuffix;
     }
 
     /**
@@ -138,7 +139,7 @@ public function getDaoClassName(string $tableName): string
      */
     public function getBaseDaoClassName(string $tableName): string
     {
-        return $this->baseDaoPrefix.self::toSingularCamelCase($tableName).$this->baseDaoSuffix;
+        return $this->baseDaoPrefix.$this->toSingularCamelCase($tableName).$this->baseDaoSuffix;
     }
 
     /**
@@ -149,8 +150,13 @@ public function getBaseDaoClassName(string $tableName): string
      *
      * @return string
      */
-    private static function toSingularCamelCase(string $str): string
+    private function toSingularCamelCase(string $str): string
     {
+        // Let's first check if this is not in the exceptions directory.
+        if (isset($this->exceptions[$str])) {
+            return $this->exceptions[$str];
+        }
+
         $tokens = preg_split("/[_ ]+/", $str);
         $tokens = array_map([Inflector::class, 'singularize'], $tokens);
 
@@ -171,4 +177,23 @@ public function getDaoFactoryClassName(): string
     {
         return 'DaoFactory';
     }
+
+    /**
+     * Sets exceptions in the naming of classes.
+     * The key is the name of the table, the value the "base" name of beans and DAOs.
+     *
+     * This is very useful for dealing with plural to singular translations in non english table names.
+     *
+     * For instance if you are dealing with a table containing horses in French ("chevaux" that has a singular "cheval"):
+     *
+     * [
+     *     "chevaux" => "Cheval"
+     * ]
+     *
+     * @param array<string,string> $exceptions
+     */
+    public function setExceptions(array $exceptions)
+    {
+        $this->exceptions = $exceptions;
+    }
 }
diff --git a/tests/Mouf/Database/TDBM/Utils/DefaultNamingStrategyTest.php b/tests/Mouf/Database/TDBM/Utils/DefaultNamingStrategyTest.php
@@ -70,4 +70,13 @@ public function testGetDaoFactory()
         $strategy = new DefaultNamingStrategy();
         $this->assertSame('DaoFactory', $strategy->getDaoFactoryClassName());
     }
+
+    public function testExceptions()
+    {
+        $strategy = new DefaultNamingStrategy();
+        $strategy->setExceptions([
+            'chevaux' => 'Cheval'
+        ]);
+        $this->assertSame('ChevalDao', $strategy->getDaoClassName('chevaux'));
+    }
 }