faster spreadsheet exporter based on opensout and other export improvements (#5238)

2024-12-22 18:36:47 +01:00
parent c7f0508707
commit 136104d4b0
80 changed files with 2023 additions and 1699 deletions
--- a/tests/Export/Package/PhpOfficeSpreadsheetTest.php
+++ b/tests/Export/Package/PhpOfficeSpreadsheetTest.php
@@ -0,0 +1,121 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Export\Package;
+
+use App\Export\Package\PhpOfficeSpreadsheet;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\PhpOfficeSpreadsheet
+ */
+class PhpOfficeSpreadsheetTest extends TestCase
+{
+    private string $filename;
+    private int $counter = 1;
+
+    protected function setUp(): void
+    {
+        $this->filename = realpath(__DIR__ . '/../../_data/') . '/test' . $this->counter++ . '.xlsx';
+    }
+
+    protected function tearDown(): void
+    {
+        if (file_exists($this->filename)) {
+            unlink($this->filename);
+        }
+    }
+
+    public function testopenSetsFilename(): void
+    {
+        $spreadsheetPackage = new PhpOfficeSpreadsheet();
+        $spreadsheetPackage->open($this->filename);
+        $reflection = new \ReflectionClass($spreadsheetPackage);
+        $property = $reflection->getProperty('filename');
+        $property->setAccessible(true);
+        self::assertEquals($this->filename, $property->getValue($spreadsheetPackage));
+    }
+
+    public function testsaveThrowsExceptionWhenFilenameIsNull(): void
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('Need to call open() first before save()');
+
+        $spreadsheetPackage = new PhpOfficeSpreadsheet();
+        $spreadsheetPackage->save();
+    }
+
+    public function testsaveWritesFile(): void
+    {
+        $spreadsheetPackage = new PhpOfficeSpreadsheet();
+        $spreadsheetPackage->open($this->filename);
+        $spreadsheetPackage->setHeader(['Foo', 'Bar']);
+        $spreadsheetPackage->addRow(['Data1', 'Data2']);
+        $spreadsheetPackage->addRow(['Data3', 'Data4']);
+        $spreadsheetPackage->save();
+
+        self::assertGreaterThan(0, filesize($this->filename));
+    }
+
+    public function testsaveThrowsExceptionWhenSpreadsheetIsNull(): void
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('Cannot re-use spreadsheet after calling save()');
+
+        $spreadsheetPackage = new PhpOfficeSpreadsheet();
+        $spreadsheetPackage->open($this->filename);
+        $spreadsheetPackage->save();
+        $spreadsheetPackage->save();
+    }
+
+    public function testsetHeaderSetsHeaderRow(): void
+    {
+        $spreadsheetPackage = new PhpOfficeSpreadsheet();
+        $spreadsheetPackage->open($this->filename);
+        $spreadsheetPackage->setHeader(['Column1', 'Column2']);
+
+        $reflection = new \ReflectionClass($spreadsheetPackage);
+        $property = $reflection->getProperty('worksheet');
+        $property->setAccessible(true);
+        /** @var Worksheet $worksheet */
+        $worksheet = $property->getValue($spreadsheetPackage);
+
+        self::assertNotNull($worksheet);
+        self::assertEquals('Column1', $worksheet->getCell('A1')->getValue());
+        self::assertEquals('Column2', $worksheet->getCell('B1')->getValue());
+    }
+
+    public function testaddRowAddsDataRow(): void
+    {
+        $spreadsheetPackage = new PhpOfficeSpreadsheet();
+        $spreadsheetPackage->open($this->filename);
+        $spreadsheetPackage->addRow(['Data1', 'Data2']);
+
+        $reflection = new \ReflectionClass($spreadsheetPackage);
+        $property = $reflection->getProperty('worksheet');
+        $property->setAccessible(true);
+        /** @var Worksheet $worksheet */
+        $worksheet = $property->getValue($spreadsheetPackage);
+
+        self::assertEquals('Data1', $worksheet->getCell('A1')->getValue());
+        self::assertEquals('Data2', $worksheet->getCell('B1')->getValue());
+    }
+
+    public function testaddRowThrowsExceptionWhenSpreadsheetIsNull(): void
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('Cannot re-use spreadsheet after calling save()');
+
+        $spreadsheetPackage = new PhpOfficeSpreadsheet();
+        $spreadsheetPackage->open($this->filename);
+        $spreadsheetPackage->save();
+        $spreadsheetPackage->addRow(['Data1', 'Data2']);
+    }
+}