Merge pull request #55 from kirschbaum-development/ISSUE-54

Refactor CommentList component to always utilize getComments method directly

Author: navneetrai

.github/workflows/ci.yml

@@ -12,6 +12,7 @@ jobs:
       php: 8.4
       laravel: 12
       testbench: 10
+      filament: 4
       larastan: 3
       pint: 1
 
@@ -57,6 +58,7 @@ jobs:
       php: 8.4
       laravel: 12
       testbench: 10
+      filament: 4
       larastan: 3
       pint: 1
 
@@ -108,10 +110,12 @@ jobs:
         include:
           - laravel: 11
             testbench: 9
+            filament: 4
             larastan: 3
             pint: 1
           - laravel: 12
             testbench: 10
+            filament: 4
             larastan: 3
             pint: 1
 

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;
 }
 ```
 

resources/dist/commentions.css

@@ -18,13 +18,15 @@ class="comm:w-4 comm:h-4 comm:text-gray-700 comm:dark:text-gray-300"
                     wire:loading.attr="disabled"
                     color="gray"
                     size="xs"
-                    class="comm:w-full comm:mb-2"
+                    class="comm:w-full comm:mb-2 comm:inline-flex comm:items-center comm:whitespace-nowrap"
                 >
-                    <x-filament::icon
-                        icon="heroicon-s-bell-slash"
-                        class="comm:w-3 comm:h-3 comm:mr-1"
-                    />
-                    Unsubscribe
+                    <span class="comm:inline-flex comm:items-center comm:gap-1 comm:whitespace-nowrap">
+                        <x-filament::icon
+                            icon="heroicon-s-bell-slash"
+                            class="comm:w-3 comm:h-3 comm:flex-shrink-0"
+                        />
+                        <span>Unsubscribe</span>
+                    </span>
                 </x-filament::button>
             @else
                 <x-filament::button
@@ -33,13 +35,15 @@ class="comm:w-3 comm:h-3 comm:mr-1"
                     wire:loading.attr="disabled"
                     color="gray"
                     size="xs"
-                    class="comm:w-full comm:mb-2"
+                    class="comm:w-full comm:mb-2 comm:inline-flex comm:items-center comm:whitespace-nowrap"
                 >
-                    <x-filament::icon
-                        icon="heroicon-o-bell"
-                        class="comm:w-3 comm:h-3 comm:mr-1"
-                    />
-                    Subscribe
+                    <span class="comm:inline-flex comm:items-center comm:gap-1 comm:whitespace-nowrap">
+                        <x-filament::icon
+                            icon="heroicon-o-bell"
+                            class="comm:w-3 comm:h-3 comm:flex-shrink-0"
+                        />
+                        <span>Subscribe</span>
+                    </span>
                 </x-filament::button>
             @endif
 

resources/views/subscription-sidebar.blade.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/HasComments.php

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

src/Livewire/CommentList.php

@@ -0,0 +1,102 @@
+<?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;
+
+test('CommentList calls getComments when not paginating', function () {
+    /** @var Post|Mockery\MockInterface $post */
+    $post = Mockery::mock(Post::class)->makePartial();
+
+    $post->shouldReceive('getComments')
+        ->once()
+        ->andReturn(collect());
+
+    $component = livewire(CommentList::class, [
+        'record' => $post,
+        'paginate' => false,
+    ]);
+
+    $component->get('comments');
+});
+
+test('CommentList calls getComments when paginating', function () {
+    /** @var Post|Mockery\MockInterface $post */
+    $post = Mockery::mock(Post::class)->makePartial();
+
+    $post->shouldReceive('getComments')
+        ->once()
+        ->andReturn(collect());
+
+    $component = livewire(CommentList::class, [
+        'record' => $post,
+        'paginate' => true,
+        'perPage' => 5,
+    ]);
+
+    $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');
+});

tests/Livewire/CommentListTest.php

@@ -2,6 +2,8 @@
 
 namespace Tests;
 
+use BladeUI\Heroicons\BladeHeroiconsServiceProvider;
+use BladeUI\Icons\BladeIconsServiceProvider;
 use Filament\FilamentServiceProvider;
 use Filament\Support\SupportServiceProvider;
 use Illuminate\Database\Schema\Blueprint;
@@ -26,10 +28,12 @@ protected function setUp(): void
     protected function getPackageProviders($app)
     {
         return [
-            LivewireServiceProvider::class,
+            BladeIconsServiceProvider::class,
+            BladeHeroiconsServiceProvider::class,
             CommentionsServiceProvider::class,
             FilamentServiceProvider::class,
             SupportServiceProvider::class,
+            LivewireServiceProvider::class,
         ];
     }