Merge pull request #34 from lapaliv/develop

Added method `Bulk::withTrashed()`
lapaliv · Jun 4, 2023 · 1944084 · 1944084
2 parents f1839ae + 9c52cf3
commit 1944084
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -528,6 +528,13 @@ class Bulk {
      */
     public function updateAllExcept(array $attributes): static;
 
+    /**
+     * Enables soft deleted rows into select.
+     * 
+     * @return $this
+     */
+    public function withTrashed(): static;
+
     /**
      * Creates the rows.
      * @param iterable<int|string, Model|stdClass|array<string, mixed>|object> $rows

diff --git a/src/Bulk.php b/src/Bulk.php
@@ -95,6 +95,7 @@ class Bulk
      * @var string[]
      */
     private array $updateExcept = [];
+    private bool $withTrashed = false;
 
     /**
      * @param class-string<TModel>|TModel $model
@@ -642,6 +643,18 @@ public function saveAccumulated(): static
             ->upsertAccumulated();
     }
 
+    /**
+     * Adds soft deleted rows to queries.
+     *
+     * @return $this
+     */
+    public function withTrashed(): static
+    {
+        $this->withTrashed = true;
+
+        return $this;
+    }
+
     /**
      * Accumulates the rows to the storage.
      *
@@ -865,6 +878,7 @@ private function runUpdateScenario(BulkAccumulationEntity $accumulation, array $
                 $this->getDateFields(),
                 $this->getSelectColumns($columns, $accumulation->uniqueBy),
                 $this->getDeletedAtColumn(),
+                $this->withTrashed,
             );
 
             unset($scenario);
@@ -899,6 +913,7 @@ private function runUpsertScenario(BulkAccumulationEntity $accumulation, array $
                 $this->getDateFields(),
                 $this->getSelectColumns($columns, $accumulation->uniqueBy),
                 $this->getDeletedAtColumn(),
+                $this->withTrashed,
             );
 
             unset($scenario);

diff --git a/src/Features/MarkNonexistentRowsAsSkippedFeature.php b/src/Features/MarkNonexistentRowsAsSkippedFeature.php
@@ -24,6 +24,7 @@ public function handle(
         BulkAccumulationEntity $data,
         array $selectColumns,
         ?string $deletedAtColumn,
+        bool $withTrashed,
     ): void {
         $nonexistent = new BulkAccumulationEntity($data->uniqueBy);
 
@@ -43,6 +44,7 @@ public function handle(
                     $data->uniqueBy,
                     $selectColumns,
                     $deletedAtColumn,
+                    $withTrashed,
                 )
             );
         }

diff --git a/src/Features/SelectExistingRowsFeature.php b/src/Features/SelectExistingRowsFeature.php
@@ -22,12 +22,13 @@ public function handle(
         array $uniqueBy,
         array $selectColumns,
         ?string $deletedAtColumn = null,
+        bool $withTrashed = false,
     ): Collection {
         $builder = $eloquent->newQuery()
             ->select($selectColumns)
             ->limit($collection->count());
 
-        if ($deletedAtColumn !== null) {
+        if ($withTrashed && $deletedAtColumn !== null) {
             call_user_func([$builder, 'withTrashed']);
         }
 

diff --git a/src/Scenarios/CreateScenario.php b/src/Scenarios/CreateScenario.php
@@ -23,6 +23,8 @@
  */
 class CreateScenario
 {
+    private bool $hasDeletingRows = false;
+
     public function __construct(
         private GetInsertBuilderFeature $getInsertBuilderFeature,
         private BulkDriverManager $driverManager,
@@ -112,7 +114,8 @@ public function handle(
                 $data->getNotSkippedModels('skipCreating'),
                 $data->uniqueBy,
                 $selectColumns,
-                $deletedAtColumn
+                $deletedAtColumn,
+                withTrashed: $this->hasDeletingRows,
             );
         }
 
@@ -220,6 +223,8 @@ private function dispatchDeletingEvents(
         BulkEventDispatcher $eventDispatcher,
         string $deletedAtColumn
     ): void {
+        $this->hasDeletingRows = false;
+
         if (!$eventDispatcher->hasListeners(BulkEventEnum::delete())) {
             return;
         }
@@ -237,6 +242,7 @@ private function dispatchDeletingEvents(
             }
 
             $accumulatedRow->isDeleting = true;
+            $this->hasDeletingRows = true;
 
             if ($eventDispatcher->dispatch(BulkEventEnum::DELETING, $accumulatedRow->model) === false) {
                 $accumulatedRow->skipDeleting = true;
@@ -304,6 +310,9 @@ function (Model $model) use ($data): string {
                 ) {
                     $row->model->wasRecentlyCreated = $startedAt < $existingRow->getAttribute($createdAtColumn);
                 }
+            } else {
+                $row->skipSaving = true;
+                $row->skipCreating = true;
             }
         }
     }

diff --git a/src/Scenarios/UpdateScenario.php b/src/Scenarios/UpdateScenario.php
@@ -34,12 +34,13 @@ public function handle(
         array $dateFields,
         array $selectColumns,
         ?string $deletedAtColumn,
+        bool $withTrashed,
     ): void {
         if (empty($data->rows)) {
             return;
         }
 
-        $this->markNonexistentRowsAsSkipped->handle($eloquent, $data, $selectColumns, $deletedAtColumn);
+        $this->markNonexistentRowsAsSkipped->handle($eloquent, $data, $selectColumns, $deletedAtColumn, $withTrashed);
 
         if ($eventDispatcher->hasListeners(BulkEventEnum::saving())
             || $eventDispatcher->hasListeners(BulkEventEnum::updating())

diff --git a/src/Scenarios/UpsertScenario.php b/src/Scenarios/UpsertScenario.php
@@ -27,12 +27,13 @@ public function handle(
         array $dateFields,
         array $selectColumns,
         ?string $deletedAtColumn,
+        bool $withTrashed,
     ): void {
         if (empty($data->rows)) {
             return;
         }
 
-        $this->markNonexistentRowsAsSkipped->handle($eloquent, $data, $selectColumns, $deletedAtColumn);
+        $this->markNonexistentRowsAsSkipped->handle($eloquent, $data, $selectColumns, $deletedAtColumn, $withTrashed);
 
         $this->create($eloquent, $data, $eventDispatcher, $dateFields, $selectColumns, $deletedAtColumn);
 
@@ -43,6 +44,7 @@ public function handle(
             $dateFields,
             $selectColumns,
             $deletedAtColumn,
+            $withTrashed
         );
     }
 

diff --git a/tests/Unit/Bulk/Create/CreateBeforeWritingEventDependenciesTest.php b/tests/Unit/Bulk/Create/CreateBeforeWritingEventDependenciesTest.php
@@ -29,7 +29,7 @@ final class CreateBeforeWritingEventDependenciesTest extends TestCase
     use UserTestTrait;
 
     /**
-     * When one of model events sometimes returns false then its dependencies have not been called.
+     * When one of model's events return false then its dependencies have not been called.
      *
      * @param class-string<User> $model
      * @param Closure $data

diff --git a/tests/Unit/Bulk/Update/UpdateBeforeWritingEventDependenciesTest.php b/tests/Unit/Bulk/Update/UpdateBeforeWritingEventDependenciesTest.php
@@ -70,6 +70,7 @@ public function testModelEventReturnsFalseSometimes(
 
         $sut = $model::query()
             ->bulk()
+            ->withTrashed()
             ->uniqueBy(['id']);
 
         // act
@@ -143,6 +144,7 @@ public function testModelEventReturnsFalseAlways(
 
         $sut = $model::query()
             ->bulk()
+            ->withTrashed()
             ->uniqueBy(['id']);
 
         // act
@@ -200,6 +202,7 @@ public function testCollectionEventReturnsFalse(
 
         $sut = $model::query()
             ->bulk()
+            ->withTrashed()
             ->uniqueBy(['id']);
 
         // act