Merge pull request #13 from WyriHaximus/lazy-joins

Allow inner joins to be defined as lazy

Author: WyriHaximus

infection.json.dist

@@ -22,13 +22,19 @@
          },
          "IncrementInteger": {
              "ignore": [
-                 "WyriHaximus\\React\\SimpleORM\\Repository::count"
+                 "WyriHaximus\\React\\SimpleORM\\Repository::count",
+                 "WyriHaximus\\React\\SimpleORM\\Repository::buildTree"
              ]
          },
          "OneZeroInteger": {
              "ignore": [
                  "WyriHaximus\\React\\SimpleORM\\Repository::count"
              ]
+         },
+         "Foreach_": {
+             "ignore": [
+                 "WyriHaximus\\React\\SimpleORM\\Repository::buildTree"
+             ]
          }
      }
-}
+}

src/Annotation/InnerJoin.php

@@ -20,6 +20,9 @@ final class InnerJoin implements JoinInterface
     /** @var string */
     private $property;
 
+    /** @var bool */
+    private $lazy = self::IS_NOT_LAZY;
+
     public function __construct(array $table)
     {
         /** @psalm-suppress RawObjectIteration */
@@ -40,6 +43,11 @@ public function getType(): string
         return 'inner';
     }
 
+    public function getLazy(): bool
+    {
+        return $this->lazy;
+    }
+
     /**
      * @return Clause[]
      */

src/Annotation/JoinInterface.php

@@ -4,12 +4,17 @@
 
 interface JoinInterface
 {
+    public const IS_LAZY = true;
+    public const IS_NOT_LAZY = false;
+
     public function getEntity(): string;
 
     public function getType(): string;
 
     public function getProperty(): string;
 
+    public function getLazy(): bool;
+
     /**
      * @return Clause[]
      */

src/Annotation/LeftJoin.php

@@ -20,6 +20,9 @@ final class LeftJoin implements JoinInterface
     /** @var string */
     private $property;
 
+    /** @var bool */
+    private $lazy = self::IS_NOT_LAZY;
+
     public function __construct(array $table)
     {
         /** @psalm-suppress RawObjectIteration */
@@ -40,6 +43,11 @@ public function getType(): string
         return 'left';
     }
 
+    public function getLazy(): bool
+    {
+        return $this->lazy;
+    }
+
     /**
      * @return Clause[]
      */

src/Entity/Join.php

@@ -16,14 +16,18 @@ final class Join
     /** @var string */
     private $property;
 
+    /** @var bool */
+    private $lazy;
+
     /** @var Clause[] */
     private $clause;
 
-    public function __construct(InspectedEntityInterface $entity, string $type, string $property, Clause ...$clause)
+    public function __construct(InspectedEntityInterface $entity, string $type, string $property, bool $lazy, Clause ...$clause)
     {
         $this->entity = $entity;
         $this->type = $type;
         $this->property = $property;
+        $this->lazy = $lazy;
         $this->clause = $clause;
     }
 
@@ -42,6 +46,11 @@ public function getProperty(): string
         return $this->property;
     }
 
+    public function getLazy(): bool
+    {
+        return $this->lazy;
+    }
+
     /**
      * @return Clause[]
      */

src/EntityInspector.php

@@ -80,6 +80,7 @@ private function getJoins(ReflectionClass $class): iterable
                 new LazyInspectedEntity($this, $annotation->getEntity()),
                 $annotation->getType(),
                 $annotation->getProperty(),
+                $annotation->getLazy(),
                 ...$annotation->getClause()
             );
         }

src/Repository.php

@@ -8,6 +8,7 @@
 use React\Promise\PromiseInterface;
 use Rx\Observable;
 use Rx\Scheduler\ImmediateScheduler;
+use WyriHaximus\React\SimpleORM\Annotation\JoinInterface;
 
 final class Repository implements RepositoryInterface
 {
@@ -156,6 +157,10 @@ private function buildJoins(QueryBuilder $query, InspectedEntityInterface $entit
                 continue;
             }
 
+            if ($join->getLazy() === JoinInterface::IS_LAZY) {
+                continue;
+            }
+
             if ($join->getType() === 'inner' && $entity->getClass() === $join->getEntity()->getClass()) {
                 continue;
             }
@@ -238,13 +243,13 @@ private function buildTree(array $row, InspectedEntityInterface $entity, string
         $tree = $row[$this->tableAliases[$tableKey]];
 
         foreach ($entity->getJoins() as $join) {
-            if ($join->getType() === 'inner' && $entity->getClass() !== $join->getEntity()->getClass()) {
+            if ($join->getType() === 'inner' && $entity->getClass() !== $join->getEntity()->getClass() && $join->getLazy() === false) {
                 $tree[$join->getProperty()] = $this->buildTree($row, $join->getEntity(), $join->getProperty());
 
                 continue;
             }
 
-            if ($join->getType() === 'inner' && $entity->getClass() === $join->getEntity()->getClass()) {
+            if ($join->getType() === 'inner' && ($join->getLazy() === JoinInterface::IS_LAZY || $entity->getClass() === $join->getEntity()->getClass())) {
                 $tree[$join->getProperty()] = new Promise(function (callable $resolve, callable $reject) use ($row, $join, $tableKey): void {
                     foreach ($join->getClause() as $clause) {
                         if ($row[$this->tableAliases[$tableKey]][$clause->getLocalKey()] === null) {

tests/FunctionalTest.php

@@ -164,6 +164,38 @@ function (CommentStub $comment) {
         );
     }
 
+    /**
+     * @test
+     */
+    public function firstBlogPostNextBlogPostResolvesToBlogPost(): void
+    {
+        self::assertInstanceOf(
+            BlogPostStub::class,
+            $this->await(
+                $this->client->getRepository(BlogPostStub::class)->fetch()->take(1)->toPromise()->then(function (BlogPostStub $blogPost) {
+                    return $blogPost->getNextBlogPost();
+                }),
+                $this->loop
+            )
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function firstBlogPostPreviousBlogPostResolvesToNull(): void
+    {
+        self::assertSame(
+            null,
+            $this->await(
+                $this->client->getRepository(BlogPostStub::class)->fetch()->take(1)->toPromise()->then(function (BlogPostStub $blogPost) {
+                    return $blogPost->getPreviousBlogPost();
+                }),
+                $this->loop
+            )
+        );
+    }
+
     /**
      * @test
      */

tests/Stub/BlogPostStub.php

@@ -21,7 +21,8 @@
                 foreign_key="blog_post_id",
             )
         },
-        property="comments"
+        property="comments",
+        lazy=LeftJoin::IS_LAZY
  * )
  * @InnerJoin(
         entity=UserStub::class,
@@ -31,7 +32,8 @@
                 foreign_key="id",
             )
         },
-        property="author"
+        property="author",
+        lazy=InnerJoin::IS_NOT_LAZY
  * )
  * @InnerJoin(
         entity=UserStub::class,
@@ -41,7 +43,8 @@
                 foreign_key="id",
             )
         },
-        property="publisher"
+        property="publisher",
+        lazy=InnerJoin::IS_NOT_LAZY
  * )
  * @InnerJoin(
         entity=BlogPostStub::class,
@@ -51,7 +54,8 @@
                 foreign_key="id",
            )
         },
-        property="previous_blog_post"
+        property="previous_blog_post",
+        lazy=InnerJoin::IS_LAZY
  * )
  * @InnerJoin(
         entity=BlogPostStub::class,
@@ -61,7 +65,8 @@
                 foreign_key="id",
             )
         },
-        property="next_blog_post"
+        property="next_blog_post",
+       lazy=InnerJoin::IS_NOT_LAZY
  * )
  */
 class BlogPostStub implements EntityInterface