added config, models, providers

Author: goshasafonov

composer.json

@@ -23,7 +23,8 @@
     ],
     "require": {
         "php": "^8.4",
-        "yuges-code/laravel-package": "^1.0"
+        "yuges-code/laravel-package": "^1.0",
+        "yuges-code/laravel-sluggable": "^1.0"
     },
     "require-dev": {
         "orchestra/testbench": "^10.0"
@@ -46,7 +47,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "Yuges\\Groupable\\Providers\\TemplateServiceProvider"
+                "Yuges\\Groupable\\Providers\\GroupableServiceProvider"
             ]
         }
     },

config/groupable.php

@@ -3,5 +3,34 @@
 // Config for yuges/groupable
 
 return [
-    # code...
+    /*
+     * FQCN (Fully Qualified Class Name) of the models to use for groups
+     */
+    'models' => [
+        'group' => [
+            'key' => Yuges\Package\Enums\KeyType::BigInteger,
+            'table' => 'groups',
+            'class' => Yuges\Groupable\Models\Group::class,
+            'observer' => Yuges\Groupable\Observers\GroupObserver::class,
+        ],
+        'groupable' => [
+            'table' => 'groupables',
+            'key' => Yuges\Package\Enums\KeyType::BigInteger,
+            'class' => Yuges\Groupable\Models\Groupable::class,
+            'allowed' => [
+                'classes' => [
+                    # models...
+                ],
+            ],
+            'observer' => Yuges\Groupable\Observers\GroupableObserver::class,
+        ],
+    ],
+
+    'permissions' => [],
+
+    'actions' => [
+        // 'sync' => Yuges\Topicable\Actions\SyncTopicAction::class,
+        // 'attach' => Yuges\Topicable\Actions\AttachTopicAction::class,
+        // 'detach' => Yuges\Topicable\Actions\DetachTopicAction::class,
+    ],
 ];

database/migrations/000_create_groups_table.php

@@ -0,0 +1,44 @@
+<?php
+
+use Yuges\Package\Enums\KeyType;
+use Yuges\Groupable\Models\Group;
+use Yuges\Groupable\Config\Config;
+use Yuges\Package\Database\Schema\Schema;
+use Yuges\Package\Database\Schema\Blueprint;
+use Yuges\Package\Database\Migrations\Migration;
+
+return new class extends Migration
+{
+    public function __construct()
+    {
+        $this->table = Config::getGroupClass(Group::class)::getTableName();
+    }
+
+    public function up(): void
+    {
+        if (Schema::hasTable($this->table)) {
+            return;
+        }
+
+        Schema::create($this->table, function (Blueprint $table) {
+            $table->key(Config::getGroupKeyType(KeyType::BigInteger));
+        });
+
+        Schema::table($this->table, function (Blueprint $table) {
+            $table
+                ->foreignIdFor(Config::getGroupClass(Group::class), 'parent_id')
+                ->nullable()
+                ->constrained()
+                ->cascadeOnUpdate()
+                ->cascadeOnDelete();
+
+            $table->string('slug')->unique();
+            $table->string('name')->unique();
+            $table->string('type')->nullable();
+
+            $table->order();
+
+            $table->timestamps();
+        });
+    }
+};

database/migrations/001_create_groupables_table.php

@@ -0,0 +1,38 @@
+<?php
+
+use Yuges\Package\Enums\KeyType;
+use Yuges\Groupable\Models\Group;
+use Yuges\Groupable\Config\Config;
+use Yuges\Groupable\Models\Groupable;
+use Yuges\Package\Database\Schema\Schema;
+use Yuges\Package\Database\Schema\Blueprint;
+use Yuges\Package\Database\Migrations\Migration;
+
+return new class extends Migration
+{
+    public function __construct()
+    {
+        $this->table = Config::getGroupableClass(Groupable::class)::getTableName();
+    }
+
+    public function up(): void
+    {
+        if (Schema::hasTable($this->table)) {
+            return;
+        }
+
+        Schema::create($this->table, function (Blueprint $table) {
+            $table
+                ->foreignIdFor(Config::getGroupClass(Group::class))
+                ->constrained()
+                ->cascadeOnUpdate()
+                ->cascadeOnDelete();
+
+            $table->keyMorphs(Config::getGroupableKeyType(KeyType::BigInteger), 'groupable');
+
+            $table->unique(['group_id', 'groupable_id', 'groupable_type']);
+
+            $table->timestamps();
+        });
+    }
+};

database/migrations/create_groups_table.php

@@ -1,14 +1,67 @@
 <?php
 
-namespace Vendor\Template\Config;
+namespace Yuges\Groupable\Config;
 
-class Config
+use Yuges\Package\Enums\KeyType;
+use Yuges\Groupable\Models\Group;
+use Illuminate\Support\Collection;
+use Yuges\Groupable\Models\Groupable;
+use Yuges\Groupable\Observers\GroupObserver;
+use Yuges\Groupable\Observers\GroupableObserver;
+
+class Config extends \Yuges\Package\Config\Config
 {
-    /** @return class-string<Template> */
-    public static function getTemplateClass()
+    const string NAME = 'groupable';
+
+    public static function getGroupTable(mixed $default = null): string
+    {
+        return self::get('models.group.table', $default);
+    }
+
+    /** @return class-string<Group> */
+    public static function getGroupClass(mixed $default = null): string
+    {
+        return self::get('model.group.class', $default);
+    }
+
+    public static function getGroupKeyType(mixed $default = null): KeyType
+    {
+        return self::get('models.group.key', $default);
+    }
+
+    /** @return class-string<GroupObserver> */
+    public static function getGroupObserverClass(mixed $default = null): string
+    {
+        return self::get('models.group.observer', $default);
+    }
+
+    public static function getGroupableTable(mixed $default = null): string
+    {
+        return self::get('models.groupable.table', $default);
+    }
+
+    /** @return class-string<Groupable> */
+    public static function getGroupableClass(mixed $default = null): string
+    {
+        return self::get('models.groupable.class', $default);
+    }
+
+    public static function getGroupableKeyType(mixed $default = null): KeyType
     {
+        return self::get('models.groupable.key', $default);
+    }
 
+    /** @return Collection<array-key, class-string<Groupable>> */
+    public static function getGroupableAllowedClasses(mixed $default = null): Collection
+    {
+        return Collection::make(
+            self::get('models.groupable.allowed.classes', $default)
+        );
     }
 
-    # code...
+    /** @return class-string<GroupableObserver> */
+    public static function getGroupableObserverClass(mixed $default = null): string
+    {
+        return self::get('models.Groupable.observer', $default);
+    }
 }

src/Config/Config.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Yuges\Groupable\Exceptions;
+
+use Exception;
+use TypeError;
+use Yuges\Groupable\Models\Group;
+
+class InvalidGroup extends Exception
+{
+    public static function doesNotImplementGroup(string $class): TypeError
+    {
+        $group = Group::class;
+
+        return new TypeError("Group class `{$class}` must implement `{$group}`");
+    }
+}

src/Exceptions/InvalidGroup.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Yuges\Groupable\Exceptions;
+
+use Exception;
+use TypeError;
+use Yuges\Groupable\Models\Groupable;
+
+class InvalidGroupable extends Exception
+{
+    public static function doesNotImplementGroupable(string $class): TypeError
+    {
+        $groupable = Groupable::class;
+
+        return new TypeError("Groupable class `{$class}` must implement `{$groupable}`");
+    }
+}

src/Exceptions/InvalidGroupable.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Yuges\Groupable\Models;
+
+use Yuges\Package\Models\Model;
+use Yuges\Groupable\Config\Config;
+use Yuges\Sluggable\Traits\HasSlug;
+use Yuges\Sluggable\Options\SlugOptions;
+use Yuges\Sluggable\Interfaces\Sluggable;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+
+/**
+ * @property string $name
+ * @property string $slug
+ * @property null|string $type
+ */
+class Group extends Model implements Sluggable
+{
+    use HasFactory, HasSlug;
+
+    protected $table = 'groups';
+
+    protected $guarded = ['id'];
+
+    public function getTable(): string
+    {
+        return Config::getGroupTable() ?? $this->table;
+    }
+
+    public function sluggable(): SlugOptions
+    {
+        $options = new SlugOptions();
+
+        $options->column = 'slug';
+        $options->separator = '-';
+        $options->source = ['name'];
+        $options->union = [];
+
+        return $options;
+    }
+}