refact: improve queryBuilder

leroy-merlin-br · Aug 25, 2023 · d13b7a0 · d13b7a0
1 parent 2d86b5c
commit d13b7a0
Show file tree

Hide file tree

Showing 7 changed files with 212 additions and 114 deletions.
diff --git a/src/DataMapper/DataMapper.php b/src/DataMapper/DataMapper.php
@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use MongoDB\Collection;
+use Mongolid\Connection\Connection;
 use Mongolid\Container\Container;
 use Mongolid\Cursor\CursorInterface;
 use Mongolid\Cursor\EagerLoadedCursor;
@@ -12,10 +13,9 @@
 use Mongolid\Event\EventTriggerService;
 use Mongolid\Model\Exception\ModelNotFoundException;
 use Mongolid\Model\ModelInterface;
+use Mongolid\Query\Resolver;
 use Mongolid\Schema\HasSchemaInterface;
 use Mongolid\Schema\Schema;
-use Mongolid\Connection\Connection;
-Use Mongolid\Util\QueryBuilder;
 
 /**
  * The DataMapper class will abstract how an Entity is persisted and retrieved
@@ -25,7 +25,7 @@
  */
 class DataMapper implements HasSchemaInterface
 {
-    public bool $withTrashed = false;
+    private bool $ignoreSoftDelete = false;
 
     /**
      * Name of the schema class to be used.
@@ -261,9 +261,11 @@ public function where(
 
         $model = new $this->schema->entityClass;
 
-        $query = $this->withTrashed ?
-            QueryBuilder::prepareValueForQueryCompatibility($query) :
-            QueryBuilder::prepareValueForSoftDeleteCompatibility($query, $model);
+        $query = Resolver::resolveQuery(
+            $query,
+            $model,
+            $this->ignoreSoftDelete
+        );
 
         return new $cursorClass(
             $this->schema,
@@ -309,8 +311,13 @@ public function first(
 
         $model = new $this->schema->entityClass;
 
+        $query = Resolver::resolveQuery(
+            $query,
+            $model,
+        );
+
         $document = $this->getCollection()->findOne(
-            QueryBuilder::prepareValueForSoftDeleteCompatibility($query, $model),
+            $query,
             ['projection' => $this->prepareProjection($projection)]
         );
 
@@ -347,6 +354,13 @@ public function firstOrFail(
         throw (new ModelNotFoundException())->setModel($this->schema->entityClass);
     }
 
+    public function withoutSoftDelete(): self
+    {
+        $this->ignoreSoftDelete = true;
+
+        return $this;
+    }
+
     /**
      * Parses an object with SchemaMapper and the given Schema.
      *

diff --git a/src/Model/SoftDeleteTrait.php b/src/Model/SoftDeleteTrait.php
@@ -5,20 +5,20 @@
 use DateTime;
 use MongoDB\BSON\UTCDateTime;
 use Mongolid\Cursor\CursorInterface;
-use Mongolid\Util\QueryBuilder;
+use Mongolid\Query\Resolver;
 
 trait SoftDeleteTrait
 {
     public bool $isSoftDeleteEnabled = true;
 
     public function isTrashed(): bool
     {
-        return !is_null($this->{QueryBuilder::getDeletedAtColumn($this)});
+        return !is_null($this->{Resolver::getDeletedAtColumn($this)});
     }
 
     public function restore(): bool
     {
-        $collumn = QueryBuilder::getDeletedAtColumn($this);
+        $collumn = Resolver::getDeletedAtColumn($this);
 
         if (!$this->isTrashed()) {
             return false;
@@ -36,7 +36,7 @@ public function forceDelete(): bool
 
     public function executeSoftDelete(): bool
     {
-        $deletedAtColumn = QueryBuilder::getDeletedAtColumn($this);
+        $deletedAtColumn = Resolver::getDeletedAtColumn($this);
         $this->$deletedAtColumn = new UTCDateTime(new DateTime('now'));
 
         return $this->update();
@@ -52,25 +52,16 @@ public static function withTrashed(
 
     private static function searchWithDataMapper(mixed $query, array $projection, bool $useCache): CursorInterface
     {
-        $mapper = self::getDataMapperInstance();
-
-        $mapper->withTrashed = true;
-
-        return $mapper->where($query, $projection, $useCache);
+        return self::getDataMapperInstance()
+            ->withoutSoftDelete()
+            ->where($query, $projection, $useCache);
     }
 
     private static function searchWithBuilder(mixed $query, array $projection, bool $useCache): CursorInterface
     {
-        $mapper = self::getBuilderInstance();
-
-        $mapper->withTrashed = true;
-
-        return $mapper->where(
-            new static(),
-            $query,
-            $projection,
-            $useCache
-        );
+        return self::getBuilderInstance()
+            ->withoutSoftDelete()
+            ->where(new static(), $query, $projection, $useCache);
     }
 
     private static function performSearch(mixed $query, array $projection, bool $useCache): CursorInterface

diff --git a/src/Query/Builder.php b/src/Query/Builder.php
@@ -11,16 +11,14 @@
 use Mongolid\Event\EventTriggerService;
 use Mongolid\Model\Exception\ModelNotFoundException;
 use Mongolid\Model\ModelInterface;
-use Mongolid\Util\ObjectIdUtils;
-use Mongolid\Util\QueryBuilder;
 
 /**
  * This class will abstract how a Model is persisted and retrieved
  * from the database.
  */
 class Builder
 {
-    public bool $withTrashed = false;
+    private bool $ignoreSoftDelete = false;
 
     /**
      * Connection that is going to be used to interact with the database.
@@ -205,10 +203,11 @@ public function where(ModelInterface $model, $query = [], array $projection = []
     {
         $cursor = $useCache ? CacheableCursor::class : Cursor::class;
 
-        $query = $this->withTrashed ?
-            QueryBuilder::prepareValueForQueryCompatibility($query) :
-            QueryBuilder::prepareValueForSoftDeleteCompatibility($query, $model);
-
+        $query = Resolver::resolveQuery(
+            $query,
+            $model,
+            $this->ignoreSoftDelete
+        );
         return new $cursor(
             $model->getCollection(),
             'find',
@@ -252,8 +251,13 @@ public function first(ModelInterface $model, $query = [], array $projection = []
             return $this->where($model, $query, $projection, $useCache)->first();
         }
 
+        $query = Resolver::resolveQuery(
+            $query,
+            $model,
+        );
+
         return $model->getCollection()->findOne(
-            QueryBuilder::prepareValueForSoftDeleteCompatibility($query, $model),
+            $query,
             ['projection' => $this->prepareProjection($projection)],
         );
     }
@@ -280,6 +284,13 @@ public function firstOrFail(ModelInterface $model, $query = [], array $projectio
         throw (new ModelNotFoundException())->setModel(get_class($model));
     }
 
+    public function withoutSoftDelete(): self
+    {
+        $this->ignoreSoftDelete = true;
+
+        return $this;
+    }
+
     /**
      * Triggers an event. May return if that event had success.
      *

diff --git a/src/Util/QueryBuilder.php → src/Query/Resolver.php b/src/Util/QueryBuilder.php → src/Query/Resolver.php
@@ -1,15 +1,24 @@
 <?php
 
-namespace Mongolid\Util;
+namespace Mongolid\Query;
 
 use MongoDB\BSON\ObjectId;
 use Mongolid\Model\ModelInterface;
+use Mongolid\Util\ObjectIdUtils;
 
-class QueryBuilder
+class Resolver
 {
-    public static function prepareValueForSoftDeleteCompatibility(mixed $query, ModelInterface $model): array
+    public static function resolveQuery(mixed $query, ModelInterface $model, bool $ignoreSoftDelete = false): array
     {
-        $query = self::prepareValueForQueryCompatibility($query);
+        $query = self::prepareIdForQueryCompatibility($query);
+
+        if (!$model->isSoftDeleteEnabled ?? false) {
+            return $query;
+        }
+
+        if ($ignoreSoftDelete) {
+            return $query;
+        }
 
         return self::addSoftDeleteFilterIfRequired($query, $model);
     }
@@ -23,7 +32,7 @@ public static function getDeletedAtColumn(ModelInterface $model): string
             : 'deleted_at';
     }
 
-    public static function prepareValueForQueryCompatibility(mixed $query): array
+    private static function prepareIdForQueryCompatibility(mixed $query): array
     {
         if (!is_array($query)) {
             $query = ['_id' => $query];
@@ -49,18 +58,14 @@ public static function prepareValueForQueryCompatibility(mixed $query): array
 
     private static function addSoftDeleteFilterIfRequired(array $query, ModelInterface $model): array
     {
-        if ($model->isSoftDeleteEnabled) {
-            $field = self::getDeletedAtColumn($model);
-
-            return array_merge(
-                $query,
-                [
-                    $field => ['$exists' => false],
-                ]
-            );
-        }
-
-        return $query;
+        $field = self::getDeletedAtColumn($model);
+
+        return array_merge(
+            $query,
+            [
+                $field => ['$exists' => false],
+            ]
+        );
     }
 
     private static function convertStringIdsToObjectIds(array $query): array

diff --git a/tests/Integration/PersistLegacyModelWithSoftDeleteTest.php b/tests/Integration/PersistLegacyModelWithSoftDeleteTest.php
@@ -10,8 +10,6 @@
 
 final class PersistLegacyModelWithSoftDeleteTest extends IntegrationTestCase
 {
-    private ObjectId $_id;
-
     public function testShouldFindUndeletedProduct(): void
     {
         // Set