Configurable PDF exports (#5641)
This commit is contained in:
@@ -9,37 +9,31 @@
|
||||
|
||||
namespace App\Tests\Export\Base;
|
||||
|
||||
use App\Entity\User;
|
||||
use App\Export\Base\AbstractSpreadsheetRenderer;
|
||||
use App\Export\Base\CsvRenderer;
|
||||
use App\Export\Base\SpreadsheetRenderer;
|
||||
use App\Export\ColumnConverter;
|
||||
use App\Export\DefaultTemplate;
|
||||
use App\Export\Package\SpoutSpreadsheet;
|
||||
use App\Tests\Export\Renderer\AbstractRendererTestCase;
|
||||
use App\Tests\Mocks\MetaFieldColumnSubscriberMock;
|
||||
use PHPUnit\Framework\Attributes\CoversClass;
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
use PHPUnit\Framework\Attributes\Group;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\EventDispatcher\EventDispatcher;
|
||||
use Symfony\Component\HttpFoundation\BinaryFileResponse;
|
||||
use Symfony\Contracts\Translation\TranslatorInterface;
|
||||
|
||||
/**
|
||||
* @covers \App\Export\Base\RendererTrait
|
||||
*/
|
||||
#[CoversClass(CsvRenderer::class)]
|
||||
#[CoversClass(SpreadsheetRenderer::class)]
|
||||
#[CoversClass(AbstractSpreadsheetRenderer::class)]
|
||||
#[CoversClass(SpoutSpreadsheet::class)]
|
||||
#[CoversClass(CsvRenderer::class)]
|
||||
#[Group('integration')]
|
||||
class CsvRendererTest extends AbstractRendererTestCase
|
||||
{
|
||||
protected function getAbstractRenderer(bool $exportDecimal = false): CsvRenderer
|
||||
protected function getAbstractRenderer(?string $locale): CsvRenderer
|
||||
{
|
||||
$user = $this->createMock(User::class);
|
||||
$user->expects($this->any())->method('isExportDecimal')->willReturn($exportDecimal);
|
||||
|
||||
$security = $this->createMock(Security::class);
|
||||
$security->expects($this->any())->method('getUser')->willReturn($user);
|
||||
$security->expects($this->any())->method('getUser')->willReturn(null);
|
||||
$security->expects($this->any())->method('isGranted')->willReturn(true);
|
||||
|
||||
$translator = $this->getContainer()->get(TranslatorInterface::class);
|
||||
@@ -48,21 +42,23 @@ class CsvRendererTest extends AbstractRendererTestCase
|
||||
$dispatcher = new EventDispatcher();
|
||||
$dispatcher->addSubscriber(new MetaFieldColumnSubscriberMock());
|
||||
|
||||
return new CsvRenderer(new SpreadsheetRenderer($dispatcher, $security, $this->createMock(LoggerInterface::class)), $translator);
|
||||
$converter = new ColumnConverter($dispatcher, $security);
|
||||
|
||||
$template = new DefaultTemplate($dispatcher, 'csv', $locale);
|
||||
|
||||
return new CsvRenderer($converter, $translator, $template);
|
||||
}
|
||||
|
||||
public function testConfiguration(): void
|
||||
public function testConfigurationFromTemplate(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
$sut = $this->getAbstractRenderer('en');
|
||||
|
||||
self::assertEquals('csv', $sut->getType());
|
||||
self::assertEquals('csv', $sut->getId());
|
||||
self::assertEquals('default', $sut->getTitle());
|
||||
|
||||
$sut->setTitle('foo-bar');
|
||||
self::assertEquals('foo-bar', $sut->getTitle());
|
||||
|
||||
$sut->setId('bar-id');
|
||||
self::assertEquals('bar-id', $sut->getId());
|
||||
self::assertFalse($sut->isInternal());
|
||||
$sut->setInternal(true);
|
||||
self::assertTrue($sut->isInternal());
|
||||
}
|
||||
|
||||
public static function getTestModel(): array
|
||||
@@ -89,11 +85,10 @@ class CsvRendererTest extends AbstractRendererTestCase
|
||||
#[DataProvider('getTestModel')]
|
||||
public function testRender(string $totalDuration, string $totalRate, string $expectedRate, int $expectedRows, int $expectedDescriptions, int $expectedUser1, int $expectedUser2, int $expectedUser3, bool $exportDecimal, ?string $locale, array $header): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer($exportDecimal);
|
||||
$sut->setLocale($locale);
|
||||
$sut = $this->getAbstractRenderer($locale);
|
||||
|
||||
/** @var BinaryFileResponse $response */
|
||||
$response = $this->render($sut);
|
||||
$response = $this->render($sut, $exportDecimal);
|
||||
self::assertInstanceOf(BinaryFileResponse::class, $response);
|
||||
|
||||
$file = $response->getFile();
|
||||
$prefix = date('Ymd');
|
||||
@@ -120,10 +115,10 @@ class CsvRendererTest extends AbstractRendererTestCase
|
||||
self::assertFalse(file_exists($file->getRealPath()));
|
||||
|
||||
$all = [];
|
||||
$rows = str_getcsv($content2, PHP_EOL);
|
||||
$rows = array_filter(explode(PHP_EOL, $content2), function (string $line) { return $line !== ''; });
|
||||
foreach ($rows as $row) {
|
||||
self::assertIsString($row);
|
||||
$all[] = str_getcsv($row);
|
||||
$all[] = str_getcsv($row, ',', '"', '\\');
|
||||
}
|
||||
|
||||
self::assertEquals($header, $all[0]);
|
||||
|
||||
73
tests/Export/Base/HtmlRendererTest.php
Normal file
73
tests/Export/Base/HtmlRendererTest.php
Normal file
@@ -0,0 +1,73 @@
|
||||
<?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\Base;
|
||||
|
||||
use App\Activity\ActivityStatisticService;
|
||||
use App\Export\Base\HtmlRenderer;
|
||||
use App\Export\Base\RendererTrait;
|
||||
use App\Project\ProjectStatisticService;
|
||||
use App\Tests\Export\Renderer\AbstractRendererTestCase;
|
||||
use PHPUnit\Framework\Attributes\CoversClass;
|
||||
use PHPUnit\Framework\Attributes\Group;
|
||||
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Twig\Environment;
|
||||
|
||||
#[CoversClass(RendererTrait::class)]
|
||||
#[CoversClass(HtmlRenderer::class)]
|
||||
#[Group('integration')]
|
||||
class HtmlRendererTest extends AbstractRendererTestCase
|
||||
{
|
||||
protected function getAbstractRenderer(): HtmlRenderer
|
||||
{
|
||||
return new HtmlRenderer(
|
||||
$this->createMock(Environment::class),
|
||||
$this->createMock(EventDispatcherInterface::class),
|
||||
$this->createMock(ProjectStatisticService::class),
|
||||
$this->createMock(ActivityStatisticService::class),
|
||||
'foo',
|
||||
'bar',
|
||||
'export/print.html.twig'
|
||||
);
|
||||
}
|
||||
|
||||
public function testConfiguration(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
|
||||
self::assertEquals('foo', $sut->getId());
|
||||
self::assertEquals('bar', $sut->getTitle());
|
||||
self::assertEquals('html', $sut->getType());
|
||||
self::assertFalse($sut->isInternal());
|
||||
}
|
||||
|
||||
/**
|
||||
* @group legacy
|
||||
*/
|
||||
public function testLegacy(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
|
||||
$sut->setTemplate('some'); // @phpstan-ignore method.deprecated
|
||||
$sut->setId('xxxxxx'); // @phpstan-ignore method.deprecated
|
||||
self::assertEquals('xxxxxx', $sut->getId());
|
||||
}
|
||||
|
||||
public function testRender(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
|
||||
$response = $this->render($sut);
|
||||
self::assertInstanceOf(Response::class, $response);
|
||||
|
||||
$content = $response->getContent();
|
||||
self::assertIsString($content);
|
||||
}
|
||||
}
|
||||
@@ -10,17 +10,18 @@
|
||||
namespace App\Tests\Export\Base;
|
||||
|
||||
use App\Export\Base\PDFRenderer;
|
||||
use App\Export\Base\RendererTrait;
|
||||
use App\Pdf\HtmlToPdfConverter;
|
||||
use App\Pdf\PdfRendererTrait;
|
||||
use App\Project\ProjectStatisticService;
|
||||
use App\Tests\Export\Renderer\AbstractRendererTestCase;
|
||||
use PHPUnit\Framework\Attributes\CoversClass;
|
||||
use PHPUnit\Framework\Attributes\Group;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Twig\Environment;
|
||||
|
||||
/**
|
||||
* @covers \App\Export\Base\RendererTrait
|
||||
* @covers \App\Pdf\PdfRendererTrait
|
||||
*/
|
||||
#[CoversClass(RendererTrait::class)]
|
||||
#[CoversClass(PdfRendererTrait::class)]
|
||||
#[CoversClass(PDFRenderer::class)]
|
||||
#[Group('integration')]
|
||||
class PdfRendererTest extends AbstractRendererTestCase
|
||||
@@ -31,22 +32,22 @@ class PdfRendererTest extends AbstractRendererTestCase
|
||||
$converter = $this->createMock(HtmlToPdfConverter::class);
|
||||
$projectStatisticService = $this->createMock(ProjectStatisticService::class);
|
||||
|
||||
return new PDFRenderer($twig, $converter, $projectStatisticService);
|
||||
return new PDFRenderer(
|
||||
$twig,
|
||||
$converter,
|
||||
$projectStatisticService,
|
||||
'foo',
|
||||
'bar',
|
||||
'export/print.html.twig'
|
||||
);
|
||||
}
|
||||
|
||||
public function testConfiguration(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
|
||||
self::assertEquals('pdf', $sut->getId());
|
||||
self::assertEquals('pdf', $sut->getTitle());
|
||||
|
||||
$sut->setTitle('foo-bar');
|
||||
self::assertEquals('foo-bar', $sut->getTitle());
|
||||
|
||||
$sut->setId('bar-id');
|
||||
self::assertEquals('bar-id', $sut->getId());
|
||||
|
||||
self::assertEquals('foo', $sut->getId());
|
||||
self::assertEquals('bar', $sut->getTitle());
|
||||
self::assertEquals([], $sut->getPdfOptions());
|
||||
$sut->setPdfOption('foo', 'bar');
|
||||
self::assertEquals(['foo' => 'bar'], $sut->getPdfOptions());
|
||||
@@ -54,5 +55,33 @@ class PdfRendererTest extends AbstractRendererTestCase
|
||||
self::assertEquals(['foo' => 'bar2'], $sut->getPdfOptions());
|
||||
$sut->setPdfOption('hello', 'world');
|
||||
self::assertEquals(['foo' => 'bar2', 'hello' => 'world'], $sut->getPdfOptions());
|
||||
self::assertFalse($sut->isInternal());
|
||||
}
|
||||
|
||||
/**
|
||||
* @group legacy
|
||||
*/
|
||||
public function testLegacy(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
|
||||
$sut->setTemplate('some'); // @phpstan-ignore method.deprecated
|
||||
$sut->setTitle('xxxxxx'); // @phpstan-ignore method.deprecated
|
||||
self::assertEquals('xxxxxx', $sut->getTitle());
|
||||
}
|
||||
|
||||
public function testRender(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
|
||||
$response = $this->render($sut);
|
||||
self::assertInstanceOf(Response::class, $response);
|
||||
|
||||
$prefix = date('Ymd');
|
||||
self::assertEquals('application/pdf', $response->headers->get('Content-Type'));
|
||||
self::assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.pdf', $response->headers->get('Content-Disposition'));
|
||||
|
||||
$content = $response->getContent();
|
||||
self::assertIsString($content);
|
||||
}
|
||||
}
|
||||
|
||||
193
tests/Export/Base/PdfTemplateRendererTest.php
Normal file
193
tests/Export/Base/PdfTemplateRendererTest.php
Normal file
@@ -0,0 +1,193 @@
|
||||
<?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\Base;
|
||||
|
||||
use App\Entity\User;
|
||||
use App\Export\Base\PdfTemplateRenderer;
|
||||
use App\Export\Base\RendererTrait;
|
||||
use App\Export\ColumnConverter;
|
||||
use App\Export\DefaultTemplate;
|
||||
use App\Export\Template;
|
||||
use App\Export\TemplateInterface;
|
||||
use App\Pdf\HtmlToPdfConverter;
|
||||
use App\Pdf\PdfRendererTrait;
|
||||
use App\Project\ProjectStatisticService;
|
||||
use App\Repository\Query\TimesheetQuery;
|
||||
use App\Tests\Export\Renderer\AbstractRendererTestCase;
|
||||
use App\Tests\Mocks\MetaFieldColumnSubscriberMock;
|
||||
use PHPUnit\Framework\Attributes\CoversClass;
|
||||
use PHPUnit\Framework\Attributes\Group;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\EventDispatcher\EventDispatcher;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Component\Translation\LocaleSwitcher;
|
||||
use Twig\Environment;
|
||||
|
||||
#[CoversClass(PdfRendererTrait::class)]
|
||||
#[CoversClass(RendererTrait::class)]
|
||||
#[CoversClass(PdfTemplateRenderer::class)]
|
||||
#[Group('integration')]
|
||||
class PdfTemplateRendererTest extends AbstractRendererTestCase
|
||||
{
|
||||
protected function getAbstractRenderer(Environment $twig, ?TemplateInterface $template = null): PdfTemplateRenderer
|
||||
{
|
||||
$htmlConverter = $this->createMock(HtmlToPdfConverter::class);
|
||||
$projectStatisticService = $this->createMock(ProjectStatisticService::class);
|
||||
|
||||
$security = $this->createMock(Security::class);
|
||||
$security->expects($this->any())->method('getUser')->willReturn(new User());
|
||||
$security->expects($this->any())->method('isGranted')->willReturn(true);
|
||||
$security->expects($this->any())->method('isGranted')->willReturn(true);
|
||||
|
||||
$dispatcher = new EventDispatcher();
|
||||
$dispatcher->addSubscriber(new MetaFieldColumnSubscriberMock());
|
||||
|
||||
if ($template === null) {
|
||||
$template = new DefaultTemplate($dispatcher, 'test', 'en', 'bar');
|
||||
}
|
||||
$converter = new ColumnConverter($dispatcher, $security);
|
||||
|
||||
return new PdfTemplateRenderer(
|
||||
$twig,
|
||||
$htmlConverter,
|
||||
$projectStatisticService,
|
||||
$converter,
|
||||
$this->createMock(LocaleSwitcher::class),
|
||||
$template
|
||||
);
|
||||
}
|
||||
|
||||
public function testConfiguration(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer($this->createMock(Environment::class));
|
||||
|
||||
self::assertEquals('test', $sut->getId());
|
||||
self::assertEquals('bar', $sut->getTitle());
|
||||
self::assertEquals('pdf', $sut->getType());
|
||||
self::assertTrue($sut->isInternal());
|
||||
}
|
||||
|
||||
public function testDefaultTemplateRender(): void
|
||||
{
|
||||
$twig = $this->createMock(Environment::class);
|
||||
$twig->expects(self::once())->method('render')->willReturnCallback(function (string $templateName, array $options) {
|
||||
if ($templateName !== 'export/renderer.pdf.twig') {
|
||||
$this->fail('Wrong template given, expected "export/renderer.pdf.twig"');
|
||||
}
|
||||
self::assertArrayHasKey('font', $options);
|
||||
self::assertArrayHasKey('columns', $options);
|
||||
self::assertArrayHasKey('summary', $options);
|
||||
self::assertArrayHasKey('template', $options);
|
||||
self::assertArrayHasKey('title', $options);
|
||||
self::assertArrayHasKey('locale', $options);
|
||||
self::assertArrayHasKey('entries', $options);
|
||||
self::assertArrayHasKey('query', $options);
|
||||
|
||||
self::assertEquals('sans-serif', $options['font']);
|
||||
self::assertEquals([
|
||||
'date',
|
||||
'begin',
|
||||
'end',
|
||||
'duration',
|
||||
'currency',
|
||||
'rate',
|
||||
'internal_rate',
|
||||
'hourly_rate',
|
||||
'fixed_rate',
|
||||
'user.alias',
|
||||
'user.name',
|
||||
'user.email',
|
||||
'user.account_number',
|
||||
'customer.name',
|
||||
'project.name',
|
||||
'activity.name',
|
||||
'description',
|
||||
'billable',
|
||||
'tags',
|
||||
'type',
|
||||
'category',
|
||||
'customer.number',
|
||||
'project.number',
|
||||
'customer.vat_id',
|
||||
'project.order_number',
|
||||
'timesheet.meta.foo',
|
||||
'timesheet.meta.foo2',
|
||||
'customer.meta.customer-foo',
|
||||
'project.meta.project-foo',
|
||||
'project.meta.project-foo2',
|
||||
'activity.meta.activity-foo',
|
||||
'user.meta.mypref',
|
||||
], array_keys($options['columns']));
|
||||
self::assertEquals([], $options['summary']);
|
||||
self::assertNull($options['title']);
|
||||
self::assertEquals('en', $options['locale']);
|
||||
self::assertIsArray($options['entries']);
|
||||
self::assertInstanceOf(TimesheetQuery::class, $options['query']);
|
||||
|
||||
return '';
|
||||
});
|
||||
|
||||
$sut = $this->getAbstractRenderer($twig);
|
||||
|
||||
$response = $this->render($sut);
|
||||
self::assertInstanceOf(Response::class, $response);
|
||||
}
|
||||
|
||||
public function testRender(): void
|
||||
{
|
||||
$template = new Template('test_id', 'My title');
|
||||
$template->setLocale('de');
|
||||
$template->setOptions([
|
||||
'summary_columns' => 'duration,rate,project_budget_money',
|
||||
'orientation' => 'landscape',
|
||||
'pageSize' => 'Letter',
|
||||
'font' => 'freesans',
|
||||
'name' => 'My title 2',
|
||||
]);
|
||||
|
||||
$twig = $this->createMock(Environment::class);
|
||||
$twig->expects(self::once())->method('render')->willReturnCallback(function (string $templateName, array $options) use ($template) {
|
||||
if ($templateName !== 'export/renderer.pdf.twig') {
|
||||
$this->fail('Wrong template given, expected "export/renderer.pdf.twig"');
|
||||
}
|
||||
self::assertArrayHasKey('font', $options);
|
||||
self::assertArrayHasKey('columns', $options);
|
||||
self::assertArrayHasKey('summary', $options);
|
||||
self::assertArrayHasKey('template', $options);
|
||||
self::assertArrayHasKey('title', $options);
|
||||
self::assertArrayHasKey('locale', $options);
|
||||
self::assertArrayHasKey('entries', $options);
|
||||
self::assertArrayHasKey('query', $options);
|
||||
|
||||
self::assertEquals('freesans', $options['font']);
|
||||
self::assertEquals([], $options['columns']);
|
||||
self::assertEquals(['duration', 'rate', 'project_budget_money'], $options['summary']);
|
||||
self::assertSame($options['template'], $template);
|
||||
self::assertEquals('My title 2', $options['title']);
|
||||
self::assertEquals('de', $options['locale']);
|
||||
self::assertIsArray($options['entries']);
|
||||
self::assertInstanceOf(TimesheetQuery::class, $options['query']);
|
||||
|
||||
return '';
|
||||
});
|
||||
|
||||
$sut = $this->getAbstractRenderer($twig, $template);
|
||||
|
||||
$response = $this->render($sut);
|
||||
self::assertInstanceOf(Response::class, $response);
|
||||
|
||||
$prefix = date('Ymd');
|
||||
self::assertEquals('application/pdf', $response->headers->get('Content-Type'));
|
||||
self::assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.pdf', $response->headers->get('Content-Disposition'));
|
||||
|
||||
$content = $response->getContent();
|
||||
self::assertIsString($content);
|
||||
}
|
||||
}
|
||||
@@ -1,193 +0,0 @@
|
||||
<?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\Base;
|
||||
|
||||
use App\Entity\ExportableItem;
|
||||
use App\Export\Base\SpreadsheetRenderer;
|
||||
use App\Export\Package\SpreadsheetPackage;
|
||||
use App\Export\Template;
|
||||
use App\Repository\Query\TimesheetQuery;
|
||||
use App\Tests\Export\Package\MemoryPackage;
|
||||
use App\Tests\Export\Renderer\AbstractRendererTestCase;
|
||||
use App\Tests\Mocks\MetaFieldColumnSubscriberMock;
|
||||
use PHPUnit\Framework\Attributes\CoversClass;
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
use PHPUnit\Framework\Attributes\Group;
|
||||
use Psr\EventDispatcher\EventDispatcherInterface;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Bundle\SecurityBundle\Security;
|
||||
use Symfony\Component\EventDispatcher\EventDispatcher;
|
||||
use Symfony\Contracts\Translation\TranslatorInterface;
|
||||
|
||||
#[CoversClass(SpreadsheetRenderer::class)]
|
||||
#[Group('integration')]
|
||||
class SpreadsheetRendererTest extends AbstractRendererTestCase
|
||||
{
|
||||
public function testWriteSpreadsheetCreatesSpreadsheetWithCorrectHeaders(): void
|
||||
{
|
||||
$dispatcher = $this->createMock(EventDispatcherInterface::class);
|
||||
$security = $this->createMock(Security::class);
|
||||
$spreadsheetPackage = $this->createMock(SpreadsheetPackage::class);
|
||||
$spreadsheetPackage->expects(self::once())->method('setColumns');
|
||||
|
||||
$renderer = new SpreadsheetRenderer($dispatcher, $security, $this->createMock(LoggerInterface::class));
|
||||
$renderer->writeSpreadsheet($spreadsheetPackage, [], new TimesheetQuery());
|
||||
}
|
||||
|
||||
public function testWriteSpreadsheetAddsRowsForExportItems(): void
|
||||
{
|
||||
$dispatcher = $this->createMock(EventDispatcherInterface::class);
|
||||
$security = $this->createMock(Security::class);
|
||||
$spreadsheetPackage = $this->createMock(SpreadsheetPackage::class);
|
||||
$spreadsheetPackage->expects(self::exactly(2))->method('addRow');
|
||||
$spreadsheetPackage->expects(self::once())->method('save');
|
||||
|
||||
$exportItem = $this->createMock(ExportableItem::class);
|
||||
$exportItem->method('getBegin')->willReturn(new \DateTime());
|
||||
$exportItem->method('getEnd')->willReturn(new \DateTime());
|
||||
$exportItem->method('getDuration')->willReturn(3600);
|
||||
$exportItem->method('getRate')->willReturn(100.0);
|
||||
$exportItem->method('getInternalRate')->willReturn(80.0);
|
||||
$exportItem->method('getHourlyRate')->willReturn(50.0);
|
||||
$exportItem->method('getFixedRate')->willReturn(200.0);
|
||||
$exportItem->method('getUser')->willReturn(null);
|
||||
$exportItem->method('getProject')->willReturn(null);
|
||||
$exportItem->method('getActivity')->willReturn(null);
|
||||
$exportItem->method('getDescription')->willReturn('Test description');
|
||||
$exportItem->method('isBillable')->willReturn(true);
|
||||
$exportItem->method('getTagsAsArray')->willReturn(['tag1', 'tag2']);
|
||||
$exportItem->method('getType')->willReturn('type');
|
||||
$exportItem->method('getCategory')->willReturn('category');
|
||||
|
||||
$renderer = new SpreadsheetRenderer($dispatcher, $security, $this->createMock(LoggerInterface::class));
|
||||
$renderer->writeSpreadsheet($spreadsheetPackage, [$exportItem], new TimesheetQuery());
|
||||
}
|
||||
|
||||
public function testWriteSpreadsheetAddsTotalRowWhenMoreThanOneRow(): void
|
||||
{
|
||||
$translator = $this->createMock(TranslatorInterface::class);
|
||||
$translator->method('trans')->willReturnArgument(0);
|
||||
$dispatcher = $this->createMock(EventDispatcherInterface::class);
|
||||
$security = $this->createMock(Security::class);
|
||||
$spreadsheetPackage = $this->createMock(SpreadsheetPackage::class);
|
||||
$spreadsheetPackage->expects(self::exactly(3))->method('addRow');
|
||||
|
||||
$exportItem = $this->createMock(ExportableItem::class);
|
||||
$exportItem->method('getBegin')->willReturn(new \DateTime());
|
||||
$exportItem->method('getEnd')->willReturn(new \DateTime());
|
||||
$exportItem->method('getDuration')->willReturn(3600);
|
||||
$exportItem->method('getRate')->willReturn(100.0);
|
||||
$exportItem->method('getInternalRate')->willReturn(80.0);
|
||||
$exportItem->method('getHourlyRate')->willReturn(50.0);
|
||||
$exportItem->method('getFixedRate')->willReturn(200.0);
|
||||
$exportItem->method('getUser')->willReturn(null);
|
||||
$exportItem->method('getProject')->willReturn(null);
|
||||
$exportItem->method('getActivity')->willReturn(null);
|
||||
$exportItem->method('getDescription')->willReturn('Test description');
|
||||
$exportItem->method('isBillable')->willReturn(true);
|
||||
$exportItem->method('getTagsAsArray')->willReturn(['tag1', 'tag2']);
|
||||
$exportItem->method('getType')->willReturn('type');
|
||||
$exportItem->method('getCategory')->willReturn('category');
|
||||
|
||||
$renderer = new SpreadsheetRenderer($dispatcher, $security);
|
||||
$renderer->writeSpreadsheet($spreadsheetPackage, [$exportItem, $exportItem], new TimesheetQuery());
|
||||
}
|
||||
|
||||
public static function getTestData(): iterable
|
||||
{
|
||||
yield [null, [
|
||||
'date' => 'date',
|
||||
'begin' => 'begin',
|
||||
'end' => 'end',
|
||||
'duration' => 'duration',
|
||||
'currency' => 'currency',
|
||||
'rate' => 'rate',
|
||||
'internalRate' => 'internalRate',
|
||||
'hourlyRate' => 'hourlyRate',
|
||||
'fixedRate' => 'fixedRate',
|
||||
'alias' => 'alias',
|
||||
'username' => 'username',
|
||||
'account_number' => 'account_number',
|
||||
'customer' => 'customer',
|
||||
'project' => 'project',
|
||||
'activity' => 'activity',
|
||||
'description' => 'description',
|
||||
'billable' => 'billable',
|
||||
'tags' => 'tags',
|
||||
'type' => 'type',
|
||||
'category' => 'category',
|
||||
'number' => 'number',
|
||||
'project_number' => 'project_number',
|
||||
'vat_id' => 'vat_id',
|
||||
'orderNumber' => 'orderNumber',
|
||||
'timesheet.meta.foo' => 'Working place',
|
||||
'timesheet.meta.foo2' => 'Working place',
|
||||
'customer.meta.customer-foo' => 'Working place',
|
||||
'project.meta.project-foo' => 'Working place',
|
||||
'project.meta.project-foo2' => 'Working place',
|
||||
'activity.meta.activity-foo' => 'Working place',
|
||||
'user.meta.mypref' => 'mypref',
|
||||
'email' => 'email'
|
||||
]];
|
||||
|
||||
$template = new Template('test', 'Testing');
|
||||
$template->setLocale('de');
|
||||
$template->setColumns(['date', 'user.name', 'duration_decimal', 'customer.name', 'exported', 'user.meta.mypref']);
|
||||
|
||||
yield [$template, [
|
||||
'date' => 'date',
|
||||
'duration' => 'duration',
|
||||
'username' => 'username',
|
||||
'customer' => 'customer',
|
||||
'exported' => 'exported',
|
||||
'user.meta.mypref' => 'mypref',
|
||||
]];
|
||||
}
|
||||
|
||||
#[DataProvider('getTestData')]
|
||||
public function testWriteSpreadsheetCsv(?Template $template, array $expectedColumns): void
|
||||
{
|
||||
$dispatcher = new EventDispatcher();
|
||||
$dispatcher->addSubscriber(new MetaFieldColumnSubscriberMock());
|
||||
|
||||
$security = $this->createMock(Security::class);
|
||||
$spreadsheetPackage = new MemoryPackage();
|
||||
|
||||
$exportItem = $this->createMock(ExportableItem::class);
|
||||
$exportItem->method('getBegin')->willReturn(new \DateTime());
|
||||
$exportItem->method('getEnd')->willReturn(new \DateTime());
|
||||
$exportItem->method('getDuration')->willReturn(3600);
|
||||
$exportItem->method('getRate')->willReturn(100.0);
|
||||
$exportItem->method('getInternalRate')->willReturn(80.0);
|
||||
$exportItem->method('getHourlyRate')->willReturn(50.0);
|
||||
$exportItem->method('getFixedRate')->willReturn(200.0);
|
||||
$exportItem->method('getUser')->willReturn(null);
|
||||
$exportItem->method('getProject')->willReturn(null);
|
||||
$exportItem->method('getActivity')->willReturn(null);
|
||||
$exportItem->method('getDescription')->willReturn('Test description');
|
||||
$exportItem->method('isBillable')->willReturn(true);
|
||||
$exportItem->method('getTagsAsArray')->willReturn(['tag1', 'tag2']);
|
||||
$exportItem->method('getType')->willReturn('type');
|
||||
$exportItem->method('getCategory')->willReturn('category');
|
||||
|
||||
$renderer = new SpreadsheetRenderer($dispatcher, $security, $this->createMock(LoggerInterface::class));
|
||||
$renderer->setTemplate($template);
|
||||
$renderer->writeSpreadsheet($spreadsheetPackage, [$exportItem], new TimesheetQuery());
|
||||
|
||||
$columnNames = [];
|
||||
foreach ($spreadsheetPackage->getColumns() as $column) {
|
||||
$columnNames[$column->getName()] = $column->getHeader();
|
||||
}
|
||||
|
||||
self::assertEquals(null, $spreadsheetPackage->getFilename());
|
||||
self::assertEquals($expectedColumns, $columnNames);
|
||||
self::assertCount(2, $spreadsheetPackage->getRows());
|
||||
}
|
||||
}
|
||||
@@ -10,9 +10,11 @@
|
||||
namespace App\Tests\Export\Base;
|
||||
|
||||
use App\Entity\User;
|
||||
use App\Export\Base\SpreadsheetRenderer;
|
||||
use App\Export\Base\AbstractSpreadsheetRenderer;
|
||||
use App\Export\Base\XlsxRenderer;
|
||||
use App\Export\ColumnConverter;
|
||||
use App\Export\Package\SpoutSpreadsheet;
|
||||
use App\Export\Renderer\XlsxRendererFactory;
|
||||
use App\Tests\Export\Renderer\AbstractRendererTestCase;
|
||||
use App\Tests\Mocks\MetaFieldColumnSubscriberMock;
|
||||
use PHPUnit\Framework\Attributes\CoversClass;
|
||||
@@ -22,12 +24,9 @@ use Symfony\Component\EventDispatcher\EventDispatcher;
|
||||
use Symfony\Component\HttpFoundation\BinaryFileResponse;
|
||||
use Symfony\Contracts\Translation\TranslatorInterface;
|
||||
|
||||
/**
|
||||
* @covers \App\Export\Base\RendererTrait
|
||||
*/
|
||||
#[CoversClass(XlsxRenderer::class)]
|
||||
#[CoversClass(SpreadsheetRenderer::class)]
|
||||
#[CoversClass(AbstractSpreadsheetRenderer::class)]
|
||||
#[CoversClass(SpoutSpreadsheet::class)]
|
||||
#[CoversClass(XlsxRenderer::class)]
|
||||
#[Group('integration')]
|
||||
class XlsxRendererTest extends AbstractRendererTestCase
|
||||
{
|
||||
@@ -43,30 +42,30 @@ class XlsxRendererTest extends AbstractRendererTestCase
|
||||
$dispatcher = new EventDispatcher();
|
||||
$dispatcher->addSubscriber(new MetaFieldColumnSubscriberMock());
|
||||
|
||||
return new XlsxRenderer(new SpreadsheetRenderer($dispatcher, $security), $translator);
|
||||
$converter = new ColumnConverter($dispatcher, $security);
|
||||
$factory = new XlsxRendererFactory($converter, $dispatcher, $translator);
|
||||
|
||||
return $factory->createDefault();
|
||||
}
|
||||
|
||||
public function testConfiguration(): void
|
||||
public function testConfigurationFromTemplate(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
$sut->setLocale('de');
|
||||
|
||||
self::assertEquals('xlsx', $sut->getType());
|
||||
self::assertEquals('xlsx', $sut->getId());
|
||||
self::assertEquals('default', $sut->getTitle());
|
||||
|
||||
$sut->setTitle('foo-bar');
|
||||
self::assertEquals('foo-bar', $sut->getTitle());
|
||||
|
||||
$sut->setId('bar-id');
|
||||
self::assertEquals('bar-id', $sut->getId());
|
||||
self::assertFalse($sut->isInternal());
|
||||
$sut->setInternal(true);
|
||||
self::assertTrue($sut->isInternal());
|
||||
}
|
||||
|
||||
public function testRender(): void
|
||||
{
|
||||
$sut = $this->getAbstractRenderer();
|
||||
|
||||
/** @var BinaryFileResponse $response */
|
||||
$response = $this->render($sut);
|
||||
self::assertInstanceOf(BinaryFileResponse::class, $response);
|
||||
|
||||
$file = $response->getFile();
|
||||
$prefix = date('Ymd');
|
||||
|
||||
Reference in New Issue
Block a user