Merge pull request #44 from WyriHaximus/refactor-fetch-method-to-support-more-dynamic-fetching

Refactor fetch to support more dynamic fetching

Author: WyriHaximus

Makefile

@@ -44,7 +44,7 @@ seeds:
 syntax-php: ## Lint PHP syntax
 	$(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor .
 
-cs-fix: ## Fix any automatically fixable code style issues ###
+cs-fix: ## Fix any automatically fixable code style issues
 	$(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(THREADS) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(THREADS) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(THREADS) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml -vvvv
 
 cs: ## Check the code for code style issues

src/Query/Limit.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WyriHaximus\React\SimpleORM\Query;
+
+final class Limit implements SectionInterface
+{
+    private int $limit;
+
+    public function __construct(int $limit)
+    {
+        $this->limit = $limit;
+    }
+
+    public function limit(): int
+    {
+        return $this->limit;
+    }
+}

src/Query/Order.php

@@ -4,7 +4,7 @@
 
 namespace WyriHaximus\React\SimpleORM\Query;
 
-final class Order
+final class Order implements SectionInterface
 {
     /** @var array<OrderInterface> */
     private array $orders = [];

src/Query/SectionInterface.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WyriHaximus\React\SimpleORM\Query;
+
+interface SectionInterface
+{
+}

src/Query/Where.php

@@ -4,7 +4,7 @@
 
 namespace WyriHaximus\React\SimpleORM\Query;
 
-final class Where
+final class Where implements SectionInterface
 {
     /** @var array<WhereInterface> */
     private array $wheres = [];

src/Repository.php

@@ -17,7 +17,9 @@
 use Rx\Scheduler\ImmediateScheduler;
 use Safe\DateTimeImmutable;
 use WyriHaximus\React\SimpleORM\Annotation\JoinInterface;
+use WyriHaximus\React\SimpleORM\Query\Limit;
 use WyriHaximus\React\SimpleORM\Query\Order;
+use WyriHaximus\React\SimpleORM\Query\SectionInterface;
 use WyriHaximus\React\SimpleORM\Query\Where;
 use WyriHaximus\React\SimpleORM\Query\Where\Expression;
 use WyriHaximus\React\SimpleORM\Query\Where\Field;
@@ -36,6 +38,7 @@
 use function spl_object_hash;
 use function strpos;
 
+use const WyriHaximus\Constants\Boolean\TRUE_;
 use const WyriHaximus\Constants\Numeric\ONE;
 use const WyriHaximus\Constants\Numeric\ZERO;
 
@@ -90,12 +93,20 @@ public function page(int $page, ?Where $where = null, ?Order $order = null, int
         return $this->fetchAndHydrate($query);
     }
 
-    /** @phpstan-ignore-next-line */
-    public function fetch(?Where $where = null, ?Order $order = null, int $limit = ZERO): Observable
+    /**
+     * @param array<SectionInterface> $sections
+     *
+     * @phpstan-ignore-next-line
+     */
+    public function fetch(SectionInterface ...$sections): Observable
     {
-        $query = $this->buildSelectQuery($where ?? new Where(), $order ?? new Order());
-        if ($limit > ZERO) {
-            $query = $query->limit($limit)->offset(ZERO);
+        $query = $this->buildSelectQuery(...$sections);
+        foreach ($sections as $section) {
+            if (! ($section instanceof Limit) || $section->limit() <= ZERO) {
+                continue;
+            }
+
+            $query = $query->limit($section->limit())->offset(ZERO);
         }
 
         return $this->fetchAndHydrate($query);
@@ -138,7 +149,7 @@ public function update(EntityInterface $entity): PromiseInterface
         )->toPromise()->then(function () use ($entity): PromiseInterface {
             return $this->fetch(new Where(
                 new Where\Field('id', 'eq', [$entity->id()]),
-            ), new Order(), ONE)->toPromise();
+            ), new Limit(ONE))->toPromise();
         });
     }
 
@@ -150,15 +161,31 @@ public function delete(EntityInterface $entity): PromiseInterface
         )->toPromise();
     }
 
-    private function buildSelectQuery(Where $constraints, Order $order): SelectQuery
+    /**
+     * @param array<SectionInterface> $sections
+     *
+     * @phpstan-ignore-next-line
+     */
+    private function buildSelectQuery(SectionInterface ...$sections): SelectQuery
     {
         $query = $this->buildBaseSelectQuery();
         $query = $query->columns(...array_values($this->fields));
-        $query = $this->applyWhereToQuery($constraints, $query);
+        foreach ($sections as $section) {
+            /** @phpstan-ignore-next-line */
+            switch (TRUE_) {
+                case $section instanceof Where:
+                    /** @psalm-suppress ArgumentTypeCoercion */
+                    $query = $this->applyWhereToQuery($section, $query);
+                    break;
+                case $section instanceof Order:
+                    /** @psalm-suppress UndefinedInterfaceMethod */
+                    foreach ($section->orders() as $by) {
+                        $field = $this->translateFieldName($by->field());
+                        $query = $query->orderBy($field, $by->order());
+                    }
 
-        foreach ($order->orders() as $by) {
-            $field = $this->translateFieldName($by->field());
-            $query = $query->orderBy($field, $by->order());
+                    break;
+            }
         }
 
         return $query;
@@ -379,7 +406,7 @@ private function buildTree(array $row, InspectedEntityInterface $entity, string
                         $this->client
                             ->repository($join->entity()
                             ->class())
-                            ->fetch(new Where(...$where), new Order(), self::SINGLE)
+                            ->fetch(new Where(...$where), new Limit(self::SINGLE))
                             ->toPromise()
                             ->then($resolve, $reject);
                     });

src/RepositoryInterface.php

@@ -7,6 +7,7 @@
 use React\Promise\PromiseInterface;
 use Rx\Observable;
 use WyriHaximus\React\SimpleORM\Query\Order;
+use WyriHaximus\React\SimpleORM\Query\SectionInterface;
 use WyriHaximus\React\SimpleORM\Query\Where;
 
 interface RepositoryInterface
@@ -19,8 +20,7 @@ public function count(?Where $where = null): PromiseInterface;
     /** @phpstan-ignore-next-line */
     public function page(int $page, ?Where $where = null, ?Order $order = null, int $perPage = self::DEFAULT_PER_PAGE): Observable;
 
-    /** @phpstan-ignore-next-line */
-    public function fetch(?Where $where = null, ?Order $order = null, int $limit = 0): Observable;
+    public function fetch(SectionInterface ...$sections): Observable;
 
     /**
      * @param array<string, mixed> $fields

tests/FunctionalTest.php

@@ -14,6 +14,7 @@
 use WyriHaximus\React\SimpleORM\Client;
 use WyriHaximus\React\SimpleORM\ClientInterface;
 use WyriHaximus\React\SimpleORM\Middleware\QueryCountMiddleware;
+use WyriHaximus\React\SimpleORM\Query\Limit;
 use WyriHaximus\React\SimpleORM\Query\Where;
 use WyriHaximus\React\Tests\SimpleORM\Stub\BlogPostStub;
 use WyriHaximus\React\Tests\SimpleORM\Stub\CommentStub;
@@ -218,7 +219,7 @@ public function firstBlogPostAuthorIdUsingLimit(): void
         self::assertSame(
             'fb175cbc-04cc-41c7-8e35-6b817ac016ca',
             $this->await(
-                $this->client->repository(BlogPostStub::class)->fetch(null, null, 1)->toPromise()->then(static function (BlogPostStub $blogPost): string {
+                $this->client->repository(BlogPostStub::class)->fetch(new Limit(1))->toPromise()->then(static function (BlogPostStub $blogPost): string {
                     return $blogPost->getAuthor()->id();
                 }),
                 $this->loop,