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

tests/Export/Package/CellFormatter/ArrayFormatterTest.php

@@ -0,0 +1,42 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\ArrayFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\ArrayFormatter
+ */
+class ArrayFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsCommaSeparatedStringForArray(): void
+    {
+        $formatter = new ArrayFormatter();
+        $result = $formatter->formatValue(['one', 'two', 'three']);
+        self::assertEquals('one, two, three', $result);
+    }
+
+    public function testFormatValueThrowsExceptionForNonArray(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only arrays are supported');
+
+        $formatter = new ArrayFormatter();
+        $formatter->formatValue('not an array');
+    }
+
+    public function testFormatValueReturnsEmptyStringForEmptyArray(): void
+    {
+        $formatter = new ArrayFormatter();
+        $result = $formatter->formatValue([]);
+        self::assertEquals('', $result);
+    }
+}

tests/Export/Package/CellFormatter/BooleanFormatterTest.php

@@ -0,0 +1,77 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\BooleanFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\BooleanFormatter
+ */
+class BooleanFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsFalseForNull(): void
+    {
+        $formatter = new BooleanFormatter();
+        $result = $formatter->formatValue(null);
+        self::assertFalse($result);
+    }
+
+    public function testFormatValueReturnsTrueForTrue(): void
+    {
+        $formatter = new BooleanFormatter();
+        $result = $formatter->formatValue(true);
+        self::assertTrue($result);
+    }
+
+    public function testFormatValueReturnsFalseForFalse(): void
+    {
+        $formatter = new BooleanFormatter();
+        $result = $formatter->formatValue(false);
+        self::assertFalse($result);
+    }
+
+    public function testFormatValueReturnsTrueForNonZeroNumber(): void
+    {
+        $formatter = new BooleanFormatter();
+        $result = $formatter->formatValue(1);
+        self::assertTrue($result);
+    }
+
+    public function testFormatValueReturnsFalseForZero(): void
+    {
+        $formatter = new BooleanFormatter();
+        $result = $formatter->formatValue(0);
+        self::assertFalse($result);
+    }
+
+    public function testFormatValueReturnsTrueForNonEmptyString(): void
+    {
+        $formatter = new BooleanFormatter();
+        $result = $formatter->formatValue('non-empty');
+        self::assertTrue($result);
+    }
+
+    public function testFormatValueReturnsFalseForEmptyString(): void
+    {
+        $formatter = new BooleanFormatter();
+        $result = $formatter->formatValue('');
+        self::assertFalse($result);
+    }
+
+    public function testFormatValueThrowsExceptionForNonScalar(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only scalar values are supported');
+
+        $formatter = new BooleanFormatter();
+        $formatter->formatValue([]);
+    }
+}

tests/Export/Package/CellFormatter/DateFormatterTest.php

@@ -0,0 +1,43 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\DateFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\DateFormatter
+ */
+class DateFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsFormattedDateForDateTime(): void
+    {
+        $formatter = new DateFormatter();
+        $date = new \DateTime('2023-10-01');
+        $result = $formatter->formatValue($date);
+        self::assertEquals('2023-10-01', $result);
+    }
+
+    public function testFormatValueReturnsNullForNullValue(): void
+    {
+        $formatter = new DateFormatter();
+        $result = $formatter->formatValue(null);
+        self::assertNull($result);
+    }
+
+    public function testFormatValueThrowsExceptionForNonDateTime(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only DateTimeInterface can be formatted');
+
+        $formatter = new DateFormatter();
+        $formatter->formatValue('not a date');
+    }
+}

tests/Export/Package/CellFormatter/DefaultFormatterTest.php

@@ -0,0 +1,56 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\DefaultFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\DefaultFormatter
+ */
+class DefaultFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsSameValueForScalar(): void
+    {
+        $formatter = new DefaultFormatter();
+        $result = $formatter->formatValue('string');
+        self::assertEquals('string', $result);
+
+        $result = $formatter->formatValue(123);
+        self::assertEquals(123, $result);
+
+        $result = $formatter->formatValue(45.67);
+        self::assertEquals(45.67, $result);
+
+        $result = $formatter->formatValue(true);
+        self::assertTrue($result);
+
+        $result = $formatter->formatValue(null);
+        self::assertNull($result);
+    }
+
+    public function testFormatValueThrowsExceptionForNonScalar(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only scalar values are supported');
+
+        $formatter = new DefaultFormatter();
+        $formatter->formatValue([]);
+    }
+
+    public function testFormatValueThrowsExceptionForObject(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only scalar values are supported');
+
+        $formatter = new DefaultFormatter();
+        $formatter->formatValue(new \stdClass());
+    }
+}

tests/Export/Package/CellFormatter/DurationFormatterTest.php

@@ -0,0 +1,54 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\DurationFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\DurationFormatter
+ */
+class DurationFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsFormattedDurationForNumericValue(): void
+    {
+        $formatter = new DurationFormatter();
+        $result = $formatter->formatValue(7200);
+        self::assertEquals(2.00, $result);
+    }
+
+    public function testFormatValueReturnsZeroForNonNumericValue(): void
+    {
+        $formatter = new DurationFormatter();
+        $result = $formatter->formatValue('not a number');
+        self::assertEquals(0.0, $result);
+    }
+
+    public function testFormatValueReturnsFormattedDurationForFloatValue(): void
+    {
+        $formatter = new DurationFormatter();
+        $result = $formatter->formatValue(4500.5);
+        self::assertEquals(1.25, $result);
+    }
+
+    public function testFormatValueReturnsZeroForNullValue(): void
+    {
+        $formatter = new DurationFormatter();
+        $result = $formatter->formatValue(null);
+        self::assertEquals(0.0, $result);
+    }
+
+    public function testFormatValueReturnsFormattedDurationForNegativeValue(): void
+    {
+        $formatter = new DurationFormatter();
+        $result = $formatter->formatValue(-3600);
+        self::assertEquals(-1.00, $result);
+    }
+}

tests/Export/Package/CellFormatter/RateFormatterTest.php

@@ -0,0 +1,78 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\RateFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\RateFormatter
+ */
+class RateFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsFormattedFloatForNumericValue(): void
+    {
+        $formatter = new RateFormatter();
+        $result = $formatter->formatValue(1234.5678);
+        self::assertEquals(1234.57, $result);
+
+        $result = $formatter->formatValue('1234.5678');
+        self::assertEquals(1234.57, $result);
+    }
+
+    public function testFormatValueThrowsForNonNumericValue(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only numeric values be formatted');
+
+        $formatter = new RateFormatter();
+        $result = $formatter->formatValue('not a number');
+        self::assertEquals(0.0, $result);
+    }
+
+    public function testFormatValueReturnsZeroForNullValue(): void
+    {
+        $formatter = new RateFormatter();
+        $result = $formatter->formatValue(null);
+        self::assertEquals(0.0, $result);
+    }
+
+    public function testFormatValueReturnsFormattedFloatForNegativeNumericValue(): void
+    {
+        $formatter = new RateFormatter();
+        $result = $formatter->formatValue(-1234.5678);
+        self::assertEquals(-1234.57, $result);
+    }
+
+    public function testFormatValueReturnsFormattedFloatForFloatWithTwoDecimalPlaces(): void
+    {
+        $formatter = new RateFormatter();
+        $result = $formatter->formatValue(1234.56);
+        self::assertEquals(1234.56, $result);
+    }
+
+    public function testFormatValueThrowsExceptionForNonNumericNonNullValue(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only numeric values be formatted');
+
+        $formatter = new RateFormatter();
+        $formatter->formatValue(new \stdClass());
+    }
+
+    public function testFormatValueThrowsExceptionFoArrayValue(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only numeric values be formatted');
+
+        $formatter = new RateFormatter();
+        $formatter->formatValue([]);
+    }
+}

tests/Export/Package/CellFormatter/TextFormatterTest.php

@@ -0,0 +1,59 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\TextFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\TextFormatter
+ */
+class TextFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsSanitizedStringWhenSanitizeDdeIsTrue(): void
+    {
+        $formatter = new TextFormatter(true);
+        $result = $formatter->formatValue('=cmd|\' /C calc\'!A0');
+        self::assertEquals('\' =cmd|\' /C calc\'!A0', $result);
+    }
+
+    public function testFormatValueReturnsOriginalStringWhenSanitizeDdeIsFalse(): void
+    {
+        $formatter = new TextFormatter(false);
+        $result = $formatter->formatValue('=cmd|\' /C calc\'!A0');
+        self::assertEquals('=cmd|\' /C calc\'!A0', $result);
+    }
+
+    public function testFormatValueReturnsOriginalValueForNonStringWhenSanitizeDdeIsTrue(): void
+    {
+        $formatter = new TextFormatter(true);
+        $result = $formatter->formatValue(123);
+        self::assertEquals(123, $result);
+
+        $result = $formatter->formatValue(45.67);
+        self::assertEquals(45.67, $result);
+
+        $result = $formatter->formatValue(true);
+        self::assertTrue($result);
+    }
+
+    public function testFormatValueReturnsOriginalValueForNonStringWhenSanitizeDdeIsFalse(): void
+    {
+        $formatter = new TextFormatter(false);
+        $result = $formatter->formatValue(123);
+        self::assertEquals(123, $result);
+
+        $result = $formatter->formatValue(45.67);
+        self::assertEquals(45.67, $result);
+
+        $result = $formatter->formatValue(true);
+        self::assertTrue($result);
+    }
+}

tests/Export/Package/CellFormatter/TimeFormatterTest.php

@@ -0,0 +1,43 @@
+<?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\CellFormatter;
+
+use App\Export\Package\CellFormatter\TimeFormatter;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\Package\CellFormatter\TimeFormatter
+ */
+class TimeFormatterTest extends TestCase
+{
+    public function testFormatValueReturnsFormattedTimeForDateTimeInterface(): void
+    {
+        $formatter = new TimeFormatter();
+        $dateTime = new \DateTime('2023-10-10 14:30:00');
+        $result = $formatter->formatValue($dateTime);
+        self::assertEquals('14:30', $result);
+    }
+
+    public function testFormatValueReturnsNullForNullValue(): void
+    {
+        $formatter = new TimeFormatter();
+        $result = $formatter->formatValue(null);
+        self::assertNull($result);
+    }
+
+    public function testFormatValueThrowsExceptionForNonDateTimeInterface(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Only DateTimeInterface can be formatted');
+
+        $formatter = new TimeFormatter();
+        $formatter->formatValue('not a DateTime');
+    }
+}