From 30f0a2b134ea2a24d2e19932f4894d655c4a58e3 Mon Sep 17 00:00:00 2001
From: "j.stein" <joristein@gmail.com>
Date: Tue, 18 Jan 2022 18:19:40 +0100
Subject: [PATCH] Add readied events

---
 assets/TenancyServiceProvider.stub.php |  6 ++++++
 src/Database/Concerns/WithReadied.php  | 13 ++++++++++++-
 src/Events/PullingReadiedTenant.php    |  9 +++++++++
 src/Events/ReadiedTenantPulled.php     |  9 +++++++++
 src/Events/ReadyingTenant.php          |  9 +++++++++
 src/Events/TenantReadied.php           |  9 +++++++++
 tests/ReadiedTenantsTest.php           | 26 ++++++++++++++++++++++++++
 7 files changed, 80 insertions(+), 1 deletion(-)
 create mode 100644 src/Events/PullingReadiedTenant.php
 create mode 100644 src/Events/ReadiedTenantPulled.php
 create mode 100644 src/Events/ReadyingTenant.php
 create mode 100644 src/Events/TenantReadied.php

diff --git a/assets/TenancyServiceProvider.stub.php b/assets/TenancyServiceProvider.stub.php
index 1d15f418..c2fcdd94 100644
--- a/assets/TenancyServiceProvider.stub.php
+++ b/assets/TenancyServiceProvider.stub.php
@@ -49,6 +49,12 @@ class TenancyServiceProvider extends ServiceProvider
                 })->shouldBeQueued(false), // `false` by default, but you probably want to make this `true` for production.
             ],
 
+            // Readied events
+            Events\ReadyingTenant::class => [],
+            Events\TenantReadied::class => [],
+            Events\PullingReadiedTenant::class => [],
+            Events\ReadiedTenantPulled::class => [],
+
             // Domain events
             Events\CreatingDomain::class => [],
             Events\DomainCreated::class => [],
diff --git a/src/Database/Concerns/WithReadied.php b/src/Database/Concerns/WithReadied.php
index 96dc689c..d8397405 100644
--- a/src/Database/Concerns/WithReadied.php
+++ b/src/Database/Concerns/WithReadied.php
@@ -4,8 +4,11 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Database\Concerns;
 
-use Carbon\Carbon;
 use Stancl\Tenancy\Contracts\Tenant;
+use Stancl\Tenancy\Events\PullingReadiedTenant;
+use Stancl\Tenancy\Events\ReadiedTenantPulled;
+use Stancl\Tenancy\Events\ReadyingTenant;
+use Stancl\Tenancy\Events\TenantReadied;
 
 /**
  * @property null|Carbon $readied
@@ -51,11 +54,15 @@ trait WithReadied
     {
         $tenant = static::create($attributes);
 
+        event(new ReadyingTenant($tenant));
+
         // We add the readied value only after the model has then been created.
         // this ensures the model is not marked as readied until the migrations, seeders, etc. are done
         $tenant->update([
             'readied' => now()->timestamp
         ]);
+
+        event(new TenantReadied($tenant));
     }
 
     public static function pullReadiedTenant(bool $firstOrCreate = false): ?Tenant
@@ -70,10 +77,14 @@ trait WithReadied
         // At this point we can guarantee a readied tenant is free and can be called
         $tenant = static::onlyReadied()->first();
 
+        event(new PullingReadiedTenant($tenant));
+
         $tenant->update([
             'readied' => null
         ]);
 
+        event(new ReadiedTenantPulled($tenant));
+
         return $tenant;
     }
 }
diff --git a/src/Events/PullingReadiedTenant.php b/src/Events/PullingReadiedTenant.php
new file mode 100644
index 00000000..fd71b21f
--- /dev/null
+++ b/src/Events/PullingReadiedTenant.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Events;
+
+class PullingReadiedTenant extends Contracts\TenantEvent
+{
+}
diff --git a/src/Events/ReadiedTenantPulled.php b/src/Events/ReadiedTenantPulled.php
new file mode 100644
index 00000000..5bced1e3
--- /dev/null
+++ b/src/Events/ReadiedTenantPulled.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Events;
+
+class ReadiedTenantPulled extends Contracts\TenantEvent
+{
+}
diff --git a/src/Events/ReadyingTenant.php b/src/Events/ReadyingTenant.php
new file mode 100644
index 00000000..3e10a05f
--- /dev/null
+++ b/src/Events/ReadyingTenant.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Events;
+
+class ReadyingTenant extends Contracts\TenantEvent
+{
+}
diff --git a/src/Events/TenantReadied.php b/src/Events/TenantReadied.php
new file mode 100644
index 00000000..526d3514
--- /dev/null
+++ b/src/Events/TenantReadied.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Events;
+
+class TenantReadied extends Contracts\TenantEvent
+{
+}
diff --git a/tests/ReadiedTenantsTest.php b/tests/ReadiedTenantsTest.php
index 70e439d4..2abc7d08 100644
--- a/tests/ReadiedTenantsTest.php
+++ b/tests/ReadiedTenantsTest.php
@@ -5,8 +5,13 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Tests;
 
 use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Event;
 use Stancl\Tenancy\Commands\ClearReadiedTenants;
 use Stancl\Tenancy\Commands\CreateReadiedTenants;
+use Stancl\Tenancy\Events\PullingReadiedTenant;
+use Stancl\Tenancy\Events\ReadiedTenantPulled;
+use Stancl\Tenancy\Events\ReadyingTenant;
+use Stancl\Tenancy\Events\TenantReadied;
 use Stancl\Tenancy\Tests\Etc\Tenant;
 
 class ReadiedTenantsTest extends TestCase
@@ -127,4 +132,25 @@ class ReadiedTenantsTest extends TestCase
         $this->assertCount(1, Tenant::all());
         Tenant::all();
     }
+
+    /** @test */
+    public function readied_events_are_triggerred()
+    {
+        Event::fake([
+            ReadyingTenant::class,
+            TenantReadied::class,
+            PullingReadiedTenant::class,
+            ReadiedTenantPulled::class,
+        ]);
+
+        Tenant::createReadied();
+
+        Event::assertDispatched(ReadyingTenant::class);
+        Event::assertDispatched(TenantReadied::class);
+
+        Tenant::pullReadiedTenant();
+
+        Event::assertDispatched(PullingReadiedTenant::class);
+        Event::assertDispatched(ReadiedTenantPulled::class);
+    }
 }