Created DTOs with implicit validation to wrap short URLs lists params

module/CLI/src/Command/ShortUrl/ListShortUrlsCommand.php

@@ -4,16 +4,17 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
-use Cake\Chronos\Chronos;
 use Laminas\Paginator\Paginator;
 use Shlinkio\Shlink\CLI\Command\Util\AbstractWithDateRangeCommand;
 use Shlinkio\Shlink\CLI\Util\ExitCodes;
 use Shlinkio\Shlink\CLI\Util\ShlinkTable;
 use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
-use Shlinkio\Shlink\Common\Util\DateRange;
+use Shlinkio\Shlink\Core\Model\ShortUrlsOrdering;
+use Shlinkio\Shlink\Core\Model\ShortUrlsParams;
 use Shlinkio\Shlink\Core\Paginator\Adapter\ShortUrlRepositoryAdapter;
 use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
 use Shlinkio\Shlink\Core\Transformer\ShortUrlDataTransformer;
+use Shlinkio\Shlink\Core\Validation\ShortUrlsParamsInputFilter;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -108,7 +109,14 @@ class ListShortUrlsCommand extends AbstractWithDateRangeCommand
         $orderBy = $this->processOrderBy($input);
 
         do {
-            $result = $this->renderPage($output, $page, $searchTerm, $tags, $showTags, $startDate, $endDate, $orderBy);
+            $result = $this->renderPage($output, $showTags, ShortUrlsParams::fromRawData([
+                ShortUrlsParamsInputFilter::PAGE => $page,
+                ShortUrlsParamsInputFilter::SEARCH_TERM => $searchTerm,
+                ShortUrlsParamsInputFilter::TAGS => $tags,
+                ShortUrlsOrdering::ORDER_BY => $orderBy,
+                ShortUrlsParamsInputFilter::START_DATE => $startDate !== null ? $startDate->toAtomString() : null,
+                ShortUrlsParamsInputFilter::END_DATE => $endDate !== null ? $endDate->toAtomString() : null,
+            ]));
             $page++;
 
             $continue = $this->isLastPage($result)
@@ -122,26 +130,9 @@ class ListShortUrlsCommand extends AbstractWithDateRangeCommand
         return ExitCodes::EXIT_SUCCESS;
     }
 
-    /**
-     * @param string|array|null $orderBy
-     */
-    private function renderPage(
-        OutputInterface $output,
-        int $page,
-        ?string $searchTerm,
-        array $tags,
-        bool $showTags,
-        ?Chronos $startDate,
-        ?Chronos $endDate,
-        $orderBy
-    ): Paginator {
-        $result = $this->shortUrlService->listShortUrls(
-            $page,
-            $searchTerm,
-            $tags,
-            $orderBy,
-            new DateRange($startDate, $endDate),
-        );
+    private function renderPage(OutputInterface $output, bool $showTags, ShortUrlsParams $params): Paginator
+    {
+        $result = $this->shortUrlService->listShortUrls($params);
 
         $headers = ['Short code', 'Short URL', 'Long URL', 'Date created', 'Visits count'];
         if ($showTags) {

module/CLI/test/Command/ShortUrl/ListShortUrlsCommandTest.php

@@ -11,8 +11,8 @@ use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
 use Shlinkio\Shlink\CLI\Command\ShortUrl\ListShortUrlsCommand;
-use Shlinkio\Shlink\Common\Util\DateRange;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
+use Shlinkio\Shlink\Core\Model\ShortUrlsParams;
 use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
@@ -64,7 +64,7 @@ class ListShortUrlsCommandTest extends TestCase
             $data[] = new ShortUrl('url_' . $i);
         }
 
-        $this->shortUrlService->listShortUrls(1, null, [], null, new DateRange())
+        $this->shortUrlService->listShortUrls(ShortUrlsParams::emptyInstance())
             ->willReturn(new Paginator(new ArrayAdapter($data)))
             ->shouldBeCalledOnce();
 
@@ -85,7 +85,7 @@ class ListShortUrlsCommandTest extends TestCase
     public function passingPageWillMakeListStartOnThatPage(): void
     {
         $page = 5;
-        $this->shortUrlService->listShortUrls($page, null, [], null, new DateRange())
+        $this->shortUrlService->listShortUrls(ShortUrlsParams::fromRawData(['page' => $page]))
             ->willReturn(new Paginator(new ArrayAdapter()))
             ->shouldBeCalledOnce();
 
@@ -96,7 +96,7 @@ class ListShortUrlsCommandTest extends TestCase
     /** @test */
     public function ifTagsFlagIsProvidedTagsColumnIsIncluded(): void
     {
-        $this->shortUrlService->listShortUrls(1, null, [], null, new DateRange())
+        $this->shortUrlService->listShortUrls(ShortUrlsParams::emptyInstance())
             ->willReturn(new Paginator(new ArrayAdapter()))
             ->shouldBeCalledOnce();
 
@@ -115,10 +115,16 @@ class ListShortUrlsCommandTest extends TestCase
         ?int $page,
         ?string $searchTerm,
         array $tags,
-        ?DateRange $dateRange
+        ?string $startDate = null,
+        ?string $endDate = null
     ): void {
-        $listShortUrls = $this->shortUrlService->listShortUrls($page, $searchTerm, $tags, null, $dateRange)
-            ->willReturn(new Paginator(new ArrayAdapter()));
+        $listShortUrls = $this->shortUrlService->listShortUrls(ShortUrlsParams::fromRawData([
+            'page' => $page,
+            'searchTerm' => $searchTerm,
+            'tags' => $tags,
+            'startDate' => $startDate !== null ? Chronos::parse($startDate)->toAtomString() : null,
+            'endDate' => $endDate !== null ? Chronos::parse($endDate)->toAtomString() : null,
+        ]))->willReturn(new Paginator(new ArrayAdapter()));
 
         $this->commandTester->setInputs(['n']);
         $this->commandTester->execute($commandArgs);
@@ -128,36 +134,37 @@ class ListShortUrlsCommandTest extends TestCase
 
     public function provideArgs(): iterable
     {
-        yield [[], 1, null, [], new DateRange()];
-        yield [['--page' => $page = 3], $page, null, [], new DateRange()];
-        yield [['--searchTerm' => $searchTerm = 'search this'], 1, $searchTerm, [], new DateRange()];
+        yield [[], 1, null, []];
+        yield [['--page' => $page = 3], $page, null, []];
+        yield [['--searchTerm' => $searchTerm = 'search this'], 1, $searchTerm, []];
         yield [
             ['--page' => $page = 3, '--searchTerm' => $searchTerm = 'search this', '--tags' => $tags = 'foo,bar'],
             $page,
             $searchTerm,
             explode(',', $tags),
-            new DateRange(),
         ];
         yield [
             ['--startDate' => $startDate = '2019-01-01'],
             1,
             null,
             [],
-            new DateRange(Chronos::parse($startDate)),
+            $startDate,
         ];
         yield [
             ['--endDate' => $endDate = '2020-05-23'],
             1,
             null,
             [],
-            new DateRange(null, Chronos::parse($endDate)),
+            null,
+            $endDate,
         ];
         yield [
             ['--startDate' => $startDate = '2019-01-01', '--endDate' => $endDate = '2020-05-23'],
             1,
             null,
             [],
-            new DateRange(Chronos::parse($startDate), Chronos::parse($endDate)),
+            $startDate,
+            $endDate,
         ];
     }
 
@@ -168,8 +175,9 @@ class ListShortUrlsCommandTest extends TestCase
      */
     public function orderByIsProperlyComputed(array $commandArgs, $expectedOrderBy): void
     {
-        $listShortUrls = $this->shortUrlService->listShortUrls(1, null, [], $expectedOrderBy, new DateRange())
-            ->willReturn(new Paginator(new ArrayAdapter()));
+        $listShortUrls = $this->shortUrlService->listShortUrls(ShortUrlsParams::fromRawData([
+            'orderBy' => $expectedOrderBy,
+        ]))->willReturn(new Paginator(new ArrayAdapter()));
 
         $this->commandTester->setInputs(['n']);
         $this->commandTester->execute($commandArgs);