OXDEV-8947 Rework the UserService to UserRepository

As it actually is doing what repository should, and should be in the Infrastructure directory

Signed-off-by: Anton Fedurtsya <anton@fedurtsya.com>

Author: Sieg

src/Greeting/Controller/Admin/GreetingAdminController.php

@@ -12,15 +12,15 @@
 use OxidEsales\ExamplesModule\Core\Module as ModuleCore;
 use OxidEsales\Eshop\Application\Controller\Admin\AdminController;
 use OxidEsales\ExamplesModule\Extension\Model\User as ExamplesModelUser;
-use OxidEsales\ExamplesModule\Greeting\Service\UserServiceInterface;
+use OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\UserRepositoryInterface;
 use OxidEsales\ExamplesModule\Greeting\Transput\AdminGreetingRequestInterface;
 
 class GreetingAdminController extends AdminController
 {
     protected $_sThisTemplate = '@oe_examples_module/admin/user_greetings';
 
     public function __construct(
-        private readonly UserServiceInterface $userService,
+        private readonly UserRepositoryInterface $userRepository,
         private readonly AdminGreetingRequestInterface $request,
     ) {
         parent::__construct();
@@ -30,7 +30,7 @@ public function render()
     {
         if ($this->request->getEditObjectId()) {
             /** @var ExamplesModelUser $user */
-            $user = $this->userService->getUserById($this->request->getEditObjectId());
+            $user = $this->userRepository->getUserById($this->request->getEditObjectId());
             $this->addTplParam(ModuleCore::OEEM_ADMIN_GREETING_TEMPLATE_VARNAME, $user->getPersonalGreeting());
         }
 

src/Greeting/Service/UserService.php …astructure/Repository/UserRepository.phpsrc/Greeting/Service/UserService.php renamed to src/Greeting/Infrastructure/Repository/UserRepository.php src/Greeting/Service/UserService.php renamed to src/Greeting/Infrastructure/Repository/UserRepository.php

@@ -7,17 +7,12 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\ExamplesModule\Greeting\Service;
+namespace OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository;
 
 use OxidEsales\ExamplesModule\Greeting\Infrastructure\Factory\UserModelFactoryInterface;
 use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUserInterface;
 
-/**
- * @extendable-class
- *
- * @todo: getting the user should go through the user repository
- */
-readonly class UserService implements UserServiceInterface
+readonly class UserRepository implements UserRepositoryInterface
 {
     public function __construct(
         private UserModelFactoryInterface $userModelFactory,

…reeting/Service/UserServiceInterface.php …e/Repository/UserRepositoryInterface.phpsrc/Greeting/Service/UserServiceInterface.php renamed to src/Greeting/Infrastructure/Repository/UserRepositoryInterface.php src/Greeting/Service/UserServiceInterface.php renamed to src/Greeting/Infrastructure/Repository/UserRepositoryInterface.php

@@ -7,11 +7,11 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\ExamplesModule\Greeting\Service;
+namespace OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository;
 
 use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUserInterface;
 
-interface UserServiceInterface
+interface UserRepositoryInterface
 {
     public function getUserById(string $userId): PersonalGreetingUserInterface;
 }

src/Greeting/Infrastructure/services.yaml

@@ -6,5 +6,8 @@ services:
   OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\GreetingRepositoryInterface:
     class: OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\GreetingRepository
 
+  OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\UserRepositoryInterface:
+    class: OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\UserRepository
+
   OxidEsales\ExamplesModule\Greeting\Infrastructure\Factory\UserModelFactoryInterface:
     class: OxidEsales\ExamplesModule\Greeting\Infrastructure\Factory\UserModelFactory

src/Greeting/services.yaml

@@ -15,10 +15,6 @@ services:
       $shopName: '%env(OEEM_SHOP_NAME)%'
     public: true
 
-  OxidEsales\ExamplesModule\Greeting\Service\UserServiceInterface:
-    class: OxidEsales\ExamplesModule\Greeting\Service\UserService
-    public: true
-
   OxidEsales\ExamplesModule\Greeting\Transput\AdminGreetingRequestInterface:
     class: OxidEsales\ExamplesModule\Greeting\Transput\AdminGreetingRequest
     public: true

tests/Integration/Greeting/Controller/Admin/GreetingAdminControllerTest.php

@@ -11,8 +11,8 @@
 
 use OxidEsales\ExamplesModule\Core\Module as ModuleCore;
 use OxidEsales\ExamplesModule\Greeting\Controller\Admin\GreetingAdminController;
+use OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\UserRepositoryInterface;
 use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUserInterface;
-use OxidEsales\ExamplesModule\Greeting\Service\UserServiceInterface;
 use OxidEsales\ExamplesModule\Greeting\Transput\AdminGreetingRequestInterface;
 use OxidEsales\ExamplesModule\Tests\Integration\IntegrationTestCase;
 use PHPUnit\Framework\Attributes\Test;
@@ -30,14 +30,14 @@ public function renderSetsTplParamIfEditObjectGivenByRequest(): void
             'getPersonalGreeting' => $expectedGreeting = uniqid(),
         ]);
 
-        $userServiceMock = $this->createMock(UserServiceInterface::class);
-        $userServiceMock->method('getUserById')
+        $userRepositoryMock = $this->createMock(UserRepositoryInterface::class);
+        $userRepositoryMock->method('getUserById')
             ->with($userId)
             ->willReturn($userStub);
 
         $sut = $this->getSut(
             request: $requestStub,
-            userService: $userServiceMock,
+            userRepository: $userRepositoryMock,
         );
 
         $this->assertSame('@oe_examples_module/admin/user_greetings', $sut->render());
@@ -49,11 +49,11 @@ public function renderSetsTplParamIfEditObjectGivenByRequest(): void
     #[Test]
     public function renderDoesntSetTplParamIfEditObjectIsNotGivenByRequest(): void
     {
-        $userServiceSpy = $this->createMock(UserServiceInterface::class);
-        $userServiceSpy->expects($this->never())->method('getUserById');
+        $userRepositorySpy = $this->createMock(UserRepositoryInterface::class);
+        $userRepositorySpy->expects($this->never())->method('getUserById');
 
         $sut = $this->getSut(
-            userService: $userServiceSpy,
+            userRepository: $userRepositorySpy,
         );
 
         $this->assertSame('@oe_examples_module/admin/user_greetings', $sut->render());
@@ -63,13 +63,13 @@ public function renderDoesntSetTplParamIfEditObjectIsNotGivenByRequest(): void
     }
 
     private function getSut(
-        ?UserServiceInterface $userService = null,
+        ?UserRepositoryInterface $userRepository = null,
         ?AdminGreetingRequestInterface $request = null
     ): GreetingAdminController {
-        $userService ??= $this->createStub(UserServiceInterface::class);
+        $userRepository ??= $this->createStub(UserRepositoryInterface::class);
         $request ??= $this->createStub(AdminGreetingRequestInterface::class);
         return new GreetingAdminController(
-            userService: $userService,
+            userRepository: $userRepository,
             request: $request,
         );
     }

…ion/Greeting/Service/UserServiceTest.php …ucture/Repository/UserRepositoryTest.phptests/Integration/Greeting/Service/UserServiceTest.php renamed to tests/Integration/Greeting/Infrastructure/Repository/UserRepositoryTest.php tests/Integration/Greeting/Service/UserServiceTest.php renamed to tests/Integration/Greeting/Infrastructure/Repository/UserRepositoryTest.php

@@ -7,24 +7,19 @@
 
 declare(strict_types=1);
 
-namespace Greeting\Service;
+namespace OxidEsales\ExamplesModule\Tests\Integration\Greeting\Infrastructure\Repository;
 
-use OxidEsales\EshopCommunity\Tests\Integration\IntegrationTestCase;
 use OxidEsales\ExamplesModule\Extension\Model\User;
 use OxidEsales\ExamplesModule\Greeting\Infrastructure\Factory\UserModelFactoryInterface;
-use OxidEsales\ExamplesModule\Greeting\Service\UserService;
-use PHPUnit\Framework\Attributes\Test;
+use OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\UserRepository;
+use OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\UserRepositoryInterface;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
 
-final class UserServiceTest extends IntegrationTestCase
+#[CoversClass(UserRepository::class)]
+final class UserRepositoryTest extends TestCase
 {
-    public function setUp(): void
-    {
-        // @todo: its a temporary hack for broken autoloader solution 9474. Remove this when the case is solved.
-        oxNew(User::class);
-    }
-
-    #[Test]
-    public function getUserByIdLoadsUserAndReturnsIt(): void
+    public function testGetUserByIdLoadsUserAndReturnsIt(): void
     {
         $userId = uniqid();
 
@@ -37,11 +32,19 @@ public function getUserByIdLoadsUserAndReturnsIt(): void
             'create' => $userModelSpy,
         ]);
 
-        $sut = new UserService(
+        $sut = $this->getSut(
             userModelFactory: $userModelFactoryMock
         );
 
         $result = $sut->getUserById($userId);
         $this->assertSame($userModelSpy, $result);
     }
+
+    private function getSut(
+        ?UserModelFactoryInterface $userModelFactory = null,
+    ): UserRepositoryInterface {
+        $userModelFactory ??= $this->createStub(UserModelFactoryInterface::class);
+
+        return new UserRepository($userModelFactory);
+    }
 }