Merge pull request #30 from tipoff/pdbreen/feature/scope-by-status

Add scopeByStatus to HasStatuses trait
TIPOFF · Mar 10, 2021 · 93b369d · 93b369d
2 parents 6e8adda + 85cee3f
commit 93b369d
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 1 deletion.
diff --git a/src/StatusesServiceProvider.php b/src/StatusesServiceProvider.php
@@ -6,8 +6,8 @@
 
 use Tipoff\Statuses\Models\Status;
 use Tipoff\Statuses\Models\StatusRecord;
-use Tipoff\Statuses\Policies\StatusRecordPolicy;
 use Tipoff\Statuses\Policies\StatusPolicy;
+use Tipoff\Statuses\Policies\StatusRecordPolicy;
 use Tipoff\Support\TipoffPackage;
 use Tipoff\Support\TipoffServiceProvider;
 

diff --git a/src/Traits/HasStatuses.php b/src/Traits/HasStatuses.php
@@ -4,6 +4,7 @@
 
 namespace Tipoff\Statuses\Traits;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Collection;
 use Tipoff\Statuses\Exceptions\UnknownStatusException;
 use Tipoff\Statuses\Models\Status;
@@ -18,6 +19,22 @@ trait HasStatuses
     // When false, exception occurs if unknown status value is used
     protected bool $dynamicStatusCreation = false;
 
+    /**
+     * Return all records whose current/latest status value matches the status provided
+     */
+    public function scopeByStatus(Builder $query, Status $status): Builder
+    {
+        return $query->whereHas('statusRecords', function ($query) use ($status) {
+            $query->where('id', function ($sub) use ($status) {
+                $sub->from('status_records')
+                    ->selectRaw('max(id)')
+                    ->whereColumn('statusable_type', $this->getMorphClass())
+                    ->whereColumn('statusable_id', $this->getTable() . '.' . $this->getKeyName())
+                    ->whereColumn('type', $status->type);
+            })->where('status_id', $status->id);
+        });
+    }
+
     public function getStatusHistory(?string $type = null): Collection
     {
         return $this->statusRecords()

diff --git a/tests/Unit/Traits/HasStatusesTest.php b/tests/Unit/Traits/HasStatusesTest.php
@@ -120,6 +120,36 @@ public function get_status_history()
         $this->assertEquals(['2', '3', '2', '3'], $history);
     }
 
+    /** @test */
+    public function scope_by_status()
+    {
+        TestModel::createTable();
+
+        $this->actingAs(User::factory()->create());
+
+        Status::publishStatuses('type', ['1', '2', '3', '4', '5']);
+
+        TestModel::factory()->count(20)->create()->each(function (TestModel $model, int $idx) {
+            // Generate history
+            $model->setStatus('1', 'type');
+            if ($idx >= 5) {
+                $model->setStatus('2', 'type');
+                if ($idx >= 10) {
+                    $model->setStatus('3', 'type');
+                    if ($idx >= 15) {
+                        $model->setStatus('4', 'type');
+                    }
+                }
+            }
+        });
+
+        $this->assertEquals(5, TestModel::query()->byStatus(Status::findStatus('type', '1'))->count());
+        $this->assertEquals(5, TestModel::query()->byStatus(Status::findStatus('type', '2'))->count());
+        $this->assertEquals(5, TestModel::query()->byStatus(Status::findStatus('type', '3'))->count());
+        $this->assertEquals(5, TestModel::query()->byStatus(Status::findStatus('type', '4'))->count());
+        $this->assertEquals(0, TestModel::query()->byStatus(Status::findStatus('type', '5'))->count());
+    }
+
     /** @test */
     public function set_unknown_status()
     {