Features: Migrations, Policies config and Models, Reactions, Comments (#7)

- Added Comment and Reaction Model
- Set user model as AUTH_MODEL env by default
- Set comment and reactin models by default
- Added a guest-comments setting to mark whether to allow guest comments
- Finished migrations for comments and reactions
- Added HasReactions and HasComments concerns
- Ability to toggle Reactions
- Ability to set allowed reactions
- Ability to add comments
- Ability to fetch comments tree (base comments with their nested
replies)
- Ability to delete a comment if it belongs to you (untested)
- Ability to set whether to allow multiple reactions or not
- Ability to set whether to allow guest comments and reactions or not

Author: coolsam726

.github/workflows/fix-php-code-style-issues.yml

@@ -37,5 +37,11 @@ jobs:
           branch: php-style-fixes
           title: Fix PHP Code Styling
           labels: code-style
-          auto-merge: true
           delete-branch: true
+
+      - name: Auto-merge Pull Request
+        uses: pascalgn/automerge-action@v0.16.4
+        with:
+          merge-method: squash
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

composer.json

@@ -22,6 +22,7 @@
     "require": {
         "php": "^8.2",
         "filament/filament": "^3",
+        "kalnoy/nestedset": "^6.0",
         "spatie/laravel-package-tools": "^1.15.0"
     },
     "require-dev": {
@@ -71,4 +72,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

config/nested-comments.php

@@ -1,6 +1,35 @@
 <?php
 
-// config for Coolsam/NestedComments
 return [
+    'tables' => [
+        'comments' => 'comments',
+        'reactions' => 'reactions',
+        'users' => 'users', // The table that will be used to get the authenticated user
+    ],
 
+    'models' => [
+        'comment' => \Coolsam\NestedComments\Models\Comment::class,
+        'reaction' => \Coolsam\NestedComments\Models\Reaction::class,
+        'user' => env( 'AUTH_MODEL', 'App\Models\User'), // The model that will be used to get the authenticated user
+    ],
+
+    'policies' => [
+        'comment' => null,
+        'reaction' => null,
+    ],
+    'allowed-reactions' => [
+        '👍', // thumbs up
+        '👎', // thumbs down
+        '❤️', // heart
+        '😂', // laughing
+        '😮', // surprised
+        '😢', // crying
+        '😡', // angry
+        '🔥', // fire
+        '🎉', // party popper
+        '🚀', // rocket
+    ],
+    'allow-multiple-reactions' => env('ALLOW_MULTIPLE_REACTIONS', false), // Allow multiple reactions from the same user
+    'allow-guest-reactions' => env('ALLOW_GUEST_REACTIONS', false), // Allow guest users to react
+    'allow-guest-comments' => env('ALLOW_GUEST_COMMENTS', false), // Allow guest users to comment
 ];

database/migrations/create_nested_comments_table.php.stub

@@ -2,18 +2,37 @@
 
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Schema;
 
 return new class extends Migration
 {
     public function up()
     {
-        Schema::create('nested_comments_table', function (Blueprint $table) {
+        $users = Config::get('nested-comments.tables.users', 'users');
+        Schema::create(Config::get('nested-comments.tables.comments'), function (Blueprint $table) use ($users) {
             $table->id();
+            $table->nestedSet();
+            $table->foreignId('user_id')->nullable()->constrained($users)->cascadeOnDelete();
+            $table->text('body');
+            $table->morphs('commentable');
+            $table->ipAddress()->nullable();
+            $table->timestamps();
+        });
 
-            // add fields
-
+        Schema::create(Config::get('nested-comments.tables.reactions'), function (Blueprint $table) use ($users) {
+            $table->id();
+            $table->foreignId('user_id')->nullable()->constrained($users)->cascadeOnDelete();
+            $table->morphs('reactable');
+            $table->string('emoji');
+            $table->ipAddress()->nullable();
             $table->timestamps();
         });
     }
+
+    public function down()
+    {
+        Schema::dropIfExists(Config::get('nested-comments.tables.reactions'));
+        Schema::dropIfExists(Config::get('nested-comments.tables.comments'));
+    }
 };

package-lock.json

@@ -16,6 +16,7 @@
         "@tailwindcss/typography": "^0.5.9",
         "autoprefixer": "^10.4.14",
         "esbuild": "^0.25.2",
+        "flowbite": "^3.1.2",
         "npm-run-all": "^4.1.5",
         "postcss": "^8.4.26",
         "postcss-import": "^15.1.0",

package.json

@@ -0,0 +1,85 @@
+<?php
+
+namespace Coolsam\NestedComments\Concerns;
+
+use Coolsam\NestedComments\Models\Comment;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
+/**
+ * @mixin Model
+ */
+trait HasComments
+{
+    public function comments(): MorphMany
+    {
+        return $this->morphMany(config('nested-comments.models.comment'), 'commentable');
+    }
+
+    public function getCommentsCountAttribute(): int
+    {
+        return $this->comments()->count();
+    }
+
+    public function getCommentsTree($offset = null, $limit = null, $columns = ['*'])
+    {
+        $query = $this->comments()
+            ->getQuery()
+            ->where('parent_id', '=', null);
+        if (filled($offset)) {
+            $query->offset($offset);
+        }
+        if (filled($limit)) {
+            $query->limit($limit);
+        }
+
+        $columns = ['id', 'parent_id', '_lft', '_rgt', ...$columns];
+
+        return collect($query->get($columns)->map(function (Comment $comment) use ($columns) {
+            $descendants = $comment->getDescendants($columns);
+            return collect($comment->toArray())->put('descendants', $descendants->toArray());
+        })->toArray());
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function addComment(string $comment, mixed $parentId = null)
+    {
+        $allowGuest = config('nested-comments.allow-guest-comments', false);
+        if (! $allowGuest && ! auth()->check()) {
+            throw new \Exception('You must be logged in to comment.');
+        }
+
+        if ($allowGuest && ! auth()->check()) {
+            $userId = null;
+        } else {
+            $userId = auth()->id();
+        }
+
+        return $this->comments()->create([
+            'user_id' => $userId,
+            'body' => $comment,
+            'commentable_id' => $this->getKey(),
+            'commentable_type' => $this->getMorphClass(),
+            'parent_id' => $parentId,
+            'ip_address' => request()->ip(),
+        ]);
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function deleteComment(Comment $comment): ?bool
+    {
+        if (! auth()->check()) {
+            throw new \Exception('You must be logged in to delete your comment.');
+        }
+
+        if ($comment->getAttribute('user_id') !== auth()->id()) {
+            throw new \Exception('You are not authorized to delete this comment.');
+        }
+
+        return $comment->delete();
+    }
+}