Add Macros for Polymorphic Relationships (#7)

* feat: add morphs snowflake column macros to Blueprint

* feat: add tests morphs snowflake polymorphic relationships

* Rename blueprints to be more consistent with the framework

* Fixing morph index order

* Use higher order expectations

* Removing integration test with framework

* Simplify comment

Author: ItsReddi

src/Macros/BlueprintMacros.php

@@ -24,5 +24,17 @@ public static function boot(): void
             /** @var class-string<Model> $model */
             return $this->foreignSnowflake($column ?? (new $model())->getForeignKey());
         });
+
+        Blueprint::macro('snowflakeMorphs', function (string $name, ?string $indexName = null): void {
+            $this->snowflake("{$name}_id");
+            $this->text("{$name}_type");
+            $this->index(["{$name}_type", "{$name}_id"], $indexName);
+        });
+
+        Blueprint::macro('nullableSnowflakeMorphs', function (string $name, ?string $indexName = null): void {
+            $this->snowflake("{$name}_id")->nullable();
+            $this->text("{$name}_type")->nullable();
+            $this->index(["{$name}_type", "{$name}_id"], $indexName);
+        });
     }
 }

tests/Feature/Mixins/BlueprintMixinTest.php

@@ -46,3 +46,23 @@
         'alter table "snowflake" add column "user_id" integer not null',
     ]);
 });
+
+it('adds morph snowflake columns', function () {
+    test()->blueprint->snowflakeMorphs('taggable');
+
+    expect((test()->sql)())->toBe([
+        'alter table "snowflake" add column "taggable_id" integer not null',
+        'alter table "snowflake" add column "taggable_type" text not null',
+        'create index "snowflake_taggable_type_taggable_id_index" on "snowflake" ("taggable_type", "taggable_id")',
+    ]);
+});
+
+it('adds nullable morph snowflake columns', function () {
+    test()->blueprint->nullableSnowflakeMorphs('taggable');
+
+    expect((test()->sql)())->toBe([
+        'alter table "snowflake" add column "taggable_id" integer',
+        'alter table "snowflake" add column "taggable_type" text',
+        'create index "snowflake_taggable_type_taggable_id_index" on "snowflake" ("taggable_type", "taggable_id")',
+    ]);
+});

workbench/app/Models/Post.php

@@ -8,6 +8,7 @@
 use CalebDW\Laraflake\Concerns\HasSnowflakes;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
 
 class Post extends Model
 {
@@ -35,4 +36,10 @@ public function getRouteKeyName(): string
     {
         return 'slug';
     }
+
+    /** @return MorphMany<Tag, $this> */
+    public function tags(): MorphMany
+    {
+        return $this->morphMany(Tag::class, 'taggable');
+    }
 }

workbench/app/Models/Tag.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\Models;
+
+use CalebDW\Laraflake\Concerns\HasSnowflakes;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+class Tag extends Model
+{
+    use HasSnowflakes;
+
+    protected $guarded = [];
+
+    /** @return MorphTo<Model, $this> */
+    public function taggable(): MorphTo
+    {
+        return $this->morphTo();
+    }
+}

workbench/app/Models/User.php

@@ -7,6 +7,7 @@
 use CalebDW\Laraflake\Concerns\HasSnowflakes;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
 
 class User extends Model
 {
@@ -19,4 +20,10 @@ public function posts(): HasMany
     {
         return $this->hasMany(Post::class);
     }
+
+    /** @return MorphMany<Tag, $this> */
+    public function tags(): MorphMany
+    {
+        return $this->morphMany(Tag::class, 'taggable');
+    }
 }

workbench/database/migrations/2025_03_05_130921_create_tags_table.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('tags', function (Blueprint $table) {
+            $table->snowflake()->primary();
+            $table->string('name');
+            $table->snowflakeMorphs('taggable');
+            $table->timestamps();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('tags');
+    }
+};