Refactor: Coupling between objects

Author: tatevikg1

config/services/services.yml

@@ -0,0 +1,8 @@
+services:
+    PhpList\RestBundle\Subscription\Service\SubscriberService:
+        autowire: true
+        autoconfigure: true
+
+    PhpList\RestBundle\Subscription\Service\SubscriberHistoryService:
+        autowire: true
+        autoconfigure: true

src/Subscription/Controller/SubscriberController.php

@@ -4,29 +4,20 @@
 
 namespace PhpList\RestBundle\Subscription\Controller;
 
-use DateTimeImmutable;
-use Exception;
 use OpenApi\Attributes as OA;
 use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
-use PhpList\Core\Domain\Subscription\Model\Filter\SubscriberHistoryFilter;
 use PhpList\Core\Domain\Subscription\Model\Subscriber;
-use PhpList\Core\Domain\Subscription\Model\SubscriberHistory;
-use PhpList\Core\Domain\Subscription\Service\Manager\SubscriberManager;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Common\Controller\BaseController;
-use PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Common\Validator\RequestValidator;
 use PhpList\RestBundle\Subscription\Request\CreateSubscriberRequest;
 use PhpList\RestBundle\Subscription\Request\UpdateSubscriberRequest;
-use PhpList\RestBundle\Subscription\Serializer\SubscriberNormalizer;
+use PhpList\RestBundle\Subscription\Service\SubscriberService;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Attribute\Route;
-use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
-use Symfony\Component\Validator\Exception\ValidatorException;
 
 /**
  * This controller provides REST API access to subscribers.
@@ -37,25 +28,16 @@
 #[Route('/subscribers', name: 'subscriber_')]
 class SubscriberController extends BaseController
 {
-    private SubscriberManager $subscriberManager;
-    private SubscriberNormalizer $subscriberNormalizer;
-    private PaginatedDataProvider $paginatedDataProvider;
-    private NormalizerInterface $serializer;
+    private SubscriberService $subscriberService;
 
     public function __construct(
         Authentication $authentication,
         RequestValidator $validator,
-        SubscriberManager $subscriberManager,
-        SubscriberNormalizer $subscriberNormalizer,
-        PaginatedDataProvider $paginatedDataProvider,
-        NormalizerInterface $serializer,
+        SubscriberService $subscriberService,
     ) {
         parent::__construct($authentication, $validator);
         $this->authentication = $authentication;
-        $this->subscriberManager = $subscriberManager;
-        $this->subscriberNormalizer = $subscriberNormalizer;
-        $this->paginatedDataProvider = $paginatedDataProvider;
-        $this->serializer = $serializer;
+        $this->subscriberService = $subscriberService;
     }
 
     #[Route('', name: 'create', methods: ['POST'])]
@@ -111,12 +93,9 @@ public function createSubscriber(Request $request): JsonResponse
 
         /** @var CreateSubscriberRequest $subscriberRequest */
         $subscriberRequest = $this->validator->validate($request, CreateSubscriberRequest::class);
-        $subscriber = $this->subscriberManager->createSubscriber($subscriberRequest->getDto());
+        $subscriberData = $this->subscriberService->createSubscriber($subscriberRequest);
 
-        return $this->json(
-            $this->subscriberNormalizer->normalize($subscriber, 'json'),
-            Response::HTTP_CREATED
-        );
+        return $this->json($subscriberData, Response::HTTP_CREATED);
     }
 
     #[Route('/{subscriberId}', name: 'update', requirements: ['subscriberId' => '\d+'], methods: ['PUT'])]
@@ -184,9 +163,9 @@ public function updateSubscriber(
         }
         /** @var UpdateSubscriberRequest $updateSubscriberRequest */
         $updateSubscriberRequest = $this->validator->validate($request, UpdateSubscriberRequest::class);
-        $subscriber = $this->subscriberManager->updateSubscriber($updateSubscriberRequest->getDto());
+        $subscriberData = $this->subscriberService->updateSubscriber($updateSubscriberRequest);
 
-        return $this->json($this->subscriberNormalizer->normalize($subscriber, 'json'), Response::HTTP_OK);
+        return $this->json($subscriberData, Response::HTTP_OK);
     }
 
     #[Route('/{subscriberId}', name: 'get_one', requirements: ['subscriberId' => '\d+'], methods: ['GET'])]
@@ -234,9 +213,9 @@ public function getSubscriber(Request $request, int $subscriberId): JsonResponse
     {
         $this->requireAuthentication($request);
 
-        $subscriber = $this->subscriberManager->getSubscriber($subscriberId);
+        $subscriberData = $this->subscriberService->getSubscriber($subscriberId);
 
-        return $this->json($this->subscriberNormalizer->normalize($subscriber), Response::HTTP_OK);
+        return $this->json($subscriberData, Response::HTTP_OK);
     }
 
     #[Route('/{subscriberId}/history', name: 'history', requirements: ['subscriberId' => '\d+'], methods: ['GET'])]
@@ -330,31 +309,10 @@ public function getSubscriberHistory(
     ): JsonResponse {
         $this->requireAuthentication($request);
 
-        if (!$subscriber) {
-            throw $this->createNotFoundException('Subscriber not found.');
-        }
-
-        try {
-            $dateFrom = $request->query->get('date_from');
-            $dateFromFormated = $dateFrom ? new DateTimeImmutable($dateFrom) : null;
-        } catch (Exception $e) {
-            throw new ValidatorException('Invalid date format. Use format: Y-m-d');
-        }
-
-        $filter = new SubscriberHistoryFilter(
-            subscriber: $subscriber,
-            ip: $request->query->get('ip'),
-            dateFrom: $dateFromFormated,
-            summery: $request->query->get('summery'),
-        );
+        $historyData = $this->subscriberService->getSubscriberHistory($request, $subscriber);
 
         return $this->json(
-            data: $this->paginatedDataProvider->getPaginatedList(
-                request: $request,
-                normalizer: $this->serializer,
-                className: SubscriberHistory::class,
-                filter: $filter
-            ),
+            data: $historyData,
             status: Response::HTTP_OK,
         );
     }
@@ -412,7 +370,7 @@ public function deleteSubscriber(
         if (!$subscriber) {
             throw $this->createNotFoundException('Subscriber not found.');
         }
-        $this->subscriberManager->deleteSubscriber($subscriber);
+        $this->subscriberService->deleteSubscriber($subscriber);
 
         return $this->json(null, Response::HTTP_NO_CONTENT);
     }
@@ -457,9 +415,9 @@ public function setSubscriberAsConfirmed(Request $request): Response
             return new Response('<h1>Missing confirmation code.</h1>', 400);
         }
 
-        try {
-            $this->subscriberManager->markAsConfirmedByUniqueId($uniqueId);
-        } catch (NotFoundHttpException) {
+        $subscriber = $this->subscriberService->confirmSubscriber($uniqueId);
+
+        if (!$subscriber) {
             return new Response('<h1>Subscriber isn\'t found or already confirmed.</h1>', 404);
         }
 

src/Subscription/Service/SubscriberHistoryService.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Subscription\Service;
+
+use DateTimeImmutable;
+use Exception;
+use PhpList\Core\Domain\Subscription\Model\Filter\SubscriberHistoryFilter;
+use PhpList\Core\Domain\Subscription\Model\Subscriber;
+use PhpList\Core\Domain\Subscription\Model\SubscriberHistory;
+use PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+use Symfony\Component\Validator\Exception\ValidatorException;
+
+class SubscriberHistoryService
+{
+    public function __construct(
+        private readonly PaginatedDataProvider $paginatedDataProvider,
+        private readonly NormalizerInterface $serializer,
+    ) {
+    }
+
+    public function getSubscriberHistory(Request $request, ?Subscriber $subscriber): array
+    {
+        if (!$subscriber) {
+            throw new NotFoundHttpException('Subscriber not found.');
+        }
+
+        try {
+            $dateFrom = $request->query->get('date_from');
+            $dateFromFormated = $dateFrom ? new DateTimeImmutable($dateFrom) : null;
+        } catch (Exception $e) {
+            throw new ValidatorException('Invalid date format. Use format: Y-m-d');
+        }
+
+        $filter = new SubscriberHistoryFilter(
+            subscriber: $subscriber,
+            ip: $request->query->get('ip'),
+            dateFrom: $dateFromFormated,
+            summery: $request->query->get('summery'),
+        );
+
+        return $this->paginatedDataProvider->getPaginatedList(
+            request: $request,
+            normalizer: $this->serializer,
+            className: SubscriberHistory::class,
+            filter: $filter
+        );
+    }
+}

src/Subscription/Service/SubscriberService.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Subscription\Service;
+
+use PhpList\Core\Domain\Subscription\Model\Subscriber;
+use PhpList\Core\Domain\Subscription\Service\Manager\SubscriberManager;
+use PhpList\RestBundle\Subscription\Request\CreateSubscriberRequest;
+use PhpList\RestBundle\Subscription\Request\UpdateSubscriberRequest;
+use PhpList\RestBundle\Subscription\Serializer\SubscriberNormalizer;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+class SubscriberService
+{
+    public function __construct(
+        private readonly SubscriberManager $subscriberManager,
+        private readonly SubscriberNormalizer $subscriberNormalizer,
+        private readonly SubscriberHistoryService $subscriberHistoryService,
+    ) {
+    }
+
+    public function createSubscriber(CreateSubscriberRequest $subscriberRequest): array
+    {
+        $subscriber = $this->subscriberManager->createSubscriber($subscriberRequest->getDto());
+        return $this->subscriberNormalizer->normalize($subscriber, 'json');
+    }
+
+    public function updateSubscriber(UpdateSubscriberRequest $updateSubscriberRequest): array
+    {
+        $subscriber = $this->subscriberManager->updateSubscriber($updateSubscriberRequest->getDto());
+        return $this->subscriberNormalizer->normalize($subscriber, 'json');
+    }
+
+    public function getSubscriber(int $subscriberId): array
+    {
+        $subscriber = $this->subscriberManager->getSubscriber($subscriberId);
+        return $this->subscriberNormalizer->normalize($subscriber);
+    }
+
+    public function getSubscriberHistory(Request $request, ?Subscriber $subscriber): array
+    {
+        return $this->subscriberHistoryService->getSubscriberHistory($request, $subscriber);
+    }
+
+    public function deleteSubscriber(Subscriber $subscriber): void
+    {
+        $this->subscriberManager->deleteSubscriber($subscriber);
+    }
+
+    public function confirmSubscriber(string $uniqueId): ?Subscriber
+    {
+        if (!$uniqueId) {
+            return null;
+        }
+
+        try {
+            return $this->subscriberManager->markAsConfirmedByUniqueId($uniqueId);
+        } catch (NotFoundHttpException) {
+            return null;
+        }
+    }
+}