Add readied tenants

Add config for readied tenants
Add `create` and `clear` command
Add Readied scope and static functions
Add tests

src/Database/Concerns/ReadiedScope.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Concerns;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Scope;
+
+class ReadiedScope implements Scope
+{
+
+    /**
+     * All of the extensions to be added to the builder.
+     *
+     * @var string[]
+     */
+    protected $extensions = ['WithReadied', 'WithoutReadied', 'OnlyReadied'];
+
+    /**
+     * Apply the scope to a given Eloquent query builder.
+     *
+     * @param  Builder  $builder
+     * @param  Model  $model
+     * @return void
+     */
+    public function apply(Builder $builder, Model $model)
+    {
+        $builder->when(!config('tenancy.readied.include_in_scope'), function (Builder $builder){
+            $builder->whereNull('data->readied');
+        });
+    }
+
+    /**
+     * Extend the query builder with the needed functions.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    public function extend(Builder $builder)
+    {
+        foreach ($this->extensions as $extension) {
+            $this->{"add{$extension}"}($builder);
+        }
+    }
+    /**
+     * Add the with-readied extension to the builder.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    protected function addWithReadied(Builder $builder)
+    {
+        $builder->macro('withReadied', function (Builder $builder, $withReadied = true) {
+            if (! $withReadied) {
+                return $builder->withoutReadied();
+            }
+
+            return $builder->withoutGlobalScope($this);
+        });
+    }
+
+    /**
+     * Add the without-readied extension to the builder.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    protected function addWithoutReadied(Builder $builder)
+    {
+        $builder->macro('withoutReadied', function (Builder $builder) {
+
+            $builder->withoutGlobalScope($this)->whereNull('data->readied');
+
+            return $builder;
+        });
+    }
+
+    /**
+     * Add the only-readied extension to the builder.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    protected function addOnlyReadied(Builder $builder)
+    {
+        $builder->macro('onlyReadied', function (Builder $builder) {
+
+            $builder->withoutGlobalScope($this)->whereNotNull('data->readied');
+
+            return $builder;
+        });
+    }
+}

src/Database/Concerns/WithReadied.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Concerns;
+
+use Carbon\Carbon;
+use Stancl\Tenancy\Contracts\Tenant;
+
+/**
+ * @property null|Carbon $readied
+ *
+ * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder withReadied(bool $withReadied = true)
+ * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder onlyReadied()
+ * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder withoutReadied()
+ */
+trait WithReadied
+{
+    /**
+     * Boot the readied trait for a model.
+     *
+     * @return void
+     */
+    public static function bootWithReadied()
+    {
+        static::addGlobalScope(new ReadiedScope());
+    }
+
+    /**
+     * Initialize the readied trait for an instance.
+     *
+     * @return void
+     */
+    public function initializeSoftDeletes()
+    {
+        $this->casts['readied'] = 'datetime';
+    }
+
+
+    /**
+     * Determine if the model instance is in a readied state.
+     *
+     * @return bool
+     */
+    public function readied()
+    {
+        return !is_null($this->readied);
+    }
+
+    public static function createReadied($attributes = []): void
+    {
+        $tenant = static::create($attributes);
+
+        // 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
+        ]);
+    }
+
+    public static function pullReadiedTenant(bool $firstOrCreate = false): ?Tenant
+    {
+        if (!static::onlyReadied()->exists()) {
+            if (!$firstOrCreate) {
+                return null;
+            }
+            static::createReadied();
+        }
+
+        // At this point we can guarantee a readied tenant is free and can be called
+        $tenant = static::onlyReadied()->first();
+
+        $tenant->update([
+            'readied' => null
+        ]);
+
+        return $tenant;
+    }
+}

src/Database/Models/Tenant.php

@@ -26,7 +26,8 @@ class Tenant extends Model implements Contracts\Tenant
         Concerns\HasDataColumn,
         Concerns\HasInternalKeys,
         Concerns\TenantRun,
-        Concerns\InvalidatesResolverCache;
+        Concerns\InvalidatesResolverCache,
+        Concerns\WithReadied;
 
     protected $table = 'tenants';
     protected $primaryKey = 'id';