Merge pull request #26 from tipoff/pbdreen/feature/has-statuses

Add HasStatuses trait and supporting code
TIPOFF · Mar 10, 2021 · 53e4a51 · 53e4a51
2 parents 42e7500 + 0587533
commit 53e4a51
Show file tree

Hide file tree

Showing 14 changed files with 544 additions and 39 deletions.
diff --git a/database/factories/StatusFactory.php b/database/factories/StatusFactory.php
@@ -6,32 +6,21 @@
 
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Support\Str;
-use Tipoff\Forms\Models\Status;
+use Tipoff\Statuses\Models\Status;
 
 class StatusFactory extends Factory
 {
-    /**
-     * The name of the factory's corresponding model.
-     *
-     * @var string
-     */
     protected $model = Status::class;
 
-    /**
-     * Define the model's default state.
-     *
-     * @return array
-     */
     public function definition()
     {
-        $word1 = $this->faker->unique->word;
-        $word2 = $this->faker->word;
+        $type = $this->faker->randomElement(['order', 'slot', 'game', 'invoice', 'payment']);
+        $words = $this->faker->unique()->words(2, true);
 
         return [
-            'slug' => Str::slug(rand(1, 1000).'-'.$word1.'-'.$word2),
-            'name' => $word1.' '.$word2,
-            'applies_to' => $this->faker->randomElement(['order', 'slot', 'game', 'invoice', 'payment']),
-            'note' => $this->faker->sentences(1, true),
+            'name' => $words,
+            'type' => $type,
+            'note' => $this->faker->optional()->sentences(1, true),
         ];
     }
 }
diff --git a/database/factories/StatusRecordFactory.php b/database/factories/StatusRecordFactory.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Statuses\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Tipoff\Authorization\Models\User;
+use Tipoff\Statuses\Models\Status;
+use Tipoff\Statuses\Models\StatusRecord;
+
+class StatusRecordFactory extends Factory
+{
+    protected $model = StatusRecord::class;
+
+    public function definition()
+    {
+        $statusable = User::factory()->create();
+        $status = randomOrCreate(Status::class);
+
+        return [
+            'status_id' => $status,
+            'type' => $status->type,
+            'statusable_type' => get_class($statusable),
+            'statusable_id' => $statusable->id,
+            'creator_id' => randomOrCreate(app('user')),
+        ];
+    }
+}
diff --git a/database/migrations/2020_05_08_100000_create_statuses_table.php b/database/migrations/2020_05_08_100000_create_statuses_table.php
@@ -13,10 +13,12 @@ public function up()
         Schema::create('statuses', function (Blueprint $table) {
             $table->id();
             $table->string('slug')->unique()->index();
-            $table->string('name')->unique();
-            $table->string('applies_to')->default('order'); // Values include 'order', 'slot', 'game', 'invoice', 'payment'
+            $table->string('name');
+            $table->string('type');     // Typically, full class name for model using status
             $table->text('note')->nullable();
             $table->timestamps();
+
+            $table->unique(['name', 'type']);
         });
     }
 }
diff --git a/...05_08_110000_create_statusables_table.php → ...08_110000_create_status_records_table.php b/...05_08_110000_create_statusables_table.php → ...08_110000_create_status_records_table.php
@@ -6,16 +6,17 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-class CreateStatusablesTable extends Migration
+class CreateStatusRecordsTable extends Migration
 {
     public function up()
     {
-        Schema::create('statusables', function (Blueprint $table) {
+        Schema::create('status_records', function (Blueprint $table) {
             $table->id();
             $table->foreignIdFor(app('status'))->index();
             $table->morphs('statusable');
+            $table->string('type');     // Typically, full class name for model using status
             $table->foreignIdFor(app('user'), 'creator_id');
-            $table->timestamps();
+            $table->timestamp('created_at');
         });
     }
 }
diff --git a/src/Exceptions/StatusException.php b/src/Exceptions/StatusException.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Statuses\Exceptions;
+
+interface StatusException
+{
+}
diff --git a/src/Exceptions/UnknownStatusException.php b/src/Exceptions/UnknownStatusException.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Statuses\Exceptions;
+
+use Throwable;
+
+class UnknownStatusException extends \InvalidArgumentException implements StatusException
+{
+    public function __construct(string $type, string $name, $code = 0, Throwable $previous = null)
+    {
+        parent::__construct("Unknown status value '{$name}' for status type {$type}", $code, $previous);
+    }
+}
diff --git a/src/Models/Status.php b/src/Models/Status.php
@@ -4,12 +4,87 @@
 
 namespace Tipoff\Statuses\Models;
 
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
 use Tipoff\Support\Models\BaseModel;
 use Tipoff\Support\Traits\HasPackageFactory;
 
+/**
+ * @property int id
+ * @property string name
+ * @property string type
+ * @property string slug
+ * @property string note
+ * @property Carbon created_at
+ * @property Carbon updated_at
+ */
 class Status extends BaseModel
 {
     use HasPackageFactory;
 
-    protected $casts = [];
+    protected $casts = [
+        'id' => 'integer',
+    ];
+
+    protected $fillable = [
+        'type',
+        'name',
+    ];
+
+    public static function publishStatuses(string $type, array $names): Collection
+    {
+        return collect($names)
+            ->map(function (string $name) use ($type) {
+                return static::createStatus($type, $name);
+            });
+    }
+
+    public static function createStatus(string $type, string $name, ?string $note = null): self
+    {
+        /** @var Status $status */
+        $status = static::query()->firstOrNew([
+            'type' => $type,
+            'name' => $name,
+        ]);
+
+        if ($note) {
+            $status->note = $note;
+        }
+
+        $status->save();
+
+        return $status;
+    }
+
+    public static function findStatus(string $type, string $name): ?self
+    {
+        /** @var Status $status */
+        $status = static::query()
+            ->byType($type)
+            ->where('name', '=', $name)
+            ->first();
+
+        return $status;
+    }
+
+    protected static function boot()
+    {
+        parent::boot();
+
+        static::creating(function (Status $status) {
+            $status->slug = $status->slug ?: Str::slug("{$status->type}-{$status->name}");
+        });
+    }
+
+    public function scopeByType(Builder $query, string $type): Builder
+    {
+        return $query->where('type', '=', $type);
+    }
+
+    public function __toString()
+    {
+        return $this->name;
+    }
 }
diff --git a/src/Models/StatusRecord.php b/src/Models/StatusRecord.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Statuses\Models;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Model;
+use Tipoff\Authorization\Models\User;
+use Tipoff\Support\Models\BaseModel;
+use Tipoff\Support\Traits\HasCreator;
+use Tipoff\Support\Traits\HasPackageFactory;
+
+/**
+ * @property int id
+ * @property Status status
+ * @property Model statusable
+ * @property User creator
+ * @property Carbon created_at
+ * // Raw Relations
+ * @property int|null creator_id
+ */
+class StatusRecord extends BaseModel
+{
+    use HasPackageFactory;
+    use HasCreator;
+
+    const UPDATED_AT = null;
+
+    protected $casts = [
+        'id' => 'integer',
+        'creator_id' => 'integer',
+    ];
+
+    public function status()
+    {
+        return $this->belongsTo(Status::class);
+    }
+
+    public function statusable()
+    {
+        return $this->morphTo();
+    }
+}
diff --git a/src/Traits/HasStatuses.php b/src/Traits/HasStatuses.php
@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tipoff\Statuses\Traits;
+
+use Illuminate\Support\Collection;
+use Tipoff\Statuses\Exceptions\UnknownStatusException;
+use Tipoff\Statuses\Models\Status;
+use Tipoff\Statuses\Models\StatusRecord;
+
+/**
+ * @property Collection statusables
+ */
+trait HasStatuses
+{
+    // When true, new statuses will be added automatically on first use
+    // When false, exception occurs if unknown status value is used
+    protected bool $dynamicStatusCreation = false;
+
+    public function getStatusHistory(?string $type = null): Collection
+    {
+        return $this->statusRecords()
+            ->where('type', '=', $type ?? get_class($this))
+            ->orderBy('created_at', 'desc')
+            ->orderBy('id', 'desc')
+            ->get();
+    }
+
+    public function getStatus(?string $type = null): ?Status
+    {
+        $statusRecord = $this->getStatusHistory($type)->first();
+
+        return $statusRecord ? $statusRecord->status : null;
+    }
+
+    public function setStatus(string $name, ?string $type = null): Status
+    {
+        $type = $type ?? get_class($this);
+
+        $status = $this->getStatusByName($name, $type);
+
+        // Check if desired status already set
+        if ($currentStatus = $this->getStatus($type)) {
+            if ($currentStatus->id === $status->id) {
+                return $currentStatus;
+            }
+        }
+
+        // Set status always creates new record, leaving full history behind
+        $statusable = new StatusRecord();
+        $statusable->type = $type;
+        $statusable->statusable()->associate($this);
+
+        $statusable->status()->associate($status)->save();
+        $this->load('statusRecords');
+
+        return $statusable->status;
+    }
+
+    public function statusRecords()
+    {
+        return $this->morphMany(StatusRecord::class, 'statusable');
+    }
+
+    private function getStatusByName(string $name, string $type): Status
+    {
+        if ($this->dynamicStatusCreation) {
+            return Status::createStatus($type, $name);
+        }
+
+        if ($status = Status::findStatus($type, $name)) {
+            return $status;
+        }
+
+        throw new UnknownStatusException($type, $name);
+    }
+}
diff --git a/tests/Support/Providers/NovaPackageServiceProvider.php b/tests/Support/Providers/NovaPackageServiceProvider.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -8,9 +8,9 @@
 use Spatie\Permission\PermissionServiceProvider;
 use Tipoff\Authorization\AuthorizationServiceProvider;
 use Tipoff\Statuses\StatusesServiceProvider;
-use Tipoff\Statuses\Tests\Support\Providers\NovaPackageServiceProvider;
 use Tipoff\Support\SupportServiceProvider;
 use Tipoff\TestSupport\BaseTestCase;
+use Tipoff\TestSupport\Providers\NovaPackageServiceProvider;
 
 class TestCase extends BaseTestCase
 {