refactor: get rid of Authenticatable/UserProvider, use User/UserModel

Author: kenjis

src/Auth.php

@@ -6,6 +6,7 @@
 use CodeIgniter\Shield\Authentication\Authentication;
 use CodeIgniter\Shield\Authentication\AuthenticationException;
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
+use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Interfaces\Authenticatable;
 use CodeIgniter\Shield\Interfaces\UserProvider;
 
@@ -20,6 +21,9 @@
  * @method void                 loginById($userId)
  * @method bool                 logout()
  * @method void                 recordActive()
+ *
+ * Authenticators\Session:
+ * @method $this remember(bool $shouldRemember = true)
  */
 class Auth
 {
@@ -64,7 +68,7 @@ public function getAuthenticator(): AuthenticatorInterface
     /**
      * Returns the current user, if logged in.
      */
-    public function user(): ?Authenticatable
+    public function user(): ?User
     {
         return $this->getAuthenticator()->loggedIn()
             ? $this->getAuthenticator()->getUser()

src/Authentication/AuthenticatorInterface.php

@@ -2,7 +2,7 @@
 
 namespace CodeIgniter\Shield\Authentication;
 
-use CodeIgniter\Shield\Interfaces\Authenticatable;
+use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Result;
 
 interface AuthenticatorInterface
@@ -32,7 +32,7 @@ public function loggedIn(): bool;
      *
      * @see https://codeigniter4.github.io/CodeIgniter4/extending/authentication.html
      */
-    public function login(Authenticatable $user): bool;
+    public function login(User $user): bool;
 
     /**
      * Logs a user in based on their ID.
@@ -55,7 +55,7 @@ public function logout(): bool;
     /**
      * Returns the currently logged in user.
      */
-    public function getUser(): ?Authenticatable;
+    public function getUser(): ?User;
 
     /**
      * Updates the user's last active date.

src/Authentication/Authenticators/AccessTokens.php

@@ -28,7 +28,7 @@ class AccessTokens implements AuthenticatorInterface
      *
      * @todo Fix interface issue described above
      */
-    protected ?Authenticatable $user = null;
+    protected ?User $user = null;
 
     protected LoginModel $loginModel;
 
@@ -150,7 +150,7 @@ public function loggedIn(): bool
     /**
      * Logs the given user in by saving them to the class.
      */
-    public function login(Authenticatable $user): bool
+    public function login(User $user): bool
     {
         $this->user = $user;
 
@@ -200,7 +200,7 @@ public function forget(?int $id): void
     /**
      * Returns the currently logged in user.
      */
-    public function getUser(): ?Authenticatable
+    public function getUser(): ?User
     {
         return $this->user;
     }

src/Authentication/Authenticators/Session.php

@@ -25,7 +25,7 @@ class Session implements AuthenticatorInterface
      */
     protected UserProvider $provider;
 
-    protected ?Authenticatable $user = null;
+    protected ?User $user = null;
     protected LoginModel $loginModel;
 
     /**
@@ -81,7 +81,7 @@ public function attempt(array $credentials): Result
             return $result;
         }
 
-        /** @var Authenticatable $user */
+        /** @var User $user */
         $user = $result->extraInfo();
 
         $this->login($user);
@@ -170,7 +170,7 @@ public function loggedIn(): bool
     /**
      * Logs the given user in.
      */
-    public function login(Authenticatable $user): bool
+    public function login(User $user): bool
     {
         // @todo Authenticatable should define getEmailIdentity() or this should require User
         $this->user = $user;
@@ -281,7 +281,7 @@ public function forget($userId = null): void
     /**
      * Returns the current user instance.
      */
-    public function getUser(): ?Authenticatable
+    public function getUser(): ?User
     {
         return $this->user;
     }

src/Authentication/Passwords.php

@@ -4,7 +4,7 @@
 
 use CodeIgniter\Shield\Authentication\Passwords\ValidatorInterface;
 use CodeIgniter\Shield\Config\Auth;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
+use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Result;
 
 /**
@@ -79,7 +79,7 @@ public function needsRehash(string $hashedPassword): bool
      *
      * @throws AuthenticationException
      */
-    public function check(string $password, ?Authenticatable $user = null): Result
+    public function check(string $password, ?User $user = null): Result
     {
         if (null === $user) {
             throw AuthenticationException::forNoEntityProvided();

src/Authentication/Passwords/NothingPersonalValidator.php

@@ -2,7 +2,7 @@
 
 namespace CodeIgniter\Shield\Authentication\Passwords;
 
-use CodeIgniter\Shield\Interfaces\Authenticatable;
+use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Result;
 
 /**
@@ -18,7 +18,7 @@ class NothingPersonalValidator extends BaseValidator implements ValidatorInterfa
      * If true is returned the password will be passed to next validator.
      * If false is returned the validation process will be immediately stopped.
      */
-    public function check(string $password, ?Authenticatable $user = null): Result
+    public function check(string $password, ?User $user = null): Result
     {
         $password = \strtolower($password);
 
@@ -52,7 +52,7 @@ public function check(string $password, ?Authenticatable $user = null): Result
      *
      * @return bool
      */
-    protected function isNotPersonal(string $password, ?Authenticatable $user)
+    protected function isNotPersonal(string $password, ?User $user)
     {
         $userName = \strtolower($user->username);
         $email    = \strtolower($user->email);
@@ -153,7 +153,7 @@ protected function isNotPersonal(string $password, ?Authenticatable $user)
      *
      * @return bool
      */
-    protected function isNotSimilar(string $password, ?Authenticatable $user)
+    protected function isNotSimilar(string $password, ?User $user)
     {
         $maxSimilarity = (float) $this->config->maxSimilarity;
         // sanity checking - working range 1-100, 0 is off

src/Authentication/Passwords/ValidatorInterface.php

@@ -2,7 +2,7 @@
 
 namespace CodeIgniter\Shield\Authentication\Passwords;
 
-use CodeIgniter\Shield\Interfaces\Authenticatable;
+use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Result;
 
 /**
@@ -19,7 +19,7 @@ interface ValidatorInterface
      * the password will be passed to any remaining validators.
      * False will immediately stop validation process
      */
-    public function check(string $password, ?Authenticatable $user = null): Result;
+    public function check(string $password, ?User $user = null): Result;
 
     /**
      * Returns the error string that should be displayed to the user.

src/Authentication/Traits/UserProvider.php

@@ -15,7 +15,7 @@ trait UserProvider
      *
      * @param int|string $id
      */
-    public function findById($id): ?Authenticatable
+    public function findById($id): ?User
     {
         return $this->find($id);
     }
@@ -25,7 +25,7 @@ public function findById($id): ?Authenticatable
      *
      * @param array<string, string> $credentials
      */
-    public function findByCredentials(array $credentials): ?Authenticatable
+    public function findByCredentials(array $credentials): ?User
     {
         // Email is stored in an identity so remove that here
         $email = $credentials['email'] ?? null;

src/Controllers/RegisterController.php

@@ -6,8 +6,7 @@
 use CodeIgniter\Events\Events;
 use CodeIgniter\HTTP\RedirectResponse;
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
-use CodeIgniter\Shield\Interfaces\UserProvider;
+use CodeIgniter\Shield\Models\UserModel;
 use CodeIgniter\Validation\Validation;
 
 /**
@@ -104,19 +103,19 @@ public function registerAction(): RedirectResponse
     /**
      * Returns the User provider
      */
-    protected function getUserProvider(): UserProvider
+    protected function getUserProvider(): UserModel
     {
         $provider = model(setting('Auth.userProvider'));
 
-        assert($provider instanceof UserProvider, 'Config Auth.userProvider is not a valid UserProvider.');
+        assert($provider instanceof UserModel, 'Config Auth.userProvider is not a valid UserProvider.');
 
         return $provider;
     }
 
     /**
      * Returns the Entity class that should be used
      */
-    protected function getUserEntity(): Authenticatable
+    protected function getUserEntity(): User
     {
         return new User();
     }

src/Entities/AccessToken.php

@@ -3,7 +3,6 @@
 namespace CodeIgniter\Shield\Entities;
 
 use CodeIgniter\Entity\Entity;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
 
 /**
  * Class AccessToken
@@ -32,7 +31,7 @@ class AccessToken extends Entity
     /**
      * Returns the user associated with this token.
      */
-    public function user(): ?Authenticatable
+    public function user(): ?User
     {
         if (empty($this->attributes['user'])) {
             helper('auth');