Use translations

Author: tatevikg1

.github/workflows/l10n-validate.yml

@@ -3,7 +3,7 @@ name: L10n Validate
 on:
   pull_request:
     paths:
-      - 'translations/**/*.xlf'
+      - 'resources/translations/**/*.xlf'
 
 jobs:
   validate-xliff:

resources/translations/messages.en.xlf

@@ -19,6 +19,26 @@
         <target>Login attempt for disabled admin '%login%'</target>
       </trans-unit>
 
+      <!-- Identity -->
+      <trans-unit id="identity.admin_not_found">
+        <source>Administrator not found</source>
+        <target>Administrator not found</target>
+      </trans-unit>
+
+      <!-- Subscription -->
+      <trans-unit id="subscription.list_not_found">
+        <source>Subscriber list not found.</source>
+        <target>Subscriber list not found.</target>
+      </trans-unit>
+      <trans-unit id="subscription.subscriber_not_found">
+        <source>Subscriber does not exists.</source>
+        <target>Subscriber does not exists.</target>
+      </trans-unit>
+      <trans-unit id="subscription.not_found_for_list_and_subscriber">
+        <source>Subscription not found for this subscriber and list.</source>
+        <target>Subscription not found for this subscriber and list.</target>
+      </trans-unit>
+
     </body>
   </file>
 </xliff>

src/Domain/Common/I18n/Messages.php

@@ -15,6 +15,14 @@ final class Messages
     public const AUTH_LOGIN_FAILED = 'auth.login_failed';
     public const AUTH_LOGIN_DISABLED = 'auth.login_disabled';
 
+    // Identity
+    public const IDENTITY_ADMIN_NOT_FOUND = 'identity.admin_not_found';
+
+    // Subscription
+    public const SUBSCRIPTION_LIST_NOT_FOUND = 'subscription.list_not_found';
+    public const SUBSCRIPTION_SUBSCRIBER_NOT_FOUND = 'subscription.subscriber_not_found';
+    public const SUBSCRIPTION_NOT_FOUND_FOR_LIST_AND_SUBSCRIBER = 'subscription.not_found_for_list_and_subscriber';
+
     private function __construct()
     {
     }

src/Domain/Identity/Service/PasswordManager.php

@@ -5,6 +5,7 @@
 namespace PhpList\Core\Domain\Identity\Service;
 
 use DateTime;
+use PhpList\Core\Domain\Common\I18n\Messages;
 use PhpList\Core\Domain\Identity\Model\AdminPasswordRequest;
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Identity\Repository\AdminPasswordRequestRepository;
@@ -13,6 +14,7 @@
 use PhpList\Core\Security\HashGenerator;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class PasswordManager
 {
@@ -22,17 +24,20 @@ class PasswordManager
     private AdministratorRepository $administratorRepository;
     private HashGenerator $hashGenerator;
     private MessageBusInterface $messageBus;
+    private TranslatorInterface $translator;
 
     public function __construct(
         AdminPasswordRequestRepository $passwordRequestRepository,
         AdministratorRepository $administratorRepository,
         HashGenerator $hashGenerator,
-        MessageBusInterface $messageBus
+        MessageBusInterface $messageBus,
+        TranslatorInterface $translator
     ) {
         $this->passwordRequestRepository = $passwordRequestRepository;
         $this->administratorRepository = $administratorRepository;
         $this->hashGenerator = $hashGenerator;
         $this->messageBus = $messageBus;
+        $this->translator = $translator;
     }
 
     /**
@@ -47,7 +52,8 @@ public function generatePasswordResetToken(string $email): string
     {
         $administrator = $this->administratorRepository->findOneBy(['email' => $email]);
         if ($administrator === null) {
-            throw new NotFoundHttpException('Administrator not found', null, 1500567100);
+            $message = $this->translator->trans(Messages::IDENTITY_ADMIN_NOT_FOUND);
+            throw new NotFoundHttpException($message, null, 1500567100);
         }
 
         $existingRequests = $this->passwordRequestRepository->findByAdmin($administrator);

src/Domain/Subscription/Service/Manager/SubscriptionManager.php

@@ -4,28 +4,33 @@
 
 namespace PhpList\Core\Domain\Subscription\Service\Manager;
 
+use PhpList\Core\Domain\Common\I18n\Messages;
 use PhpList\Core\Domain\Subscription\Exception\SubscriptionCreationException;
 use PhpList\Core\Domain\Subscription\Model\Subscriber;
 use PhpList\Core\Domain\Subscription\Model\SubscriberList;
 use PhpList\Core\Domain\Subscription\Model\Subscription;
 use PhpList\Core\Domain\Subscription\Repository\SubscriberListRepository;
 use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository;
 use PhpList\Core\Domain\Subscription\Repository\SubscriptionRepository;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class SubscriptionManager
 {
     private SubscriptionRepository $subscriptionRepository;
     private SubscriberRepository $subscriberRepository;
     private SubscriberListRepository $subscriberListRepository;
+    private TranslatorInterface $translator;
 
     public function __construct(
         SubscriptionRepository $subscriptionRepository,
         SubscriberRepository $subscriberRepository,
-        SubscriberListRepository $subscriberListRepository
+        SubscriberListRepository $subscriberListRepository,
+        TranslatorInterface $translator
     ) {
         $this->subscriptionRepository = $subscriptionRepository;
         $this->subscriberRepository = $subscriberRepository;
         $this->subscriberListRepository = $subscriberListRepository;
+        $this->translator = $translator;
     }
 
     public function addSubscriberToAList(Subscriber $subscriber, int $listId): Subscription
@@ -37,7 +42,8 @@ public function addSubscriberToAList(Subscriber $subscriber, int $listId): Subsc
         }
         $subscriberList = $this->subscriberListRepository->find($listId);
         if (!$subscriberList) {
-            throw new SubscriptionCreationException('Subscriber list not found.', 404);
+            $message = $this->translator->trans(Messages::SUBSCRIPTION_LIST_NOT_FOUND);
+            throw new SubscriptionCreationException($message, 404);
         }
 
         $subscription = new Subscription();
@@ -64,7 +70,8 @@ private function createSubscription(SubscriberList $subscriberList, string $emai
     {
         $subscriber = $this->subscriberRepository->findOneBy(['email' => $email]);
         if (!$subscriber) {
-            throw new SubscriptionCreationException('Subscriber does not exists.', 404);
+            $message = $this->translator->trans(Messages::SUBSCRIPTION_SUBSCRIBER_NOT_FOUND);
+            throw new SubscriptionCreationException($message, 404);
         }
 
         $existingSubscription = $this->subscriptionRepository
@@ -101,7 +108,8 @@ private function deleteSubscription(SubscriberList $subscriberList, string $emai
             ->findOneBySubscriberEmailAndListId($subscriberList->getId(), $email);
 
         if (!$subscription) {
-            throw new SubscriptionCreationException('Subscription not found for this subscriber and list.', 404);
+            $message = $this->translator->trans(Messages::SUBSCRIPTION_NOT_FOUND_FOR_LIST_AND_SUBSCRIBER);
+            throw new SubscriptionCreationException($message, 404);
         }
 
         $this->subscriptionRepository->remove($subscription);

tests/Unit/Domain/Identity/Service/PasswordManagerTest.php

@@ -17,6 +17,7 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class PasswordManagerTest extends TestCase
 {
@@ -36,7 +37,8 @@ protected function setUp(): void
             passwordRequestRepository: $this->passwordRequestRepository,
             administratorRepository: $this->administratorRepository,
             hashGenerator: $this->hashGenerator,
-            messageBus: $this->messageBus
+            messageBus: $this->messageBus,
+            translator: $this->createMock(TranslatorInterface::class)
         );
     }
 

tests/Unit/Domain/Subscription/Service/Manager/SubscriptionManagerTest.php

@@ -14,22 +14,26 @@
 use PhpList\Core\Domain\Subscription\Service\Manager\SubscriptionManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class SubscriptionManagerTest extends TestCase
 {
     private SubscriptionRepository&MockObject $subscriptionRepository;
     private SubscriberRepository&MockObject $subscriberRepository;
+    private TranslatorInterface&MockObject $translator;
     private SubscriptionManager $manager;
 
     protected function setUp(): void
     {
         $this->subscriptionRepository = $this->createMock(SubscriptionRepository::class);
         $this->subscriberRepository = $this->createMock(SubscriberRepository::class);
         $subscriberListRepository = $this->createMock(SubscriberListRepository::class);
+        $this->translator = $this->createMock(TranslatorInterface::class);
         $this->manager = new SubscriptionManager(
-            $this->subscriptionRepository,
-            $this->subscriberRepository,
-            $subscriberListRepository
+            subscriptionRepository: $this->subscriptionRepository,
+            subscriberRepository: $this->subscriberRepository,
+            subscriberListRepository: $subscriberListRepository,
+            translator: $this->translator,
         );
     }
 
@@ -51,6 +55,7 @@ public function testCreateSubscriptionWhenSubscriberExists(): void
 
     public function testCreateSubscriptionThrowsWhenSubscriberMissing(): void
     {
+        $this->translator->method('trans')->willReturn('Subscriber does not exists.');
         $this->expectException(SubscriptionCreationException::class);
         $this->expectExceptionMessage('Subscriber does not exists.');