Move SendingQueueEntity::toArray() to SendingQueuesResponseBuilder::build()

Based on a suggestion during the review of the PR, it was decided that
it makes more sense for the code that was created as
SendingQueueEntity::toArray() tp be moved to
SendingQueuesResponseBuilder::build(). It is used only to build the
format that is send in the API response.

[MAILPOET-4368]

mailpoet/lib/API/JSON/ResponseBuilders/SendingQueuesResponseBuilder.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\API\JSON\ResponseBuilders;
+
+use MailPoet\Entities\NewsletterEntity;
+use MailPoet\Entities\ScheduledTaskEntity;
+use MailPoet\Entities\SendingQueueEntity;
+
+class SendingQueuesResponseBuilder {
+  public function build(SendingQueueEntity $sendingQueue): array {
+    if (!$sendingQueue->getTask() instanceof ScheduledTaskEntity) {
+      throw new \RuntimeException('Invalid state. SendingQueue has no ScheduledTask associated.');
+    }
+
+    return [
+      'id' => $sendingQueue->getId(),
+      'type' => $sendingQueue->getTask()->getType(),
+      'status' => $sendingQueue->getTask()->getStatus(),
+      'priority' => $sendingQueue->getTask()->getPriority(),
+      'scheduled_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getScheduledAt()),
+      'processed_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getProcessedAt()),
+      'created_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getCreatedAt()),
+      'updated_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getUpdatedAt()),
+      'deleted_at' => $this->getFormattedDateOrNull($sendingQueue->getTask()->getDeletedAt()),
+      'in_progress' => $sendingQueue->getTask()->getInProgress(),
+      'reschedule_count' => $sendingQueue->getTask()->getRescheduleCount(),
+      'meta' => $sendingQueue->getMeta(),
+      'task_id' => $sendingQueue->getTask()->getId(),
+      'newsletter_id' => ($sendingQueue->getNewsletter() instanceof NewsletterEntity) ? $sendingQueue->getNewsletter()->getId() : null,
+      'newsletter_rendered_body' => $sendingQueue->getNewsletterRenderedBody(),
+      'newsletter_rendered_subject' => $sendingQueue->getNewsletterRenderedSubject(),
+      'count_total' => $sendingQueue->getCountTotal(),
+      'count_processed' => $sendingQueue->getCountProcessed(),
+      'count_to_process' => $sendingQueue->getCountToProcess(),
+    ];
+  }
+
+  private function getFormattedDateOrNull(?\DateTimeInterface $date): ?string {
+    return $date ? $date->format('Y-m-d H:i:s') : null;
+  }
+}

mailpoet/lib/API/JSON/v1/SendingQueue.php

@@ -5,6 +5,7 @@ namespace MailPoet\API\JSON\v1;
 use MailPoet\API\JSON\Endpoint as APIEndpoint;
 use MailPoet\API\JSON\Error as APIError;
 use MailPoet\API\JSON\Response;
+use MailPoet\API\JSON\ResponseBuilders\SendingQueuesResponseBuilder;
 use MailPoet\Config\AccessControl;
 use MailPoet\Cron\ActionScheduler\Actions\DaemonTrigger;
 use MailPoet\Cron\CronTrigger;
@@ -60,6 +61,9 @@ class SendingQueue extends APIEndpoint {
   /** @var DaemonTrigger */
   private $actionSchedulerDaemonTriggerAction;
 
+  /** @var SendingQueuesResponseBuilder */
+  private $sendingQueuesResponseBuilder;
+
   public function __construct(
     SubscribersFeature $subscribersFeature,
     NewslettersRepository $newsletterRepository,
@@ -70,7 +74,8 @@ class SendingQueue extends APIEndpoint {
     Scheduler $scheduler,
     SettingsController $settings,
     DaemonTrigger $actionSchedulerDaemonTriggerAction,
-    NewsletterValidator $newsletterValidator
+    NewsletterValidator $newsletterValidator,
+    SendingQueuesResponseBuilder $sendingQueuesResponseBuilder
   ) {
     $this->subscribersFeature = $subscribersFeature;
     $this->subscribersFinder = $subscribersFinder;
@@ -82,6 +87,7 @@ class SendingQueue extends APIEndpoint {
     $this->settings = $settings;
     $this->actionSchedulerDaemonTriggerAction = $actionSchedulerDaemonTriggerAction;
     $this->newsletterValidator = $newsletterValidator;
+    $this->sendingQueuesResponseBuilder = $sendingQueuesResponseBuilder;
   }
 
   public function add($data = []) {
@@ -202,7 +208,7 @@ class SendingQueue extends APIEndpoint {
     } else {
       $this->triggerSending($newsletter);
       return $this->successResponse(
-        ($newsletter->getLatestQueue() instanceof SendingQueueEntity) ? $newsletter->getLatestQueue()->toArray() : null
+        ($newsletter->getLatestQueue() instanceof SendingQueueEntity) ? $this->sendingQueuesResponseBuilder->build($newsletter->getLatestQueue()) : null
       );
     }
   }

mailpoet/lib/DI/ContainerConfigurator.php

@@ -104,6 +104,7 @@ class ContainerConfigurator implements IContainerConfigurator {
     $container->autowire(\MailPoet\API\JSON\ResponseBuilders\SegmentsResponseBuilder::class)->setPublic(true);
     $container->autowire(\MailPoet\API\JSON\ResponseBuilders\DynamicSegmentsResponseBuilder::class)->setPublic(true);
     $container->autowire(\MailPoet\API\JSON\ResponseBuilders\ScheduledTaskSubscriberResponseBuilder::class)->setPublic(true);
+    $container->autowire(\MailPoet\API\JSON\ResponseBuilders\SendingQueuesResponseBuilder::class)->setPublic(true);
     // REST API
     $container->autowire(\MailPoet\API\REST\API::class)->setPublic(true);
     $container->autowire(\MailPoet\API\REST\EndpointContainer::class)

mailpoet/lib/Entities/SendingQueueEntity.php

@@ -223,36 +223,4 @@ class SendingQueueEntity {
   public function setNewsletter(NewsletterEntity $newsletter) {
     $this->newsletter = $newsletter;
   }
-
-  public function toArray(): array {
-    if (!$this->getTask() instanceof ScheduledTaskEntity) {
-      throw new \RuntimeException('Invalid state. SendingQueue has no ScheduledTask associated.');
-    }
-
-    return [
-      'id' => $this->getId(),
-      'type' => $this->getTask()->getType(),
-      'status' => $this->getTask()->getStatus(),
-      'priority' => $this->getTask()->getPriority(),
-      'scheduled_at' => $this->getFormattedDateOrNull($this->getTask()->getScheduledAt()),
-      'processed_at' => $this->getFormattedDateOrNull($this->getTask()->getProcessedAt()),
-      'created_at' => $this->getFormattedDateOrNull($this->getTask()->getCreatedAt()),
-      'updated_at' => $this->getFormattedDateOrNull($this->getTask()->getUpdatedAt()),
-      'deleted_at' => $this->getFormattedDateOrNull($this->getTask()->getDeletedAt()),
-      'in_progress' => $this->getTask()->getInProgress(),
-      'reschedule_count' => $this->getTask()->getRescheduleCount(),
-      'meta' => $this->getMeta(),
-      'task_id' => $this->getTask()->getId(),
-      'newsletter_id' => ($this->getNewsletter() instanceof NewsletterEntity) ? $this->getNewsletter()->getId() : null,
-      'newsletter_rendered_body' => $this->getNewsletterRenderedBody(),
-      'newsletter_rendered_subject' => $this->getNewsletterRenderedSubject(),
-      'count_total' => $this->getCountTotal(),
-      'count_processed' => $this->getCountProcessed(),
-      'count_to_process' => $this->getCountToProcess(),
-    ];
-  }
-
-  private function getFormattedDateOrNull(?\DateTimeInterface $date): ?string {
-    return $date ? $date->format('Y-m-d H:i:s') : null;
-  }
 }

mailpoet/tests/integration/API/JSON/ResponseBuilders/SendingQueuesResponseBuilderTest.php

@@ -1,7 +1,8 @@
 <?php declare(strict_types = 1);
 
-namespace integration\Entities;
+namespace integration\API\JSON\ResponseBuilders;
 
+use MailPoet\API\JSON\ResponseBuilders\SendingQueuesResponseBuilder;
 use MailPoet\Entities\NewsletterEntity;
 use MailPoet\Entities\ScheduledTaskEntity;
 use MailPoet\Entities\SendingQueueEntity;
@@ -11,7 +12,7 @@ use MailPoet\Test\DataFactories\ScheduledTask as ScheduledTaskFactory;
 use MailPoet\Test\DataFactories\SendingQueue as SendingQueueFactory;
 use MailPoetVendor\Carbon\Carbon;
 
-class SendingQueueEntityTest extends \MailPoetTest {
+class SendingQueuesResponseBuilderTest extends \MailPoetTest {
   /** @var NewsletterEntity */
   private $newsletter;
 
@@ -21,11 +22,15 @@ class SendingQueueEntityTest extends \MailPoetTest {
   /** @var SendingQueueEntity */
   private $sendingQueue;
 
+  /** @var SendingQueuesResponseBuilder */
+  private $sendingQueuesResponseBuilder;
+
   public function _before() {
     $newsletterFactory = new NewsletterFactory();
     $sendingQueueFactory = new SendingQueueFactory();
     $scheduledTaskFactory = new ScheduledTaskFactory();
 
+    $this->sendingQueuesResponseBuilder = $this->diContainer->get(SendingQueuesResponseBuilder::class);
     $scheduledAt = new Carbon('2018-10-10 10:00:00');
     $this->newsletter = $newsletterFactory->create();
     $this->scheduledTask = $scheduledTaskFactory->create(Sending::TASK_TYPE, ScheduledTaskEntity::STATUS_SCHEDULED, $scheduledAt);
@@ -33,7 +38,7 @@ class SendingQueueEntityTest extends \MailPoetTest {
     $this->assertInstanceOf(SendingQueueEntity::class, $this->sendingQueue);
   }
 
-  public function testToArrayReturnsExpectedResult() {
+  public function testBuildReturnsExpectedResult() {
     $expectedResult = [
       'id' => $this->sendingQueue->getId(),
       'type' => 'sending',
@@ -56,6 +61,6 @@ class SendingQueueEntityTest extends \MailPoetTest {
       'count_to_process' => 0,
     ];
 
-    $this->assertSame($expectedResult, $this->sendingQueue->toArray());
+    $this->assertSame($expectedResult, $this->sendingQueuesResponseBuilder->build($this->sendingQueue));
   }
 }