Added RenderableComment; Added pool option; (#13)

* Added renderable interface

* Added L12

* Removed -dev

* Added a proper way to rewrite the get comments function

* Added pooling

* Readme

* Readme

* Readme

* Fixed test

Author: luisdalmolin

.github/workflows/tests.yml

@@ -12,12 +12,12 @@ jobs:
       fail-fast: true
       matrix:
         php: [8.3, 8.4]
-        laravel: [11.*]
+        laravel: [11.*, 12.*]
         include:
           - laravel: 11.*
             testbench: 9.*
-          # - laravel: 12.*-dev
-          #   testbench: 10.*-dev
+          - laravel: 12.*
+            testbench: 10.*
 
     name: Tests - PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
     steps:

README.md

@@ -1,4 +1,4 @@
-# Commentions
+<h1 align="center">Commentions</h1>
 
 ![Laravel Supported Versions](https://img.shields.io/badge/laravel-10.x/11.x/12.x-green.svg)
 [![run-tests](https://github.com/kirschbaum-development/commentions/actions/workflows/tests.yaml/badge.svg)](https://github.com/kirschbaum-development/commentions/actions/workflows/tests.yaml)
@@ -8,6 +8,8 @@
 
 Commentions is a drop-in package for Filament that allows you to add comments to your resources. You can configure it so your users are mentionable in the comments, and it dispatches events so you can handle mentions in your own application however you like.
 
+![](screenshots/comments.png)
+
 ## Installation
 
 ```bash
@@ -47,7 +49,9 @@ class Project extends Model implements Commentable
 
 ### Usage with Filament
 
-1. And register the component in your Filament Infolists:
+There are a couple of ways to use Commentions with Filament.
+
+1. Register the component in your Filament Infolists:
 
 ```php
 Infolists\Components\Section::make('Comments')
@@ -82,13 +86,11 @@ protected function getHeaderActions(): array
 }
 ```
 
-And that's it!
-
-![](screenshots/comments.png)
+***
 
 ### Configuring the User model and the mentionables
 
-If your `User` model lives in a different namespace than `App\Models\User`, you can configure it in the `config/commentions.php` file:
+If your `User` model lives in a different namespace than `App\Models\User`, you can configure it in `config/commentions.php`:
 
 ```php
     'commenter' => [
@@ -172,6 +174,41 @@ $comment->getMentioned()->each(function (Commenter $commenter) {
 });
 ```
 
+### Polling for new comments
+
+Commentions supports polling for new comments. You can enable it by setting the `pollingEnabled` property to `true` and setting the `pollingInterval` property to the number of seconds between polls when you register the component.
+
+```php
+Infolists\Components\Section::make('Comments')
+    ->schema([
+        Livewire::make(Comments::class, [
+            'pollingEnabled' => true,
+            'pollingInterval' => 30, // optional, default is 60 seconds
+        ])
+    ]),
+```
+
+### Rendering non-Comments in the list
+
+Sometimes you might want to render non-Comments in the list of comments. For example, you might want to render when the status of a project is changed. For this, you can override the `getComments` method in your model, and return instances of the `Kirschbaum\Commentions\RenderableComment` data object.
+
+```php
+use Kirschbaum\Commentions\RenderableComment;
+
+public function getComments(): Collection
+{
+    $statusHistory = $this->statusHistory()->get()->map(fn (StatusHistory $statusHistory) => new RenderableComment(
+        authorName: $statusHistory->user->name,
+        body: sprintf('Status changed from %s to %s', $statusHistory->old_status, $statusHistory->new_status),
+        createdAt: $statusHistory->created_at,
+    ));
+
+    $comments = $this->comments()->latest()->with('author')->get();
+
+    return $statusHistory->merge($comments);
+}
+```
+
 ***
 
 ## Security

composer.json

@@ -26,7 +26,9 @@
         "illuminate/support": "^11.0|^12.0",
         "illuminate/database": "^11.0|^12.0",
         "livewire/livewire": "^3.5",
-        "filament/support": "^3.2"
+        "filament/support": "^3.2",
+        "filament/notifications": "^3.2",
+        "filament/filament": "^3.2"
     },
     "extra": {
         "laravel": {

database/factories/CommentFactory.php

@@ -35,7 +35,6 @@ public function commentable(Commentable $commentable): self
     }
 
     public function author(Commenter $author): self
-
     {
         return $this->state(fn (array $attributes) => [
             'author_type' => $author->getMorphClass(),

resources/views/comment-list.blade.php

@@ -1,4 +1,8 @@
-<div>
+<div
+    @if ($pollingEnabled && $pollingInterval > 0)
+        wire:poll.{{ $pollingInterval }}s
+    @endif
+>
     @if ($this->comments->isEmpty())
         <div class="flex items-center justify-center p-6 text-center rounded-lg border border-dashed border-gray-300 dark:border-gray-700">
             <div class="flex flex-col items-center gap-y-2">
@@ -16,7 +20,7 @@ class="w-8 h-8 text-gray-400 dark:text-gray-500"
 
     @foreach ($this->comments as $comment)
         <livewire:commentions::comment
-            :key="'comment-' . $comment->id"
+            :key="'comment-' . $comment->getId()"
             :comment="$comment"
             :mentionables="$mentionables"
         />

resources/views/comment.blade.php

@@ -1,42 +1,48 @@
-<div class="flex items-start gap-x-4 border p-4 rounded-lg shadow-sm mb-2" id="filament-comment-{{ $comment->id }}">
-    <img
-        src="{{ $comment->getAuthorAvatar() }}"
-        alt="User Avatar"
-        class="w-10 h-10 rounded-full mt-0.5 object-cover object-center"
-    />
+<div class="flex items-start gap-x-4 border p-4 rounded-lg shadow-sm mb-2" id="filament-comment-{{ $comment->getId() }}">
+    @if ($avatar = $comment->getAuthorAvatar())
+        <img
+            src="{{ $comment->getAuthorAvatar() }}"
+            alt="User Avatar"
+            class="w-10 h-10 rounded-full mt-0.5 object-cover object-center"
+        />
+    @else
+        <div class="w-10 h-10 rounded-full mt-0.5 "></div>
+    @endif
 
     <div class="flex-1">
         <div class="text-sm font-bold text-gray-900 dark:text-gray-100 flex justify-between items-center">
             <div>
-                {{ $comment->author->name }}
+                {{ $comment->getAuthorName() }}
                 <span
                     class="text-xs text-gray-500 dark:text-gray-300"
-                    title="Commented at {{ $comment->created_at->format('Y-m-d H:i:s') }}"
-                >{{ $comment->created_at->diffForHumans() }}</span>
+                    title="Commented at {{ $comment->getCreatedAt()->format('Y-m-d H:i:s') }}"
+                >{{ $comment->getCreatedAt()->diffForHumans() }}</span>
 
-                @if ($comment->updated_at->gt($comment->created_at))
+                @if ($comment->getUpdatedAt()->gt($comment->getCreatedAt()))
                     <span
                         class="text-xs text-gray-300 ml-1"
-                        title="Edited at {{ $comment->updated_at->format('Y-m-d H:i:s') }}"
+                        title="Edited at {{ $comment->getUpdatedAt()->format('Y-m-d H:i:s') }}"
                     >(edited)</span>
                 @endif
             </div>
 
-            @if ($comment->isAuthor(Kirschbaum\Commentions\Config::resolveAuthenticatedUser()))
+            @if ($comment->isComment() && $comment->canEdit())
                 <div class="flex gap-x-1">
-                    <x-filament::icon-button
+                    {{-- <x-filament::icon-button
                         icon="heroicon-s-pencil-square"
                         wire:click="edit"
                         size="xs"
                         color="gray"
                     />
 
-                    <x-filament::icon-button
-                        icon="heroicon-s-trash"
-                        wire:click="$dispatch('open-modal', { id: 'delete-comment-modal-{{ $comment->id }}' })"
-                        size="xs"
-                        color="gray"
-                    />
+                    @if ($comment->canDelete())
+                        <x-filament::icon-button
+                            icon="heroicon-s-trash"
+                            wire:click="$dispatch('open-modal', { id: 'delete-comment-modal-{{ $comment->getId() }}' })"
+                            size="xs"
+                            color="gray"
+                        />
+                    @endif --}}
                 </div>
             @endif
         </div>
@@ -50,8 +56,8 @@ class="text-xs text-gray-300 ml-1"
                 </div>
 
                 <div class="flex gap-x-2">
-                    <x-filament::button
-                        wire:click="updateComment({{ $comment->id }})"
+                    {{-- <x-filament::button
+                        wire:click="updateComment({{ $comment->getId() }})"
                         size="sm"
                     >
                         Save
@@ -63,44 +69,45 @@ class="text-xs text-gray-300 ml-1"
                         color="gray"
                     >
                         Cancel
-                    </x-filament::button>
+                    </x-filament::button> --}}
                 </div>
             </div>
         @else
-            <div class="mt-1 space-y-6 text-sm text-gray-800 dark:text-gray-200">{!! $comment->body_parsed !!}</div>
+            <div class="mt-1 space-y-6 text-sm text-gray-800 dark:text-gray-200">{!! $comment->getParsedBody() !!}</div>
         @endif
     </div>
 
-    <x-filament::modal
-        id="delete-comment-modal-{{ $comment->id }}"
-        wire:model="showDeleteModal"
-        width="sm"
-    >
-        <x-slot name="heading">
-            Delete Comment
-        </x-slot>
+    @if ($comment->isComment() && $comment->canDelete())
+        {{-- <x-filament::modal
+            id="delete-comment-modal-{{ $comment->getId() }}"
+            wire:model="showDeleteModal"
+            width="sm"
+        >
+            <x-slot name="heading">
+                Delete Comment
+            </x-slot>
 
-        <div class="py-4">
-            Are you sure you want to delete this comment? This action cannot be undone.
-        </div>
-
-        <x-slot name="footer">
-            <div class="flex justify-end gap-x-4">
-                <x-filament::button
-                    wire:click="$dispatch('close-modal', { id: 'delete-comment-modal-{{ $comment->id }}' })"
-                    color="gray"
-                >
-                    Cancel
-                </x-filament::button>
-
-                <x-filament::button
-                    wire:click="delete"
-                    color="danger"
-                >
-                    Delete
-                </x-filament::button>
+            <div class="py-4">
+                Are you sure you want to delete this comment? This action cannot be undone.
             </div>
-        </x-slot>
-    </x-filament::modal>
 
+            <x-slot name="footer">
+                <div class="flex justify-end gap-x-4">
+                    <x-filament::button
+                        wire:click="$dispatch('close-modal', { id: 'delete-comment-modal-{{ $comment->getId() }}' })"
+                        color="gray"
+                    >
+                        Cancel
+                    </x-filament::button>
+
+                    <x-filament::button
+                        wire:click="delete"
+                        color="danger"
+                    >
+                        Delete
+                    </x-filament::button>
+                </div>
+            </x-slot>
+        </x-filament::modal> --}}
+    @endif
 </div>

resources/views/comments.blade.php

@@ -30,5 +30,7 @@
     <livewire:commentions::comment-list
         :record="$record"
         :mentionables="$this->mentions"
+        :polling-enabled="$this->pollingEnabled"
+        :polling-interval="$this->pollingInterval"
     />
 </div>