Added an ability to prepare rows before appending (SpartnerNL#2892)

* added an ability to prepare rows before appinding

* added test

* revert composer

* changed test

* changed collection to array

* updated changelog file

* revert phpunit

Author: siarheipashkevich

CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+
+- Added an ability to prepare rows before appending rows to sheet. Just add `prepareRows` method for your export class if needed.
+
 ## [3.1.24] - 2020-10-28
 
 ### Added

src/Sheet.php

@@ -586,6 +586,10 @@ public function hasConcern(string $concern): string
      */
     public function appendRows($rows, $sheetExport)
     {
+        if (method_exists($sheetExport, 'prepareRows')) {
+            $rows = $sheetExport->prepareRows($rows);
+        }
+
         $rows = (new Collection($rows))->flatMap(function ($row) use ($sheetExport) {
             if ($sheetExport instanceof WithMapping) {
                 $row = $sheetExport->map($row);

tests/Concerns/FromQueryTest.php

@@ -4,14 +4,15 @@
 
 use Illuminate\Foundation\Testing\DatabaseTransactions;
 use Illuminate\Support\Facades\DB;
+use Maatwebsite\Excel\Tests\TestCase;
 use Maatwebsite\Excel\Tests\Data\Stubs\Database\Group;
 use Maatwebsite\Excel\Tests\Data\Stubs\Database\User;
 use Maatwebsite\Excel\Tests\Data\Stubs\FromGroupUsersQueuedQueryExport;
 use Maatwebsite\Excel\Tests\Data\Stubs\FromNestedArraysQueryExport;
 use Maatwebsite\Excel\Tests\Data\Stubs\FromNonEloquentQueryExport;
 use Maatwebsite\Excel\Tests\Data\Stubs\FromUsersQueryExport;
 use Maatwebsite\Excel\Tests\Data\Stubs\FromUsersQueryExportWithEagerLoad;
-use Maatwebsite\Excel\Tests\TestCase;
+use Maatwebsite\Excel\Tests\Data\Stubs\FromUsersQueryExportWithPrepareRows;
 
 class FromQueryTest extends TestCase
 {
@@ -245,4 +246,28 @@ protected function format_nested_arrays_expected_data($groups)
 
         return $expected;
     }
+
+    /**
+     * @test
+     */
+    public function can_export_from_query_with_prepare_rows()
+    {
+        $export = new FromUsersQueryExportWithPrepareRows;
+
+        $this->assertTrue(method_exists($export, 'prepareRows'));
+
+        $response = $export->store('from-query-store.xlsx');
+
+        $this->assertTrue($response);
+
+        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-store.xlsx', 'Xlsx');
+
+        $allUsers = $export->query()->get()->map(function (User $user) {
+            $user->name .= '_prepared_name';
+
+            return array_values($user->toArray());
+        })->toArray();
+
+        $this->assertEquals($allUsers, $contents);
+    }
 }

tests/Data/Stubs/FromUsersQueryExportWithPrepareRows.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Maatwebsite\Excel\Tests\Data\Stubs;
+
+use Illuminate\Database\Query\Builder;
+use Illuminate\Support\Collection;
+use Maatwebsite\Excel\Concerns\FromQuery;
+use Maatwebsite\Excel\Concerns\Exportable;
+use Maatwebsite\Excel\Concerns\WithCustomChunkSize;
+use Maatwebsite\Excel\Tests\Data\Stubs\Database\User;
+
+class FromUsersQueryExportWithPrepareRows implements FromQuery, WithCustomChunkSize
+{
+    use Exportable;
+
+    /**
+     * @return Builder
+     */
+    public function query()
+    {
+        return User::query();
+    }
+
+    /**
+     * @return int
+     */
+    public function chunkSize(): int
+    {
+        return 10;
+    }
+
+    /**
+     * @param iterable $rows
+     * @return iterable
+     */
+    public function prepareRows($rows)
+    {
+        return (new Collection($rows))->map(function ($user) {
+            $user->name .= '_prepared_name';
+
+            return $user;
+        })->toArray();
+    }
+}