Merge pull request #323 from CodeWithDennis/add-description-tests

Add description tests

Author: CodeWithDennis

README.md

@@ -46,6 +46,8 @@ This package generates comprehensive PEST tests for your Filament resources. Her
 - **ShowsColumnTest** - Tests that explicitly visible columns are shown
 - **HidesColumnTest** - Tests that explicitly hidden columns are hidden
 - **CanNotDisplayTrashedRecordsByDefault** - Tests that trashed records are not displayed by default if soft deletes are enabled
+- **ColumnHasDescriptionBelowTest** - Tests that columns with descriptions display them below
+- **ColumnHasDescriptionAboveTest** - Tests that columns with descriptions display them above
 
 ### Table Functionality Tests
 - **CanSearchColumnTest** - Tests that searchable columns work correctly

resources/views/resources/pages/index/column-has-description-above.blade.php

@@ -0,0 +1,12 @@
+it('`:dataset` column has the correct description above', function (string $column, string $content): void {
+    $records = {{ $getResourceModel() }}::factory(10)->create();
+
+    $record = $records->first();
+
+    livewire({{ $getPageClass('index') }}::class)
+        ->assertTableColumnHasDescription($column, $content, $record, 'above');
+})->with([
+@foreach ($getResourceTableTextColumnsWithDescriptionAbove()->mapWithKeys(fn (Filament\Tables\Columns\TextColumn $column) => [$column->getName() => $column->getDescriptionAbove()]) as $column => $content)
+    ['{{ $column }}', '{{ $content }}'],
+@endforeach
+]);

resources/views/resources/pages/index/column-has-description-below.blade.php

@@ -0,0 +1,12 @@
+it('`:dataset` column has the correct description below', function (string $column, string $content): void {
+    $records = {{ $getResourceModel() }}::factory(10)->create();
+
+    $record = $records->first();
+
+    livewire({{ $getPageClass('index') }}::class)
+        ->assertTableColumnHasDescription($column, $content, $record, 'below');
+})->with([
+@foreach ($getResourceTableTextColumnsWithDescriptionBelow()->mapWithKeys(fn (Filament\Tables\Columns\TextColumn $column) => [$column->getName() => $column->getDescriptionBelow()]) as $column => $content)
+    ['{{ $column }}', '{{ $content }}'],
+@endforeach
+]);

src/Commands/FilamentTestsCommand.php

@@ -17,6 +17,8 @@
 use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\CanSearchColumnIndividuallyTest;
 use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\CanSearchColumnTest;
 use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\CanSortColumnTest;
+use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\ColumnHasDescriptionAboveTest;
+use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\ColumnHasDescriptionBelowTest;
 use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\HasColumnTest;
 use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\HidesColumnTest;
 use CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index\ShowsColumnTest;
@@ -68,6 +70,8 @@ protected function getRenderers(): array
             HasColumnTest::class,
             ShowsColumnTest::class,
             HidesColumnTest::class,
+            ColumnHasDescriptionAboveTest::class,
+            ColumnHasDescriptionBelowTest::class,
             CanSortColumnTest::class,
             CanSearchColumnTest::class,
             CanSearchColumnIndividuallyTest::class,

src/Concerns/Resources/InteractsWithTables.php

@@ -5,6 +5,7 @@
 use Filament\Actions\Action;
 use Filament\Resources\Pages\ListRecords;
 use Filament\Tables\Columns\Column;
+use Filament\Tables\Columns\TextColumn;
 use Filament\Tables\Table;
 use Illuminate\Support\Collection;
 
@@ -137,4 +138,27 @@ public function getResourceTableDefaultPaginationPageOption(): ?int
     {
         return $this->getResourceTable()->getDefaultPaginationPageOption();
     }
+
+    public function getResourceTableTextColumns(): Collection
+    {
+        return $this->getResourceTableColumns()
+            ->filter(fn (Column $column): bool => $column instanceof TextColumn);
+    }
+
+    public function getResourceTableTextColumnKeys(): array
+    {
+        return $this->getResourceTableColumnKeysFrom($this->getResourceTableTextColumns());
+    }
+
+    public function getResourceTableTextColumnsWithDescriptionAbove(): Collection
+    {
+        return $this->getResourceTableTextColumns()
+            ->filter(fn (TextColumn $column): bool => filled($column->getDescriptionAbove()));
+    }
+
+    public function getResourceTableTextColumnsWithDescriptionBelow(): Collection
+    {
+        return $this->getResourceTableTextColumns()
+            ->filter(fn (TextColumn $column): bool => filled($column->getDescriptionBelow()));
+    }
 }

src/TestRenderers/Resources/Pages/Index/ColumnHasDescriptionAboveTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index;
+
+use CodeWithDennis\FilamentTests\TestRenderers\BaseTest;
+
+class ColumnHasDescriptionAboveTest extends BaseTest
+{
+    public ?string $view = 'filament-tests::resources.pages.index.column-has-description-above';
+
+    public function getShouldRender(): bool
+    {
+        return $this->hasPage('index')
+            && $this->getResourceTableTextColumnsWithDescriptionAbove()->isNotEmpty();
+    }
+}

src/TestRenderers/Resources/Pages/Index/ColumnHasDescriptionBelowTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace CodeWithDennis\FilamentTests\TestRenderers\Resources\Pages\Index;
+
+use CodeWithDennis\FilamentTests\TestRenderers\BaseTest;
+
+class ColumnHasDescriptionBelowTest extends BaseTest
+{
+    public ?string $view = 'filament-tests::resources.pages.index.column-has-description-below';
+
+    public function getShouldRender(): bool
+    {
+        return $this->hasPage('index')
+            && $this->getResourceTableTextColumnsWithDescriptionBelow()->isNotEmpty();
+    }
+}