rename $authTables to $tables and delete auth_ from array keys

datamweb · kenjis · commit 6ed08e7a838f · 2023-02-11T10:07:52.000+09:00
diff --git a/docs/customization.md b/docs/customization.md
@@ -154,7 +154,7 @@ Shield has the following rules for registration:
     ],
     'email' => [
         'label' =>  'Auth.email',
-        'rules' => 'required|max_length[254]|valid_email|is_unique[' . SHIELD_TABLES['auth_identities'] . '.secret]',
+        'rules' => 'required|max_length[254]|valid_email|is_unique[' . SHIELD_TABLES['identities'] . '.secret]',
     ],
     'password' => [
         'label' =>  'Auth.password',
@@ -180,7 +180,7 @@ If you need a different set of rules for registration, you can specify them in y
         ],
         'email' => [
             'label' =>  'Auth.email',
-            'rules' => 'required|max_length[254]|valid_email|is_unique[' . SHIELD_TABLES['auth_identities'] . '.secret]',
+            'rules' => 'required|max_length[254]|valid_email|is_unique[' . SHIELD_TABLES['identities'] . '.secret]',
         ],
         'password' => [
             'label' =>  'Auth.password',
diff --git a/src/Config/Auth.php b/src/Config/Auth.php
@@ -57,7 +57,7 @@ class Auth extends BaseConfig
      *
      * @var array<string, string>
      */
-    public array $authTables = [
+    public array $tables = [
         'users'                  => 'users',
         'auth_identities'        => 'auth_identities',
         'auth_logins'            => 'auth_logins',
diff --git a/src/Config/Constants.php b/src/Config/Constants.php
@@ -5,4 +5,4 @@
 /**
  * Constants Name of Shield Tables
  */
-define('SHIELD_TABLES', config('Auth')->authTables);
+define('SHIELD_TABLES', config('Auth')->tables);
diff --git a/src/Controllers/RegisterController.php b/src/Controllers/RegisterController.php
@@ -157,7 +157,7 @@ protected function getValidationRules(): array
         );
         $registrationEmailRules = array_merge(
             config('AuthSession')->emailValidationRules,
-            [sprintf('is_unique[%s.secret]', SHIELD_TABLES['auth_identities'])]
+            [sprintf('is_unique[%s.secret]', SHIELD_TABLES['identities'])]
         );
 
         return setting('Validation.registration') ?? [
diff --git a/src/Database/Migrations/2020-12-28-223112_create_auth_tables.php b/src/Database/Migrations/2020-12-28-223112_create_auth_tables.php
@@ -48,7 +48,7 @@ public function up(): void
         $this->forge->addUniqueKey(['type', 'secret']);
         $this->forge->addKey('user_id');
         $this->forge->addForeignKey('user_id', SHIELD_TABLES['users'], 'id', '', 'CASCADE');
-        $this->forge->createTable(SHIELD_TABLES['auth_identities']);
+        $this->forge->createTable(SHIELD_TABLES['identities']);
 
         /**
          * Auth Login Attempts Table
@@ -69,7 +69,7 @@ public function up(): void
         $this->forge->addKey(['id_type', 'identifier']);
         $this->forge->addKey('user_id');
         // NOTE: Do NOT delete the user_id or identifier when the user is deleted for security audits
-        $this->forge->createTable(SHIELD_TABLES['auth_logins']);
+        $this->forge->createTable(SHIELD_TABLES['logins']);
 
         /*
          * Auth Token Login Attempts Table
@@ -89,7 +89,7 @@ public function up(): void
         $this->forge->addKey(['id_type', 'identifier']);
         $this->forge->addKey('user_id');
         // NOTE: Do NOT delete the user_id or identifier when the user is deleted for security audits
-        $this->forge->createTable(SHIELD_TABLES['auth_token_logins']);
+        $this->forge->createTable(SHIELD_TABLES['token_logins']);
 
         /*
          * Auth Remember Tokens (remember-me) Table
@@ -107,7 +107,7 @@ public function up(): void
         $this->forge->addPrimaryKey('id');
         $this->forge->addUniqueKey('selector');
         $this->forge->addForeignKey('user_id', SHIELD_TABLES['users'], 'id', '', 'CASCADE');
-        $this->forge->createTable(SHIELD_TABLES['auth_remember_tokens']);
+        $this->forge->createTable(SHIELD_TABLES['remember_tokens']);
 
         // Groups Users Table
         $this->forge->addField([
@@ -118,7 +118,7 @@ public function up(): void
         ]);
         $this->forge->addPrimaryKey('id');
         $this->forge->addForeignKey('user_id', SHIELD_TABLES['users'], 'id', '', 'CASCADE');
-        $this->forge->createTable(SHIELD_TABLES['auth_groups_users']);
+        $this->forge->createTable(SHIELD_TABLES['groups_users']);
 
         // Users Permissions Table
         $this->forge->addField([
@@ -129,7 +129,7 @@ public function up(): void
         ]);
         $this->forge->addPrimaryKey('id');
         $this->forge->addForeignKey('user_id', SHIELD_TABLES['users'], 'id', '', 'CASCADE');
-        $this->forge->createTable(SHIELD_TABLES['auth_permissions_users']);
+        $this->forge->createTable(SHIELD_TABLES['permissions_users']);
     }
 
     // --------------------------------------------------------------------
@@ -138,12 +138,12 @@ public function down(): void
     {
         $this->db->disableForeignKeyChecks();
 
-        $this->forge->dropTable(SHIELD_TABLES['auth_logins'], true);
-        $this->forge->dropTable(SHIELD_TABLES['auth_token_logins'], true);
-        $this->forge->dropTable(SHIELD_TABLES['auth_remember_tokens'], true);
-        $this->forge->dropTable(SHIELD_TABLES['auth_identities'], true);
-        $this->forge->dropTable(SHIELD_TABLES['auth_groups_users'], true);
-        $this->forge->dropTable(SHIELD_TABLES['auth_permissions_users'], true);
+        $this->forge->dropTable(SHIELD_TABLES['logins'], true);
+        $this->forge->dropTable(SHIELD_TABLES['token_logins'], true);
+        $this->forge->dropTable(SHIELD_TABLES['remember_tokens'], true);
+        $this->forge->dropTable(SHIELD_TABLES['identities'], true);
+        $this->forge->dropTable(SHIELD_TABLES['groups_users'], true);
+        $this->forge->dropTable(SHIELD_TABLES['permissions_users'], true);
         $this->forge->dropTable(SHIELD_TABLES['users'], true);
 
         $this->db->enableForeignKeyChecks();
diff --git a/src/Models/GroupModel.php b/src/Models/GroupModel.php
@@ -11,7 +11,7 @@ class GroupModel extends Model
 {
     use CheckQueryReturnTrait;
 
-    protected $table          = SHIELD_TABLES['auth_groups_users'];
+    protected $table          = SHIELD_TABLES['groups_users'];
     protected $primaryKey     = 'id';
     protected $returnType     = 'array';
     protected $useSoftDeletes = false;
diff --git a/src/Models/LoginModel.php b/src/Models/LoginModel.php
@@ -15,7 +15,7 @@ class LoginModel extends Model
 {
     use CheckQueryReturnTrait;
 
-    protected $table          = SHIELD_TABLES['auth_logins'];
+    protected $table          = SHIELD_TABLES['logins'];
     protected $primaryKey     = 'id';
     protected $returnType     = Login::class;
     protected $useSoftDeletes = false;
diff --git a/src/Models/PermissionModel.php b/src/Models/PermissionModel.php
@@ -11,7 +11,7 @@ class PermissionModel extends Model
 {
     use CheckQueryReturnTrait;
 
-    protected $table          = SHIELD_TABLES['auth_permissions_users'];
+    protected $table          = SHIELD_TABLES['permissions_users'];
     protected $primaryKey     = 'id';
     protected $returnType     = 'array';
     protected $useSoftDeletes = false;
diff --git a/src/Models/RememberModel.php b/src/Models/RememberModel.php
@@ -15,7 +15,7 @@ class RememberModel extends Model
 {
     use CheckQueryReturnTrait;
 
-    protected $table          = SHIELD_TABLES['auth_remember_tokens'];
+    protected $table          = SHIELD_TABLES['remember_tokens'];
     protected $primaryKey     = 'id';
     protected $returnType     = 'object';
     protected $useSoftDeletes = false;
diff --git a/src/Models/TokenLoginModel.php b/src/Models/TokenLoginModel.php
@@ -10,7 +10,7 @@
 
 class TokenLoginModel extends LoginModel
 {
-    protected $table = SHIELD_TABLES['auth_token_logins'];
+    protected $table = SHIELD_TABLES['token_logins'];
 
     /**
      * Generate a fake login for testing
diff --git a/src/Models/UserIdentityModel.php b/src/Models/UserIdentityModel.php
@@ -20,7 +20,7 @@ class UserIdentityModel extends Model
 {
     use CheckQueryReturnTrait;
 
-    protected $table          = SHIELD_TABLES['auth_identities'];
+    protected $table          = SHIELD_TABLES['identities'];
     protected $primaryKey     = 'id';
     protected $returnType     = UserIdentity::class;
     protected $useSoftDeletes = false;
diff --git a/src/Models/UserModel.php b/src/Models/UserModel.php
@@ -191,12 +191,12 @@ public function findByCredentials(array $credentials): ?User
 
         if ($email !== null) {
             $data = $this->select(
-                sprintf('%1$s.*, %2$s.secret as email, %2$s.secret2 as password_hash', SHIELD_TABLES['users'], SHIELD_TABLES['auth_identities'])
+                sprintf('%1$s.*, %2$s.secret as email, %2$s.secret2 as password_hash', SHIELD_TABLES['users'], SHIELD_TABLES['identities'])
             )
-                ->join(SHIELD_TABLES['auth_identities'], sprintf('%1$s.user_id = %2$s.id', SHIELD_TABLES['auth_identities'], SHIELD_TABLES['users']))
-                ->where(SHIELD_TABLES['auth_identities'] . '.type', Session::ID_TYPE_EMAIL_PASSWORD)
+                ->join(SHIELD_TABLES['identities'], sprintf('%1$s.user_id = %2$s.id', SHIELD_TABLES['identities'], SHIELD_TABLES['users']))
+                ->where(SHIELD_TABLES['identities'] . '.type', Session::ID_TYPE_EMAIL_PASSWORD)
                 ->where(
-                    'LOWER(' . $this->db->protectIdentifiers(SHIELD_TABLES['auth_identities'] . '.secret') . ')',
+                    'LOWER(' . $this->db->protectIdentifiers(SHIELD_TABLES['identities'] . '.secret') . ')',
                     strtolower($email)
                 )
                 ->asArray()
diff --git a/tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php b/tests/Authentication/Authenticators/AccessTokenAuthenticatorTest.php
@@ -143,7 +143,7 @@ public function testCheckSuccess(): void
         $user  = fake(UserModel::class);
         $token = $user->generateAccessToken('foo');
 
-        $this->seeInDatabase(SHIELD_TABLES['auth_identities'], [
+        $this->seeInDatabase(SHIELD_TABLES['identities'], [
             'user_id'      => $user->id,
             'type'         => 'access_token',
             'last_used_at' => null,
@@ -201,7 +201,7 @@ public function testAttemptSuccess(): void
         $this->assertSame($token->token, $foundUser->currentAccessToken()->token);
 
         // A login attempt should have been recorded
-        $this->seeInDatabase(SHIELD_TABLES['auth_token_logins'], [
+        $this->seeInDatabase(SHIELD_TABLES['token_logins'], [
             'id_type'    => AccessTokens::ID_TYPE_ACCESS_TOKEN,
             'identifier' => $token->raw_token,
             'success'    => 1,
diff --git a/tests/Authentication/Authenticators/SessionAuthenticatorTest.php b/tests/Authentication/Authenticators/SessionAuthenticatorTest.php
@@ -47,7 +47,7 @@ protected function setUp(): void
         $this->events = new MockEvents();
         Services::injectMock('events', $this->events);
 
-        $this->db->table(SHIELD_TABLES['auth_identities'])->truncate();
+        $this->db->table(SHIELD_TABLES['identities'])->truncate();
     }
 
     public function testLoggedInFalse(): void
@@ -148,7 +148,7 @@ public function testLoginNoRemember(): void
 
         $this->assertSame($this->user->id, $_SESSION['user']['id']);
 
-        $this->dontSeeInDatabase(SHIELD_TABLES['auth_remember_tokens'], [
+        $this->dontSeeInDatabase(SHIELD_TABLES['remember_tokens'], [
             'user_id' => $this->user->id,
         ]);
     }
@@ -161,7 +161,7 @@ public function testLoginWithRemember(): void
 
         $this->assertSame($this->user->id, $_SESSION['user']['id']);
 
-        $this->seeInDatabase(SHIELD_TABLES['auth_remember_tokens'], [
+        $this->seeInDatabase(SHIELD_TABLES['remember_tokens'], [
             'user_id' => $this->user->id,
         ]);
 
@@ -175,12 +175,12 @@ public function testLogout(): void
         $this->user->createEmailIdentity(['email' => 'foo@example.com', 'password' => 'secret']);
         $this->auth->remember()->login($this->user);
 
-        $this->seeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->seeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
 
         $this->auth->logout();
 
         $this->assertArrayNotHasKey('user', $_SESSION);
-        $this->dontSeeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->dontSeeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
     }
 
     public function testLogoutOnlyLogoutCalled(): void
@@ -208,7 +208,7 @@ public function testLoginById(): void
 
         $this->assertSame($this->user->id, $_SESSION['user']['id']);
 
-        $this->dontSeeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->dontSeeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
     }
 
     public function testLoginByIdRemember(): void
@@ -219,7 +219,7 @@ public function testLoginByIdRemember(): void
 
         $this->assertSame($this->user->id, $_SESSION['user']['id']);
 
-        $this->seeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->seeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
     }
 
     public function testForgetCurrentUser(): void
@@ -228,22 +228,22 @@ public function testForgetCurrentUser(): void
         $this->auth->remember()->loginById($this->user->id);
         $this->assertSame($this->user->id, $_SESSION['user']['id']);
 
-        $this->seeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->seeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
 
         $this->auth->forget();
 
-        $this->dontSeeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->dontSeeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
     }
 
     public function testForgetAnotherUser(): void
     {
         fake(RememberModel::class, ['user_id' => $this->user->id]);
 
-        $this->seeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->seeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
 
         $this->auth->forget($this->user);
 
-        $this->dontSeeInDatabase(SHIELD_TABLES['auth_remember_tokens'], ['user_id' => $this->user->id]);
+        $this->dontSeeInDatabase(SHIELD_TABLES['remember_tokens'], ['user_id' => $this->user->id]);
     }
 
     public function testCheckNoPassword(): void
@@ -317,7 +317,7 @@ public function testAttemptCannotFindUser(): void
         $this->assertSame(lang('Auth.badAttempt'), $result->reason());
 
         // A login attempt should have always been recorded
-        $this->seeInDatabase(SHIELD_TABLES['auth_logins'], [
+        $this->seeInDatabase(SHIELD_TABLES['logins'], [
             'identifier' => 'johnsmith@example.com',
             'success'    => 0,
         ]);
@@ -347,7 +347,7 @@ public function testAttemptSuccess(): void
         $this->assertSame($this->user->id, $_SESSION['user']['id']);
 
         // A login attempt should have been recorded
-        $this->seeInDatabase(SHIELD_TABLES['auth_logins'], [
+        $this->seeInDatabase(SHIELD_TABLES['logins'], [
             'identifier' => $this->user->email,
             'success'    => 1,
         ]);
@@ -397,7 +397,7 @@ public function testAttemptCaseInsensitive(): void
         $this->assertSame($this->user->id, $_SESSION['user']['id']);
 
         // A login attempt should have been recorded
-        $this->seeInDatabase(SHIELD_TABLES['auth_logins'], [
+        $this->seeInDatabase(SHIELD_TABLES['logins'], [
             'identifier' => 'foo@example.COM',
             'success'    => 1,
         ]);
@@ -435,7 +435,7 @@ public function testAttemptUsernameOnly(): void
         $this->assertSame($user->id, $_SESSION['user']['id']);
 
         // A login attempt should have been recorded
-        $this->seeInDatabase(SHIELD_TABLES['auth_logins'], [
+        $this->seeInDatabase(SHIELD_TABLES['logins'], [
             'identifier' => 'fooROG',
             'success'    => 1,
         ]);
diff --git a/tests/Authentication/HasAccessTokensTest.php b/tests/Authentication/HasAccessTokensTest.php
@@ -22,7 +22,7 @@ protected function setUp(): void
         parent::setUp();
 
         $this->user = fake(UserModel::class);
-        $this->db->table(SHIELD_TABLES['auth_identities'])->truncate();
+        $this->db->table(SHIELD_TABLES['identities'])->truncate();
     }
 
     public function testGenerateToken(): void
diff --git a/tests/Authentication/MagicLinkTest.php b/tests/Authentication/MagicLinkTest.php
@@ -81,7 +81,7 @@ public function testMagicLinkSubmitSuccess(): void
         $result->assertOK();
         $result->assertSee(lang('Auth.checkYourEmail'));
 
-        $this->seeInDatabase(SHIELD_TABLES['auth_identities'], [
+        $this->seeInDatabase(SHIELD_TABLES['identities'], [
             'user_id' => $user->id,
             'type'    => Session::ID_TYPE_MAGIC_LINK,
         ]);
diff --git a/tests/Authorization/AuthorizableTest.php b/tests/Authorization/AuthorizableTest.php
diff --git a/tests/Controllers/ActionsTest.php b/tests/Controllers/ActionsTest.php
diff --git a/tests/Controllers/LoginTest.php b/tests/Controllers/LoginTest.php
diff --git a/tests/Controllers/RegisterTest.php b/tests/Controllers/RegisterTest.php
diff --git a/tests/Unit/UserModelTest.php b/tests/Unit/UserModelTest.php
diff --git a/tests/Unit/UserTest.php b/tests/Unit/UserTest.php

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ class Auth extends BaseConfig`
`57`	`57`	`*`
`58`	`58`	`* @var array<string, string>`
`59`	`59`	`*/`
`60`		`- public array $authTables = [`
	`60`	`+ public array $tables = [`
`61`	`61`	`'users' => 'users',`
`62`	`62`	`'auth_identities' => 'auth_identities',`
`63`	`63`	`'auth_logins' => 'auth_logins',`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class GroupModel extends Model`
`11`	`11`	`{`
`12`	`12`	`use CheckQueryReturnTrait;`
`13`	`13`
`14`		`- protected $table = SHIELD_TABLES['auth_groups_users'];`
	`14`	`+ protected $table = SHIELD_TABLES['groups_users'];`
`15`	`15`	`protected $primaryKey = 'id';`
`16`	`16`	`protected $returnType = 'array';`
`17`	`17`	`protected $useSoftDeletes = false;`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class LoginModel extends Model`
`15`	`15`	`{`
`16`	`16`	`use CheckQueryReturnTrait;`
`17`	`17`
`18`		`- protected $table = SHIELD_TABLES['auth_logins'];`
	`18`	`+ protected $table = SHIELD_TABLES['logins'];`
`19`	`19`	`protected $primaryKey = 'id';`
`20`	`20`	`protected $returnType = Login::class;`
`21`	`21`	`protected $useSoftDeletes = false;`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class PermissionModel extends Model`
`11`	`11`	`{`
`12`	`12`	`use CheckQueryReturnTrait;`
`13`	`13`
`14`		`- protected $table = SHIELD_TABLES['auth_permissions_users'];`
	`14`	`+ protected $table = SHIELD_TABLES['permissions_users'];`
`15`	`15`	`protected $primaryKey = 'id';`
`16`	`16`	`protected $returnType = 'array';`
`17`	`17`	`protected $useSoftDeletes = false;`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class RememberModel extends Model`
`15`	`15`	`{`
`16`	`16`	`use CheckQueryReturnTrait;`
`17`	`17`
`18`		`- protected $table = SHIELD_TABLES['auth_remember_tokens'];`
	`18`	`+ protected $table = SHIELD_TABLES['remember_tokens'];`
`19`	`19`	`protected $primaryKey = 'id';`
`20`	`20`	`protected $returnType = 'object';`
`21`	`21`	`protected $useSoftDeletes = false;`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`
`11`	`11`	`class TokenLoginModel extends LoginModel`
`12`	`12`	`{`
`13`		`- protected $table = SHIELD_TABLES['auth_token_logins'];`
	`13`	`+ protected $table = SHIELD_TABLES['token_logins'];`
`14`	`14`
`15`	`15`	`/**`
`16`	`16`	`* Generate a fake login for testing`