feat: replace UserPersistence and RolePersistence with UserRepository and RoleRepository for improved abstraction

Author: aspirantzhang

contexts/Authorization/Application/Coordinators/CurrentUserServiceCoordinator.php

@@ -7,25 +7,25 @@
 use App\Http\Coordinators\BaseCoordinator;
 use Contexts\Authorization\Contracts\V1\DTOs\CurrentUserDTO;
 use Contexts\Authorization\Contracts\V1\Services\CurrentUserService;
+use Contexts\Authorization\Domain\Repositories\RoleRepository;
+use Contexts\Authorization\Domain\Repositories\UserRepository;
 use Contexts\Authorization\Domain\UserIdentity\Models\UserId;
-use Contexts\Authorization\Infrastructure\Persistence\RolePersistence;
-use Contexts\Authorization\Infrastructure\Persistence\UserPersistence;
 
 class CurrentUserServiceCoordinator extends BaseCoordinator implements CurrentUserService
 {
     public function __construct(
-        private UserPersistence $userPersistence,
-        private RolePersistence $rolePersistence,
+        private UserRepository $userRepository,
+        private RoleRepository $roleRepository,
     ) {}
 
     public function getCurrentUser(): CurrentUserDTO
     {
-        $user = $this->userPersistence->getById(
+        $user = $this->userRepository->getById(
             UserId::fromInt(auth()->id())
         );
 
         $userRoles = $user->getRoleIdCollection();
-        $roles = $this->rolePersistence->getByIds($userRoles->getIdsArray());
+        $roles = $this->roleRepository->getByIds($userRoles->getIdsArray());
 
         return new CurrentUserDTO(
             $user->getId()->getValue(),

contexts/Authorization/Application/Coordinators/RoleCoordinator.php

@@ -9,16 +9,16 @@
 use Contexts\Authorization\Application\DTOs\Role\CreateRoleDTO;
 use Contexts\Authorization\Application\DTOs\Role\GetRoleListDTO;
 use Contexts\Authorization\Application\DTOs\Role\UpdateRoleDTO;
+use Contexts\Authorization\Domain\Repositories\RoleRepository;
 use Contexts\Authorization\Domain\Role\Models\Role;
 use Contexts\Authorization\Domain\Role\Models\RoleId;
 use Contexts\Authorization\Domain\Role\Models\RoleStatus;
-use Contexts\Authorization\Infrastructure\Persistence\RolePersistence;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 
 class RoleCoordinator extends BaseCoordinator
 {
     public function __construct(
-        private RolePersistence $repository
+        private RoleRepository $repository
     ) {}
 
     public function create(CreateRoleDTO $data): Role

contexts/Authorization/Application/Coordinators/UserIdentityCoordinator.php

@@ -9,20 +9,20 @@
 use Contexts\Authorization\Application\DTOs\User\CreateUserDTO;
 use Contexts\Authorization\Application\DTOs\User\GetUserListDTO;
 use Contexts\Authorization\Application\DTOs\User\UpdateUserDTO;
+use Contexts\Authorization\Domain\Repositories\UserRepository;
 use Contexts\Authorization\Domain\Role\Models\RoleId;
 use Contexts\Authorization\Domain\UserIdentity\Models\Email;
 use Contexts\Authorization\Domain\UserIdentity\Models\Password;
 use Contexts\Authorization\Domain\UserIdentity\Models\RoleIdCollection;
 use Contexts\Authorization\Domain\UserIdentity\Models\UserId;
 use Contexts\Authorization\Domain\UserIdentity\Models\UserIdentity;
 use Contexts\Authorization\Domain\UserIdentity\Models\UserStatus;
-use Contexts\Authorization\Infrastructure\Persistence\UserPersistence;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 
 class UserIdentityCoordinator extends BaseCoordinator
 {
     public function __construct(
-        private UserPersistence $repository
+        private UserRepository $repository
     ) {}
 
     public function create(CreateUserDTO $data): UserIdentity

contexts/Authorization/Domain/Repositories/RoleRepository.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Contexts\Authorization\Domain\Repositories;
+
+use Contexts\Authorization\Domain\Role\Models\Role;
+use Contexts\Authorization\Domain\Role\Models\RoleId;
+use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Collection;
+
+interface RoleRepository
+{
+    public function create(Role $role): Role;
+
+    public function getById(RoleId $roleId): Role;
+
+    public function getByIds(array $roleIds): Collection;
+
+    public function update(Role $role): Role;
+
+    public function paginate(int $page = 1, int $perPage = 10, array $criteria = []): LengthAwarePaginator;
+
+    public function delete(Role $role): void;
+
+    public function getByLabels(array $labels): Collection;
+}

contexts/Authorization/Domain/Repositories/UserRepository.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Contexts\Authorization\Domain\Repositories;
+
+use Contexts\Authorization\Domain\UserIdentity\Models\UserId;
+use Contexts\Authorization\Domain\UserIdentity\Models\UserIdentity;
+use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+
+interface UserRepository
+{
+    public function create(UserIdentity $user): UserIdentity;
+
+    public function getById(UserId $userId): UserIdentity;
+
+    public function update(UserIdentity $user): UserIdentity;
+
+    public function paginate(int $page = 1, int $perPage = 10, array $criteria = []): LengthAwarePaginator;
+
+    public function delete(UserIdentity $user): void;
+
+    public function changePassword(UserIdentity $user): void;
+}

contexts/Authorization/Infrastructure/Persistence/RolePersistence.php

@@ -4,6 +4,7 @@
 
 namespace Contexts\Authorization\Infrastructure\Persistence;
 
+use Contexts\Authorization\Domain\Repositories\RoleRepository;
 use Contexts\Authorization\Domain\Role\Exceptions\RoleNotFoundException;
 use Contexts\Authorization\Domain\Role\Models\Role;
 use Contexts\Authorization\Domain\Role\Models\RoleId;
@@ -13,7 +14,7 @@
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Support\Collection;
 
-class RolePersistence
+class RolePersistence implements RoleRepository
 {
     public function create(Role $role): Role
     {

contexts/Authorization/Infrastructure/Persistence/UserPersistence.php

@@ -4,6 +4,7 @@
 
 namespace Contexts\Authorization\Infrastructure\Persistence;
 
+use Contexts\Authorization\Domain\Repositories\UserRepository;
 use Contexts\Authorization\Domain\UserIdentity\Exceptions\UserNotFoundException;
 use Contexts\Authorization\Domain\UserIdentity\Models\RoleIdCollection;
 use Contexts\Authorization\Domain\UserIdentity\Models\UserId;
@@ -13,7 +14,7 @@
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 
-class UserPersistence
+class UserPersistence implements UserRepository
 {
     public function create(UserIdentity $user): UserIdentity
     {

contexts/Authorization/Infrastructure/ServiceProvider.php

@@ -8,6 +8,10 @@
 use Contexts\Authorization\Application\Coordinators\GlobalPermissionServiceCoordinator;
 use Contexts\Authorization\Contracts\V1\Services\CurrentUserService;
 use Contexts\Authorization\Contracts\V1\Services\GlobalPermissionService;
+use Contexts\Authorization\Domain\Repositories\RoleRepository;
+use Contexts\Authorization\Domain\Repositories\UserRepository;
+use Contexts\Authorization\Infrastructure\Persistence\RolePersistence;
+use Contexts\Authorization\Infrastructure\Persistence\UserPersistence;
 use Illuminate\Foundation\Support\Providers\RouteServiceProvider;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Route;
@@ -40,6 +44,8 @@ public function map(): void
             }
         });
 
+        $this->app->bind(RoleRepository::class, RolePersistence::class);
+        $this->app->bind(UserRepository::class, UserPersistence::class);
         $this->app->bind(CurrentUserService::class, CurrentUserServiceCoordinator::class);
         $this->app->bind(GlobalPermissionService::class, GlobalPermissionServiceCoordinator::class);
     }