Enhance getComments method to support optional limit parameter and update CommentList component to utilize this feature.

Author: navneetrai

README.md

@@ -540,7 +540,7 @@ Sometimes you might want to render non-Comments in the list of comments. For exa
 ```php
 use Kirschbaum\Commentions\RenderableComment;
 
-public function getComments(): Collection
+public function getComments(?int $limit = null): Collection
 {
     $statusHistory = $this->statusHistory()->get()->map(fn (StatusHistory $statusHistory) => new RenderableComment(
         id: $statusHistory->id,
@@ -551,7 +551,13 @@ public function getComments(): Collection
 
     $comments = $this->comments()->latest()->with('author')->get();
 
-    return $statusHistory->merge($comments);
+    $mergedCollection = $statusHistory->merge($comments);
+
+    if ($limit) {
+        return $mergedCollection->take($limit);
+    }
+
+    return $mergedCollection;
 }
 ```
 

src/HasComments.php

@@ -26,8 +26,12 @@ public function comment(string $body, ?Commenter $author): Comment
         return SaveComment::run($this, $author, $body);
     }
 
-    public function getComments(): Collection
+    public function getComments(?int $limit = null): Collection
     {
+        if ($limit) {
+            return $this->commentsQuery()->limit($limit)->get();
+        }
+
         return $this->commentsQuery()->get();
     }
 

src/Livewire/CommentList.php

@@ -27,11 +27,7 @@ public function render()
     #[Computed]
     public function comments(): Collection
     {
-        if (! $this->paginate) {
-            return $this->record->getComments();
-        }
-
-        return $this->record->getComments()->take($this->perPage);
+        return $this->record->getComments($this->paginate ? $this->perPage : null);
     }
 
     #[On('comment:saved')]

tests/Livewire/CommentListTest.php

@@ -1,8 +1,11 @@
 <?php
 
+use Kirschbaum\Commentions\Comment as CommentModel;
 use Kirschbaum\Commentions\Livewire\CommentList;
+use Kirschbaum\Commentions\RenderableComment;
 use Mockery;
 use Tests\Models\Post;
+use Tests\Models\User;
 
 use function Pest\Livewire\livewire;
 
@@ -38,3 +41,62 @@
 
     $component->get('comments');
 });
+
+test('CommentList can render non-Comment renderable items', function () {
+    /** @var Post|Mockery\MockInterface $post */
+    $post = Mockery::mock(Post::class)->makePartial();
+
+    $items = collect([
+        new RenderableComment(id: 1, authorName: 'System', body: 'System notice 1'),
+        new RenderableComment(id: 2, authorName: 'Bot', body: 'Automated message'),
+    ]);
+
+    $post->shouldReceive('getComments')
+        ->once()
+        ->andReturn($items);
+
+    livewire(CommentList::class, [
+        'record' => $post,
+        'paginate' => false,
+    ])
+        ->assertSee('System')
+        ->assertSee('System notice 1')
+        ->assertSee('Bot')
+        ->assertSee('Automated message');
+});
+
+test('CommentList can render both Comment and RenderableComment items', function () {
+    /** @var User $user */
+    $user = User::factory()->create();
+    /** @var Post $realPost */
+    $realPost = Post::factory()->create();
+
+    /** @var CommentModel $comment */
+    $comment = CommentModel::factory()
+        ->author($user)
+        ->commentable($realPost)
+        ->create([
+            'body' => 'Real comment body',
+        ]);
+
+    $renderable = new RenderableComment(id: 99, authorName: 'System', body: 'System message');
+
+    $items = collect([$comment, $renderable]);
+
+    /** @var Post|Mockery\MockInterface $post */
+    $post = Mockery::mock(Post::class)->makePartial();
+    $post->shouldReceive('getComments')
+        ->once()
+        ->andReturn($items);
+
+    livewire(CommentList::class, [
+        'record' => $post,
+        'paginate' => false,
+    ])
+        // From Eloquent Comment
+        ->assertSee('Real comment body')
+        ->assertSee($user->name)
+        // From RenderableComment
+        ->assertSee('System')
+        ->assertSee('System message');
+});