Generate "isUnique" rules with rule name and error field.

cakephp · Jul 30, 2020 · 1b31240 · 1b31240
1 parent f6d3eb5
commit 1b31240
Show file tree

Hide file tree

Showing 10 changed files with 74 additions and 12 deletions.
diff --git a/src/Command/ModelCommand.php b/src/Command/ModelCommand.php
@@ -848,7 +848,10 @@ public function getRules(Table $model, array $associations, Arguments $args): ar
         $rules = [];
         foreach ($fields as $fieldName) {
             if (in_array($fieldName, $uniqueColumns, true)) {
-                $rules[$fieldName] = ['name' => 'isUnique'];
+                $rules[$fieldName] = [
+                    'name' => 'isUnique',
+                    'ruleName' => $this->ruleName($fieldName, 'unique'),
+                ];
             }
         }
         foreach ($schema->constraints() as $name) {
@@ -859,20 +862,39 @@ public function getRules(Table $model, array $associations, Arguments $args): ar
             if (count($constraint['columns']) > 1) {
                 continue;
             }
-            $rules[$constraint['columns'][0]] = ['name' => 'isUnique'];
+            $rules[$constraint['columns'][0]] = [
+                'name' => 'isUnique',
+                'ruleName' => $this->ruleName($constraint['columns'][0], 'unique'),
+            ];
         }
 
         if (empty($associations['belongsTo'])) {
             return $rules;
         }
 
         foreach ($associations['belongsTo'] as $assoc) {
-            $rules[$assoc['foreignKey']] = ['name' => 'existsIn', 'extra' => $assoc['alias']];
+            $rules[$assoc['foreignKey']] = [
+                'name' => 'existsIn',
+                'extra' => $assoc['alias'],
+                'ruleName' => $this->ruleName($assoc['foreignKey'], 'unique'),
+            ];
         }
 
         return $rules;
     }
 
+    /**
+     * Generate application rule name.
+     *
+     * @param string $field Field name.
+     * @param string $prefix Rule name prefix.
+     * @return string
+     */
+    protected function ruleName(string $field, string $prefix = ''): string
+    {
+        return $prefix . Inflector::classify($field);
+    }
+
     /**
      * Get behaviors
      *

diff --git a/templates/bake/Model/table.twig b/templates/bake/Model/table.twig
@@ -119,7 +119,11 @@ class {{ name }}Table extends Table
     public function buildRules(RulesChecker $rules): RulesChecker
     {
 {% for field, rule in rulesChecker %}
-        $rules->add($rules->{{ rule.name }}(['{{ field }}']{{ (rule.extra is defined and rule.extra ? (", '#{rule.extra}'") : '')|raw }}));
+        $rules->add(
+            $rules->{{ rule.name }}(['{{ field }}']{{ (rule.extra is defined and rule.extra ? (", '#{rule.extra}'") : '')|raw }}),
+            '{{ rule.ruleName }}',
+            ['errorField' => '{{ field }}']
+        );
 {% endfor %}
 
         return $rules;

diff --git a/tests/TestCase/Command/ModelCommandTest.php b/tests/TestCase/Command/ModelCommandTest.php
@@ -1166,14 +1166,17 @@ public function testGetRules()
         $expected = [
             'username' => [
                 'name' => 'isUnique',
+                'ruleName' => 'uniqueUsername',
             ],
             'country_id' => [
                 'name' => 'existsIn',
                 'extra' => 'Countries',
+                'ruleName' => 'uniqueCountryId',
             ],
             'site_id' => [
                 'name' => 'existsIn',
                 'extra' => 'Sites',
+                'ruleName' => 'uniqueSiteId',
             ],
         ];
         $this->assertEquals($expected, $result);
@@ -1205,6 +1208,7 @@ public function testGetRulesUniqueKeys()
         $expected = [
             'title' => [
                 'name' => 'isUnique',
+                'ruleName' => 'uniqueTitle',
             ],
         ];
         $this->assertEquals($expected, $result);

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionCategoriesProductsTable.php b/tests/comparisons/Model/testBakeAssociationDetectionCategoriesProductsTable.php
@@ -63,8 +63,16 @@ public function initialize(array $config): void
      */
     public function buildRules(RulesChecker $rules): RulesChecker
     {
-        $rules->add($rules->existsIn(['category_id'], 'Categories'));
-        $rules->add($rules->existsIn(['product_id'], 'Products'));
+        $rules->add(
+            $rules->existsIn(['category_id'], 'Categories'),
+            'uniqueCategoryId',
+            ['errorField' => 'category_id']
+        );
+        $rules->add(
+            $rules->existsIn(['product_id'], 'Products'),
+            'uniqueProductId',
+            ['errorField' => 'product_id']
+        );
 
         return $rules;
     }

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionProductVersionsTable.php b/tests/comparisons/Model/testBakeAssociationDetectionProductVersionsTable.php
@@ -78,7 +78,11 @@ public function validationDefault(Validator $validator): Validator
      */
     public function buildRules(RulesChecker $rules): RulesChecker
     {
-        $rules->add($rules->existsIn(['product_id'], 'Products'));
+        $rules->add(
+            $rules->existsIn(['product_id'], 'Products'),
+            'uniqueProductId',
+            ['errorField' => 'product_id']
+        );
 
         return $rules;
     }

diff --git a/tests/comparisons/Model/testBakeEntityWithPlugin.php b/tests/comparisons/Model/testBakeEntityWithPlugin.php
@@ -67,7 +67,11 @@ public function initialize(array $config): void
      */
     public function buildRules(RulesChecker $rules): RulesChecker
     {
-        $rules->add($rules->isUnique(['username']));
+        $rules->add(
+            $rules->isUnique(['username']),
+            'uniqueUsername',
+            ['errorField' => 'username']
+        );
 
         return $rules;
     }

diff --git a/tests/comparisons/Model/testBakeTableConfig.php b/tests/comparisons/Model/testBakeTableConfig.php
@@ -109,7 +109,11 @@ public function validationDefault(Validator $validator): Validator
      */
     public function buildRules(RulesChecker $rules): RulesChecker
     {
-        $rules->add($rules->existsIn(['user_id'], 'Users'));
+        $rules->add(
+            $rules->existsIn(['user_id'], 'Users'),
+            'uniqueUserId',
+            ['errorField' => 'user_id']
+        );
 
         return $rules;
     }

diff --git a/tests/comparisons/Model/testBakeTableWithCounterCache.php b/tests/comparisons/Model/testBakeTableWithCounterCache.php
@@ -66,7 +66,11 @@ public function initialize(array $config): void
      */
     public function buildRules(RulesChecker $rules): RulesChecker
     {
-        $rules->add($rules->existsIn(['todo_item_id'], 'TodoItems'));
+        $rules->add(
+            $rules->existsIn(['todo_item_id'], 'TodoItems'),
+            'uniqueTodoItemId',
+            ['errorField' => 'todo_item_id']
+        );
 
         return $rules;
     }

diff --git a/tests/comparisons/Model/testBakeTableWithPlugin.php b/tests/comparisons/Model/testBakeTableWithPlugin.php
@@ -67,7 +67,11 @@ public function initialize(array $config): void
      */
     public function buildRules(RulesChecker $rules): RulesChecker
     {
-        $rules->add($rules->isUnique(['username']));
+        $rules->add(
+            $rules->isUnique(['username']),
+            'uniqueUsername',
+            ['errorField' => 'username']
+        );
 
         return $rules;
     }

diff --git a/tests/comparisons/Model/testBakeWithRulesUnique.php b/tests/comparisons/Model/testBakeWithRulesUnique.php
@@ -90,7 +90,11 @@ public function validationDefault(Validator $validator): Validator
      */
     public function buildRules(RulesChecker $rules): RulesChecker
     {
-        $rules->add($rules->isUnique(['username']));
+        $rules->add(
+            $rules->isUnique(['username']),
+            'uniqueUsername',
+            ['errorField' => 'username']
+        );
 
         return $rules;
     }