feat(export): add query options for sorting in export feature (#1978)

* feat(export): add query options for sorting in export feature

* feat(export): add query options for sorting in export feature

Author: luanfreitasdev

src/Components/SetUp/Exportable.php

@@ -28,6 +28,8 @@ final class Exportable implements Wireable
 
     public bool $stripTags = false;
 
+    public array $queryOptions = [];
+
     public function __construct(public string $fileName = 'export') {}
 
     public function type(string ...$types): self
@@ -95,6 +97,13 @@ public function onConnection(string $connection): self
         return $this;
     }
 
+    public function queryOptions(array $options): self
+    {
+        $this->queryOptions = $options;
+
+        return $this;
+    }
+
     public function toLivewire(): array
     {
         return (array) $this;

src/Traits/WithExport.php

@@ -195,6 +195,8 @@ public function prepareToExport(bool $selected = false): Eloquent\Collection|Sup
                 : $currentTable.'.'.$property;
         };
 
+        $queryOptions = data_get($this->setUp, 'exportable.queryOptions', []);
+
         $results = $processDataSource->component->datasource()
             ->where(function ($query) {
                 (new SearchHandler($this))->apply($query);
@@ -203,8 +205,11 @@ public function prepareToExport(bool $selected = false): Eloquent\Collection|Sup
             ->when($filtered, function ($query, $filtered) use ($property) {
                 return $query->whereIn($property('primaryKey'), $filtered);
             })
-            ->when($this->sortField, function ($query) use ($property, $processDataSource) {
-                return $query->orderBy($property('sortField'), $processDataSource->component->sortDirection);
+            ->when($this->sortField, function ($query) use ($property, $processDataSource, $queryOptions) {
+                $sortField = $queryOptions['sortField'] ?? $property('sortField');
+                $sortDirection = $queryOptions['sortDirection'] ?? $processDataSource->component->sortDirection;
+
+                return $query->orderBy($sortField, $sortDirection);
             })
             ->get();
 

tests/Feature/ExportTest.php

@@ -1,7 +1,7 @@
 <?php
 
 use OpenSpout\Reader\XLSX\Reader;
-use PowerComponents\LivewirePowerGrid\{Button,Column, PowerGridFields};
+use PowerComponents\LivewirePowerGrid\{Button, Column, Components\SetUp\Exportable, PowerGridFields};
 use PowerComponents\LivewirePowerGrid\Facades\PowerGrid;
 use PowerComponents\LivewirePowerGrid\Tests\Concerns\Components\ExportTable;
 
@@ -224,6 +224,59 @@ public function columns(): array
     'html' => [$exportWithHtml::class],
 ]);
 
+$exportWithQueryOptions = new class() extends ExportTable
+{
+    public string $testSortField = '';
+
+    public string $testSortDirection = '';
+
+    public function setUp(): array
+    {
+        $this->showCheckBox();
+
+        return [
+            PowerGrid::exportable('export')
+                ->type(Exportable::TYPE_XLS, Exportable::TYPE_CSV)
+                ->queryOptions([
+                    'sortField' => $this->testSortField,
+                    'sortDirection' => $this->testSortDirection,
+                ]),
+        ];
+    }
+
+    public function fields(): PowerGridFields
+    {
+        return PowerGrid::fields()
+            ->add('name', function ($dish) {
+                return $dish->name;
+            });
+    }
+
+    public function columns(): array
+    {
+        return [
+            Column::add()
+                ->title('name')
+                ->field('name'),
+        ];
+    }
+};
+
+it('properly exports with query options', function ($component, $options, $expectedRows) {
+    $downloadedFile = livewire($component, $options)
+        ->set('checkboxValues', [0 => '1', 1 => '3'])
+        ->call('exportToCsv', true)
+        ->assertFileDownloaded('export.csv');
+
+    expect($downloadedFile)->toBeCsvDownload(['name'], $expectedRows);
+
+})->with('export_with_query_options')->requiresOpenSpout();
+
+dataset('export_with_query_options', [
+    'desc' => [$exportWithQueryOptions::class, ['testSortField' => 'name', 'testSortDirection' => 'desc'], [['Pastel de Nata'], ['Carne Louca']]],
+    'asc' => [$exportWithQueryOptions::class, ['testSortField' => 'name', 'testSortDirection' => 'asc'], [['Carne Louca'], ['Pastel de Nata']]],
+]);
+
 /*
 |--------------------------------------------------------------------------
 | Expectations for this test