Support exporting relation queries (SpartnerNL#2089)

Author: patrickbrouwers

src/Jobs/AppendQueryToSheet.php

@@ -3,6 +3,7 @@
 namespace Maatwebsite\Excel\Jobs;
 
 use Illuminate\Bus\Queueable;
+use Maatwebsite\Excel\Cell;
 use Maatwebsite\Excel\Writer;
 use Maatwebsite\Excel\Files\TemporaryFile;
 use Illuminate\Contracts\Queue\ShouldQueue;

src/Jobs/SerializedQuery.php

@@ -3,6 +3,7 @@
 namespace Maatwebsite\Excel\Jobs;
 
 use Closure;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Facades\DB;
 use Opis\Closure\SerializableClosure;
 use Illuminate\Database\Query\Builder;
@@ -37,7 +38,7 @@ class SerializedQuery
     public $with = [];
 
     /**
-     * @param Builder|\Illuminate\Database\Eloquent\Builder $builder
+     * @param Builder|Relation|EloquentBuilder $builder
      */
     public function __construct($builder)
     {
@@ -46,7 +47,7 @@ public function __construct($builder)
         $this->connection = $builder->getConnection()->getName();
         $this->with       = $this->serializeEagerLoads($builder);
 
-        if ($builder instanceof EloquentBuilder) {
+        if ($builder instanceof EloquentBuilder || $builder instanceof Relation) {
             $this->model = get_class($builder->getModel());
         }
     }

tests/Concerns/FromQueryTest.php

@@ -2,7 +2,9 @@
 
 namespace Maatwebsite\Excel\Tests\Concerns;
 
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\DB;
+use Maatwebsite\Excel\Tests\Data\Stubs\FromGroupUsersQueuedQueryExport;
 use Maatwebsite\Excel\Tests\TestCase;
 use Maatwebsite\Excel\Tests\Data\Stubs\Database\User;
 use Maatwebsite\Excel\Tests\Data\Stubs\Database\Group;
@@ -64,6 +66,24 @@ public function can_export_from_query()
         $this->assertEquals($allUsers, $contents);
     }
 
+    /**
+     * @test
+     */
+    public function can_export_from_relation_query_queued()
+    {
+        $export = new FromGroupUsersQueuedQueryExport();
+
+        $export->queue('from-query-store.xlsx');
+
+        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-store.xlsx', 'Xlsx');
+
+        $allUsers = $export->query()->get()->map(function($row) use ($export) {
+            return $export->map($row);
+        })->toArray();
+
+        $this->assertEquals($allUsers, $contents);
+    }
+
     /**
      * @test
      */

tests/Data/Stubs/FromGroupUsersQueuedQueryExport.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Maatwebsite\Excel\Tests\Data\Stubs;
+
+use Illuminate\Database\Query\Builder;
+use Maatwebsite\Excel\Concerns\FromQuery;
+use Maatwebsite\Excel\Concerns\Exportable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Maatwebsite\Excel\Concerns\WithCustomChunkSize;
+use Maatwebsite\Excel\Concerns\WithMapping;
+use Maatwebsite\Excel\Tests\Data\Stubs\Database\Group;
+
+class FromGroupUsersQueuedQueryExport implements FromQuery, WithCustomChunkSize, ShouldQueue, WithMapping
+{
+    use Exportable;
+
+    /**
+     * @return Builder
+     */
+    public function query()
+    {
+        return Group::first()->users();
+    }
+
+    /**
+     * @param mixed $row
+     *
+     * @return array
+     */
+    public function map($row): array
+    {
+        return [
+            $row->name,
+            $row->email,
+        ];
+    }
+
+    /**
+     * @return int
+     */
+    public function chunkSize(): int
+    {
+        return 10;
+    }
+}