refactor: move validation rules to Config\AuthSession

Author: kenjis

src/Config/AuthSession.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace CodeIgniter\Shield\Config;
+
+use CodeIgniter\Config\BaseConfig;
+
+/**
+ * Config for Session Authenticator
+ */
+class AuthSession extends BaseConfig
+{
+    /**
+     * The validation rules for username
+     *
+     * @var string[]
+     */
+    public array $usernameValidationRules = [
+        'required',
+        'max_length[30]',
+        'min_length[3]',
+        'regex_match[/\A[a-zA-Z0-9\.]+\z/]',
+    ];
+
+    /**
+     * The validation rules for email
+     *
+     * @var string[]
+     */
+    public array $emailValidationRules = [
+        'required',
+        'max_length[254]',
+        'valid_email',
+    ];
+}

src/Controllers/LoginController.php

@@ -64,41 +64,12 @@ public function loginAction(): RedirectResponse
     protected function getValidationRules(): array
     {
         return setting('Validation.login') ?? [
-            //'username' => static::getUsernameRules(),
-            'email'    => static::getEmailRules(),
+            //'username' => config('AuthSession')->usernameValidationRules,
+            'email'    => config('AuthSession')->emailValidationRules,
             'password' => 'required',
         ];
     }
 
-    /**
-     * Returns the validation rules for username
-     *
-     * @return string[]
-     */
-    public static function getUsernameRules(): array
-    {
-        return [
-            'required',
-            'max_length[30]',
-            'min_length[3]',
-            'regex_match[/\A[a-zA-Z0-9\.]+\z/]',
-        ];
-    }
-
-    /**
-     * Returns the validation rules for email
-     *
-     * @return string[]
-     */
-    public static function getEmailRules(): array
-    {
-        return [
-            'required',
-            'max_length[254]',
-            'valid_email',
-        ];
-    }
-
     /**
      * Logs the current user out.
      */

src/Controllers/MagicLinkController.php

@@ -191,7 +191,7 @@ private function recordLoginAttempt(
     protected function getValidationRules(): array
     {
         return [
-            'email' => LoginController::getEmailRules(),
+            'email' => config('AuthSession')->emailValidationRules,
         ];
     }
 }

src/Controllers/RegisterController.php

@@ -131,11 +131,11 @@ protected function getUserEntity(): User
     protected function getValidationRules(): array
     {
         $registrationUsernameRules = array_merge(
-            LoginController::getUsernameRules(),
+            config('AuthSession')->usernameValidationRules,
             ['is_unique[users.username]']
         );
         $registrationEmailRules = array_merge(
-            LoginController::getEmailRules(),
+            config('AuthSession')->emailValidationRules,
             ['is_unique[auth_identities.secret]']
         );
 

tests/Controllers/LoginTest.php

@@ -5,7 +5,6 @@
 use CodeIgniter\Config\Factories;
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Shield\Authentication\Actions\Email2FA;
-use CodeIgniter\Shield\Controllers\LoginController;
 use CodeIgniter\Test\DatabaseTestTrait;
 use CodeIgniter\Test\FeatureTestTrait;
 use Config\Services;
@@ -124,7 +123,7 @@ public function testLoginActionUsernameSuccess(): void
                 'password' => 'required',
             ];
         };
-        $config->login['username'] = LoginController::getUsernameRules();
+        $config->login['username'] = config('AuthSession')->usernameValidationRules;
         Factories::injectMock('config', 'Validation', $config);
 
         $this->user->createEmailIdentity([