feat: add withTrashed

src/DataMapper/DataMapper.php

@@ -4,7 +4,6 @@
 
 use DateTime;
 use InvalidArgumentException;
-use MongoDB\BSON\ObjectId;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Collection;
 use Mongolid\Container\Container;
@@ -17,9 +16,8 @@
 use Mongolid\Model\ModelInterface;
 use Mongolid\Schema\HasSchemaInterface;
 use Mongolid\Schema\Schema;
-use Mongolid\Util\ObjectIdUtils;
 use Mongolid\Connection\Connection;
-Use Mongolid\Util\SoftDeleteQueries;
+Use Mongolid\Util\QueryBuilder;
 
 /**
  * The DataMapper class will abstract how an Entity is persisted and retrieved
@@ -267,14 +265,13 @@ public function where(
         $cursorClass = $cacheable ? SchemaCacheableCursor::class : SchemaCursor::class;
 
         $model = new $this->schema->entityClass;
-        $query =   $this->prepareValueQuery($query);
 
         return new $cursorClass(
             $this->schema,
             $this->getCollection(),
             'find',
             [
-                SoftDeleteQueries::insertFilterForSoftDelete($query, $model),
+                QueryBuilder::resolveQuery($query, $model),
                 [
                     'projection' => $this->prepareProjection($projection),
                     'eagerLoads' => $model->with ?? [],
@@ -312,10 +309,9 @@ public function first(
         }
 
         $model = new $this->schema->entityClass;
-        $query =   $this->prepareValueQuery($query);
 
         $document = $this->getCollection()->findOne(
-            SoftDeleteQueries::insertFilterForSoftDelete($query, $model),
+            QueryBuilder::resolveQuery($query, $model),
             ['projection' => $this->prepareProjection($projection)]
         );
 
@@ -406,62 +402,6 @@ public function getCollection(): Collection
         return $collection;
     }
 
-    /**
-     * Transforms a value that is not an array into an MongoDB query (array).
-     * This method will take care of converting a single value into a query for
-     * an _id, including when a objectId is passed as a string.
-     *
-     * @param mixed $value the _id of the document
-     *
-     * @return array Query for the given _id
-     */
-    protected function prepareValueQuery($value): array
-    {
-        if (!is_array($value)) {
-            $value = ['_id' => $value];
-        }
-
-        if (isset($value['_id']) &&
-            is_string($value['_id']) &&
-            ObjectIdUtils::isObjectId($value['_id'])
-        ) {
-            $value['_id'] = new ObjectId($value['_id']);
-        }
-
-        if (isset($value['_id']) &&
-            is_array($value['_id'])
-        ) {
-            $value['_id'] = $this->prepareArrayFieldOfQuery($value['_id']);
-        }
-
-        return $value;
-    }
-
-    /**
-     * Prepares an embedded array of an query. It will convert string ObjectIds
-     * in operators into actual objects.
-     *
-     * @param array $value array that will be treated
-     *
-     * @return array prepared array
-     */
-    protected function prepareArrayFieldOfQuery(array $value): array
-    {
-        foreach (['$in', '$nin'] as $operator) {
-            if (isset($value[$operator]) &&
-                is_array($value[$operator])
-            ) {
-                foreach ($value[$operator] as $index => $id) {
-                    if (ObjectIdUtils::isObjectId($id)) {
-                        $value[$operator][$index] = new ObjectId($id);
-                    }
-                }
-            }
-        }
-
-        return $value;
-    }
-
     /**
      * Retrieves an EntityAssembler instance.
      *
@@ -680,7 +620,7 @@ function ($value) {
 
     private function executeSoftDelete(ModelInterface $entity, $options): bool
     {
-        $deletedAtCoullum = SoftDeleteQueries::getDeletedAtColumn($entity);
+        $deletedAtCoullum = QueryBuilder::getDeletedAtColumn($entity);
         $entity->$deletedAtCoullum = new UTCDateTime(new DateTime('now'));
 
         return $this->update($entity, $options);

src/Model/SoftDeletesTrait.php

@@ -2,18 +2,21 @@
 
 namespace Mongolid\Model;
 
+use Mongolid\Cursor\CursorInterface;
+use Mongolid\Util\QueryBuilder;
+
 trait SoftDeletesTrait
 {
     public $enabledSoftDeletes = true;
 
     public function isTrashed(): bool
     {
-        return !is_null($this->{$this->getDeletedAtColumn()});
+        return !is_null($this->{ self::getDeletedAtColumn()});
     }
 
     public function restore(): bool
     {
-        $collumn = $this->getDeletedAtColumn();
+        $collumn = self::getDeletedAtColumn();
 
         if (!$this->{$collumn}) {
             return false;
@@ -31,7 +34,20 @@ public function forceDelete(): bool
         return $this->execute('delete');
     }
 
-    private function getDeletedAtColumn(): string
+    public static function withTrashed(
+        array $query = [],
+        array $projection = [],
+        bool $useCache = false
+    ): CursorInterface {
+        $query = QueryBuilder::prepareValueQuery($query);
+        $query = array_merge($query, [
+            'withTrashed' => true,
+        ]);
+
+        return parent::where($query, $projection, $useCache);
+    }
+
+    private static function getDeletedAtColumn(): string
     {
         return defined(
             static::class . '::DELETED_AT'

src/Util/QueryBuilder.php

@@ -0,0 +1,109 @@
+<?php
+
+namespace Mongolid\Util;
+
+use MongoDB\BSON\ObjectId;
+use Mongolid\Model\ModelInterface;
+
+class QueryBuilder
+{
+    public static function resolveQuery($query, ModelInterface $model): array
+    {
+        $query = self::prepareValueQuery($query);
+
+        return self::addSoftDeleteFilterIfRequired($query, $model);
+    }
+
+    public static function getDeletedAtColumn(ModelInterface $model): string
+    {
+        return defined(
+            $model::class . '::DELETED_AT'
+        )
+            ? $model::DELETED_AT
+            : 'deleted_at';
+    }
+
+    /**
+     * Transforms a value that is not an array into an MongoDB query (array).
+     * This method will take care of converting a single value into a query for
+     * an _id, including when a objectId is passed as a string.
+     *
+     * @param mixed $value the _id of the document
+     *
+     * @return array Query for the given _id
+     */
+    public static function prepareValueQuery($value): array
+    {
+        if (!is_array($value)) {
+            $value = ['_id' => $value];
+        }
+
+        if (
+            isset($value['_id']) &&
+            is_string($value['_id']) &&
+            ObjectIdUtils::isObjectId($value['_id'])
+        ) {
+            $value['_id'] = new ObjectId($value['_id']);
+        }
+
+        if (
+            isset($value['_id']) &&
+            is_array($value['_id'])
+        ) {
+            $value['_id'] = self::prepareArrayFieldOfQuery($value['_id']);
+        }
+
+        return $value;
+    }
+
+    private static function addSoftDeleteFilterIfRequired(array $query, ModelInterface $model): array
+    {
+        $field = self::getDeletedAtColumn($model);
+
+        if (isset($query['withTrashed'])) {
+            unset($query['withTrashed']);
+
+            return $query;
+        }
+
+        return array_merge(
+            $query,
+            [
+                '$or' => [
+                    [
+                        $field => null,
+                    ],
+                    [
+                        $field => ['$exists' => false],
+                    ],
+                ],
+            ]
+        );
+    }
+
+    /**
+     * Prepares an embedded array of an query. It will convert string ObjectIds
+     * in operators into actual objects.
+     *
+     * @param array $value array that will be treated
+     *
+     * @return array prepared array
+     */
+    private static function prepareArrayFieldOfQuery(array $value): array
+    {
+        foreach (['$in', '$nin'] as $operator) {
+            if (
+                isset($value[$operator]) &&
+                is_array($value[$operator])
+            ) {
+                foreach ($value[$operator] as $index => $id) {
+                    if (ObjectIdUtils::isObjectId($id)) {
+                        $value[$operator][$index] = new ObjectId($id);
+                    }
+                }
+            }
+        }
+
+        return $value;
+    }
+}