add suport for LazyCollections

Author: vitorccs

.github/workflows/php.yml

@@ -15,3 +15,4 @@ jobs:
         uses: php-actions/phpunit@v3
         with:
           configuration: phpunit.xml.dist
+          version: 9.5

README.md

@@ -11,7 +11,7 @@ The memory usage is optimized in this project by retrieving small chunks of resu
 This project is using some of Laravel-Excel design principles because it is both a solid work and a reference, and by doing that, it also reduces the learning curve and adoption to this library.
 
 # Requirements
-* PHP >= 7.4
+* PHP >= 8.0
 * Laravel >= 6.x
 
 # Installation
@@ -27,9 +27,9 @@ php artisan vendor:publish --provider="Vitorccs\LaravelCsv\ServiceProviders\CsvS
 
 Step 3) Edit your local `config\csv.php` file per your project preferences
 
-Step 4) Create an Export class file as show below.
+Step 4) Create an Export class file as shown below
 
-Note: you may implement _FromArray_, _FromCollection_ or _FromQuery_
+Note: you may implement _FromArray_, _FromCollection_ or _FromQuery_ 
 
 ```php
 namespace App\Exports;
@@ -77,6 +77,7 @@ $filename = CsvHelper::filename();
 ```
 
 # Data sources
+Note: only `FromQuery` can chunk results per `chunk_size` parameter from config file.
 
 ## Laravel Eloquent Query Builder
 ```php
@@ -121,15 +122,14 @@ class MyQueryExport implements FromQuery
 ```php
 namespace App\Exports;
 
-use Illuminate\Support\Collection;
 use Vitorccs\LaravelCsv\Concerns\Exportable;
 use Vitorccs\LaravelCsv\Concerns\FromCollection;
 
 class MyCollectionExport implements FromCollection
 {
     use Exportable;
 
-    public function collection(): Collection
+    public function collection()
     {
         return collect([
             ['a1', 'b1', 'c1'],
@@ -140,6 +140,25 @@ class MyCollectionExport implements FromCollection
 }
 ```
 
+## Laravel LazyCollection
+```php
+namespace App\Exports;
+
+use App\User;
+use Vitorccs\LaravelCsv\Concerns\Exportable;
+use Vitorccs\LaravelCsv\Concerns\FromCollection;
+
+class MyQueryExport implements FromCollection
+{
+    use Exportable;
+    
+    public function collection()
+    {
+        return User::cursor();
+    }
+}
+```
+
 ## PHP Arrays
 ```php
 namespace App\Exports;

composer.json

@@ -15,7 +15,7 @@
         }
     ],
     "require": {
-        "php": ">=7.4"
+        "php": ">=8.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

src/Concerns/WithMapping.php

@@ -5,7 +5,7 @@
 interface WithMapping
 {
     /**
-     * @param  mixed  $row
+     * @param mixed $row
      * @return array
      */
     public function map($row): array;

src/Helpers/FormatterHelper.php

@@ -2,12 +2,10 @@
 
 namespace Vitorccs\LaravelCsv\Helpers;
 
-use Carbon\Carbon;
-
 class FormatterHelper
 {
     /**
-     * @param Carbon|\DateTime|string $date
+     * @param \DateTime|string $date
      * @param string $format
      * @return string
      */
@@ -21,7 +19,7 @@ public static function date($date, string $format): string
     }
 
     /**
-     * @param int|float|string $number
+     * @param float|int|string $number
      * @param int $decimals
      * @param string $decimalSep
      * @param string $thousandsSep

src/Services/ExportableService.php

@@ -10,7 +10,6 @@
 use Vitorccs\LaravelCsv\Concerns\FromArray;
 use Vitorccs\LaravelCsv\Concerns\FromCollection;
 use Vitorccs\LaravelCsv\Concerns\FromQuery;
-use Vitorccs\LaravelCsv\Concerns\FromQueryCursor;
 use Vitorccs\LaravelCsv\Entities\CsvConfig;
 use Vitorccs\LaravelCsv\Exceptions\InvalidCellValueException;
 use Vitorccs\LaravelCsv\Handlers\ArrayHandler;
@@ -63,7 +62,7 @@ public function count(object $exportable): int
             return $exportable->collection()->count();
         }
 
-        if ($exportable instanceof FromQuery || $exportable instanceof FromQueryCursor) {
+        if ($exportable instanceof FromQuery) {
             return $exportable->query()->count();
         }
 

src/Services/FormatterService.php

@@ -2,7 +2,6 @@
 
 namespace Vitorccs\LaravelCsv\Services;
 
-use Carbon\Carbon;
 use Vitorccs\LaravelCsv\Entities\CsvConfig;
 use Vitorccs\LaravelCsv\Helpers\FormatterHelper;
 
@@ -22,7 +21,7 @@ public function __construct(CsvConfig $config)
     }
 
     /**
-     * @param Carbon|\DateTime|string $date
+     * @param \DateTime|string $date
      * @return string
      */
     public function date($date): string
@@ -31,7 +30,7 @@ public function date($date): string
     }
 
     /**
-     * @param Carbon|\DateTime|string $date
+     * @param \DateTime|string $date
      * @return string
      */
     public function datetime($date): string

src/Services/Writer.php

@@ -3,12 +3,9 @@
 namespace Vitorccs\LaravelCsv\Services;
 
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Support\Collection;
-use Throwable;
 use Vitorccs\LaravelCsv\Concerns\FromArray;
 use Vitorccs\LaravelCsv\Concerns\FromCollection;
 use Vitorccs\LaravelCsv\Concerns\FromQuery;
-use Vitorccs\LaravelCsv\Concerns\FromQueryCursor;
 use Vitorccs\LaravelCsv\Concerns\WithColumnFormatting;
 use Vitorccs\LaravelCsv\Concerns\WithHeadings;
 use Vitorccs\LaravelCsv\Concerns\WithMapping;
@@ -54,11 +51,17 @@ public function generate(object $exportable)
 
         if ($exportable instanceof FromArray) {
             $rows = $exportable->array();
+            if ($exportable->limit()) {
+                $rows = array_splice($rows, 0, $exportable->limit());
+            }
             $this->iterateRows($exportable, $rows);
         }
 
         if ($exportable instanceof FromCollection) {
             $rows = $exportable->collection();
+            if ($exportable->limit()) {
+                $rows = $rows->take($exportable->limit());
+            }
             $this->iterateRows($exportable, $rows);
         }
 
@@ -72,20 +75,17 @@ public function generate(object $exportable)
             );
         }
 
-        if ($exportable instanceof FromQueryCursor) {
-            $this->iterateRows($exportable, $exportable->query()->cursor());
-        }
-
         return $this->handler->getResource();
     }
 
     /**
      * @param object $exportable
-     * @param Collection|array $rows
+     * @param iterable $rows
      * @return void
      * @throws InvalidCellValueException
      */
-    private function iterateRows(object $exportable, $rows): void
+    private function iterateRows(object   $exportable,
+                                 iterable $rows): void
     {
         $formats = $exportable instanceof WithColumnFormatting ? $exportable->columnFormats() : [];
         $withMapping = $exportable instanceof WithMapping;
@@ -98,7 +98,11 @@ private function iterateRows(object $exportable, $rows): void
         }
     }
 
-    private function normalizeRow($row): array
+    /**
+     * @param mixed $row
+     * @return array
+     */
+    private function normalizeRow(mixed $row): array
     {
         if ($row instanceof Model) {
             $row = ModelHelper::toArrayValues($row);
@@ -113,12 +117,18 @@ private function normalizeRow($row): array
     }
 
     /**
+     * @param array $row
+     * @param array $formats
+     * @param int $rowIndex
+     * @return array
      * @throws InvalidCellValueException
      */
-    private function applyFormatting(array $row, array $formats, int $rowIndex): array
+    private function applyFormatting(array $row,
+                                     array $formats,
+                                     int   $rowIndex): array
     {
         return array_map(
-            fn ($value, int $columnIndex) => $this->formatCellValue($value, $formats, $rowIndex, $columnIndex),
+            fn($value, int $columnIndex) => $this->formatCellValue($value, $formats, $rowIndex, $columnIndex),
             $row,
             array_keys($row)
         );
@@ -127,7 +137,10 @@ private function applyFormatting(array $row, array $formats, int $rowIndex): arr
     /**
      * @throws InvalidCellValueException
      */
-    private function formatCellValue($value, array $formats, int $rowIndex, int $columnIndex): string
+    private function formatCellValue(mixed $value,
+                                     array $formats,
+                                     int   $rowIndex,
+                                     int   $columnIndex): string
     {
         $columnLetter = CsvHelper::getColumnLetter($columnIndex + 1);
         $format = $formats[$columnLetter] ?? null;
@@ -149,10 +162,10 @@ private function formatCellValue($value, array $formats, int $rowIndex, int $col
         }
 
         try {
-            if (! is_string($value)) {
+            if (!is_string($value)) {
                 return (string)$value;
             }
-        } catch (Throwable $e) {
+        } catch (\Throwable $e) {
             throw new InvalidCellValueException("{$columnLetter}{$rowIndex}");
         }
 

tests/Concerns/FromCollectionTest.php

@@ -2,13 +2,22 @@
 
 namespace Vitorccs\LaravelCsv\Tests\Concerns;
 
+use Vitorccs\LaravelCsv\Tests\Data\Database\Seeders\TestUsersSeeder;
 use Vitorccs\LaravelCsv\Tests\Data\Exports\FromCollectionExport;
+use Vitorccs\LaravelCsv\Tests\Data\Exports\FromCursorExport;
 use Vitorccs\LaravelCsv\Tests\TestCase;
 
 class FromCollectionTest extends TestCase
 {
     protected string $filename = 'from_collection.csv';
 
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->seed(TestUsersSeeder::class);
+    }
+
     public function test_from_collection()
     {
         $export = new FromCollectionExport();
@@ -18,4 +27,14 @@ public function test_from_collection()
 
         $this->assertEquals($export->toArray(), $contents);
     }
+
+    public function test_from_cursor()
+    {
+        $export = new FromCursorExport();
+
+        $export->store($this->filename);
+        $contents = $this->readFromDisk($this->filename);
+
+        $this->assertEquals($export->toArray(), $contents);
+    }
 }