Feature/is empty when in model importer (#3828)

* Add isEmptyWhen check to ModelImporter * Formatting * Test added * Test added * StyleCI * fix: test * fix: test
SpartnerNL · Jun 19, 2023 · 9e5b7ca · 9e5b7ca
1 parent 9bb6a56
commit 9e5b7ca
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/src/Imports/ModelImporter.php b/src/Imports/ModelImporter.php
@@ -64,6 +64,10 @@ public function import(Worksheet $worksheet, ToModel $import, int $startRow = 1)
             if (!$import instanceof SkipsEmptyRows || ($import instanceof SkipsEmptyRows && !$row->isEmpty($withCalcFormulas))) {
                 $rowArray = $row->toArray(null, $withCalcFormulas, $formatData, $endColumn);
 
+                if ($import instanceof SkipsEmptyRows && method_exists($import, 'isEmptyWhen') && $import->isEmptyWhen($rowArray)) {
+                    continue;
+                }
+
                 if ($withValidation) {
                     $rowArray = $import->prepareForValidation($rowArray, $row->getIndex());
                 }

diff --git a/tests/Concerns/SkipsEmptyRowsTest.php b/tests/Concerns/SkipsEmptyRowsTest.php
@@ -134,4 +134,35 @@ public function isEmptyWhen(array $row)
         $import->import('import-empty-rows.xlsx');
         $this->assertTrue($import->called);
     }
+
+    /**
+     * @test
+     */
+    public function custom_skips_rows_when_importing_to_model()
+    {
+        $import = new class implements SkipsEmptyRows, ToModel
+        {
+            use Importable;
+
+            public $called = false;
+
+            /**
+             * @param  array  $row
+             */
+            public function model(array $row)
+            {
+                Assert::assertEquals('Not empty', $row[0]);
+            }
+
+            public function isEmptyWhen(array $row): bool
+            {
+                $this->called = true;
+
+                return $row[0] === 'Empty';
+            }
+        };
+
+        $import->import('skip-empty-rows-with-is-empty-when.xlsx');
+        $this->assertTrue($import->called);
+    }
 }
diff --git a/tests/Data/Disks/Local/skip-empty-rows-with-is-empty-when.xlsx b/tests/Data/Disks/Local/skip-empty-rows-with-is-empty-when.xlsx