improvements

Author: goshasafonov

config/groupable.php

@@ -22,15 +22,34 @@
                     # models...
                 ],
             ],
+            'relation' => [
+                'name' => 'groupable',
+            ],
             'observer' => Yuges\Groupable\Observers\GroupableObserver::class,
         ],
+        'grouperator' => [
+            'key' => Yuges\Package\Enums\KeyType::BigInteger,
+            'default' => [
+                'class' => \App\Models\User::class,
+            ],
+            'allowed' => [
+                'classes' => [
+                    \App\Models\User::class,
+                ],
+            ],
+            'relation' => [
+                'name' => 'grouperator',
+            ],
+        ],
     ],
 
-    'permissions' => [],
+    'permissions' => [
+        'anonymous' => false,
+    ],
 
     'actions' => [
-        // 'sync' => Yuges\Topicable\Actions\SyncTopicAction::class,
-        // 'attach' => Yuges\Topicable\Actions\AttachTopicAction::class,
-        // 'detach' => Yuges\Topicable\Actions\DetachTopicAction::class,
+        'sync' => Yuges\Groupable\Actions\SyncGroupsAction::class,
+        'attach' => Yuges\Groupable\Actions\AttachGroupsAction::class,
+        'detach' => Yuges\Groupable\Actions\DetachGroupsAction::class,
     ],
 ];

database/migrations/000_create_groups_table.php

@@ -22,6 +22,16 @@ public function up(): void
 
         Schema::create($this->table, function (Blueprint $table) {
             $table->key(Config::getGroupKeyType(KeyType::BigInteger));
+
+            Config::getPermissionsAnonymous(false)
+                ? $table->nullableKeyMorphs(
+                    Config::getGrouperatorKeyType(KeyType::BigInteger),
+                    Config::getGrouperatorRelationName('grouperator')
+                )
+                : $table->keyMorphs(
+                    Config::getGrouperatorKeyType(KeyType::BigInteger),
+                    Config::getGrouperatorRelationName('grouperator')
+                );
         });
 
         Schema::table($this->table, function (Blueprint $table) {

database/migrations/001_create_groupables_table.php

@@ -28,8 +28,22 @@ public function up(): void
                 ->cascadeOnUpdate()
                 ->cascadeOnDelete();
 
-            $table->keyMorphs(Config::getGroupableKeyType(KeyType::BigInteger), 'groupable');
+            $table->keyMorphs(
+                Config::getGroupableKeyType(KeyType::BigInteger),
+                Config::getGroupableRelationName('groupable')
+            );
 
+            Config::getPermissionsAnonymous(false)
+                ? $table->nullableKeyMorphs(
+                    Config::getGrouperatorKeyType(KeyType::BigInteger),
+                    Config::getGrouperatorRelationName('grouperator')
+                )
+                : $table->keyMorphs(
+                    Config::getGrouperatorKeyType(KeyType::BigInteger),
+                    Config::getGrouperatorRelationName('grouperator')
+                );
+
+            $table->order();
             $table->unique(['group_id', 'groupable_id', 'groupable_type']);
 
             $table->timestamps();

src/Actions/AttachGroupsAction.php

@@ -5,7 +5,10 @@
 use Yuges\Groupable\Models\Group;
 use Illuminate\Support\Collection;
 use Yuges\Groupable\Config\Config;
+use Illuminate\Database\Eloquent\Model;
 use Yuges\Groupable\Interfaces\Groupable;
+use Yuges\Groupable\Interfaces\Grouperator;
+use Yuges\Groupable\Models\Groupable as GroupableModel;
 
 class AttachGroupsAction
 {
@@ -22,8 +25,10 @@ public static function create(Groupable $groupable): self
     /**
      * @param Collection<array-key, Group> $groups
      */
-    public function execute(Collection $groups): Groupable
+    public function execute(Collection $groups, ?Grouperator $grouperator = null): Groupable
     {
+        $grouperator ??= $this->groupable->defaultGrouperator();
+
         $ids = $groups
             ->map(function (Group $group) {
                 return $group->id;
@@ -34,8 +39,19 @@ public function execute(Collection $groups): Groupable
 
         $groups = Config::getGroupClass(Group::class)::query()->getQuery()->whereIn('id', $ids)->get();
 
-        $this->groupable->groups()->sync($groups->pluck('id'), false);
+        $this->groupable->groups()->syncWithPivotValues($groups->pluck('id'), $this->pivotValues($grouperator), false);
 
         return $this->groupable;
     }
+
+    public function pivotValues(?Grouperator $grouperator = null): array
+    {
+        $pivot = new GroupableModel();
+        $relation = $pivot->grouperator();
+
+        return [
+            $relation->getForeignKeyName() => $grouperator instanceof Model ? $grouperator->getKey() : null,
+            $relation->getMorphType() => $grouperator instanceof Model ? $grouperator->getMorphClass() : null,
+        ];
+    }
 }

src/Config/Config.php

@@ -6,6 +6,7 @@
 use Yuges\Groupable\Models\Group;
 use Illuminate\Support\Collection;
 use Yuges\Groupable\Models\Groupable;
+use Yuges\Groupable\Interfaces\Grouperator;
 use Yuges\Groupable\Observers\GroupObserver;
 use Yuges\Groupable\Actions\SyncGroupsAction;
 use Yuges\Groupable\Actions\AttachGroupsAction;
@@ -55,6 +56,11 @@ public static function getGroupableKeyType(mixed $default = null): KeyType
         return self::get('models.groupable.key', $default);
     }
 
+    public static function getGroupableRelationName(mixed $default = null): string
+    {
+        return self::get('models.groupable.relation.name', $default);
+    }
+
     /** @return Collection<array-key, class-string<Groupable>> */
     public static function getGroupableAllowedClasses(mixed $default = null): Collection
     {
@@ -66,7 +72,36 @@ public static function getGroupableAllowedClasses(mixed $default = null): Collec
     /** @return class-string<GroupableObserver> */
     public static function getGroupableObserverClass(mixed $default = null): string
     {
-        return self::get('models.Groupable.observer', $default);
+        return self::get('models.groupable.observer', $default);
+    }
+
+    public static function getGrouperatorKeyType(mixed $default = null): KeyType
+    {
+        return self::get('models.grouperator.key', $default);
+    }
+
+    public static function getGrouperatorRelationName(mixed $default = null): string
+    {
+        return self::get('models.grouperator.relation.name', $default);
+    }
+
+    /** @return class-string<Grouperator> */
+    public static function getGrouperatorDefaultClass(mixed $default = null): string
+    {
+        return self::get('models.grouperator.default.class', $default);
+    }
+
+    /** @return Collection<array-key, class-string<Grouperator>> */
+    public static function getGrouperatorAllowedClasses(mixed $default = null): Collection
+    {
+        return Collection::make(
+            self::get('models.grouperator.allowed.classes', $default)
+        );
+    }
+
+    public static function getPermissionsAnonymous(mixed $default = false): bool
+    {
+        return self::get('permissions.anonymous', $default);
     }
 
     public static function getSyncGroupsAction(

src/Interfaces/Groupable.php

@@ -23,4 +23,6 @@ public function detachGroup(Group $group): static;
     public function detachGroups(Collection $groups): static;
 
     public function syncGroups(Collection $groups): static;
+
+    public function defaultGrouperator(): ?Grouperator;
 }

src/Interfaces/Grouperator.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Yuges\Groupable\Interfaces;
+
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
+
+interface Grouperator
+{
+    public function groups(): MorphToMany;
+}

src/Models/Group.php

@@ -8,6 +8,7 @@
 use Yuges\Groupable\Traits\HasParent;
 use Yuges\Sluggable\Options\SlugOptions;
 use Yuges\Sluggable\Interfaces\Sluggable;
+use Yuges\Groupable\Traits\HasGrouperator;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 
 /**
@@ -17,7 +18,7 @@
  */
 class Group extends Model implements Sluggable
 {
-    use HasFactory, HasParent, HasSlug;
+    use HasFactory, HasParent, HasGrouperator, HasSlug;
 
     protected $table = 'groups';
 

src/Models/Groupable.php

@@ -5,13 +5,14 @@
 use Yuges\Groupable\Config\Config;
 use Yuges\Package\Traits\HasTable;
 use Yuges\Package\Traits\HasTimestamps;
+use Yuges\Groupable\Traits\HasGrouperator;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\MorphPivot;
 
 class Groupable extends MorphPivot
 {
-    use HasFactory, HasTable, HasTimestamps;
+    use HasFactory, HasTable, HasTimestamps, HasGrouperator;
 
     public $table = 'groupables';
 

src/Observers/GroupObserver.php

@@ -2,16 +2,17 @@
 
 namespace Yuges\Groupable\Observers;
 
-use Yuges\Package\Models\Model;
+use Yuges\Groupable\Models\Group;
+use Yuges\Groupable\Config\Config;
 
 class GroupObserver
 {
-    public function saving(Model $model): void
+    public function saving(Group $group): void
     {
 
     }
 
-    public function deleted(Model $model): void
+    public function deleted(Group $group): void
     {
 
     }