jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Configurable PDF exports (#5641)

Browse Source
This commit is contained in:
Kevin Papst
2025-09-23 18:32:31 +02:00
committed by GitHub
parent 5d3e46cce2
commit 6d78c6ba36
107 changed files with 2428 additions and 1575 deletions
Download Patch File Download Diff File Expand all files Collapse all files

291
tests/Export/ColumnConverterTest.php Normal file
View File

@@ -0,0 +1,291 @@
<?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;
use App\Entity\ActivityMeta;
use App\Entity\CustomerMeta;
use App\Entity\ProjectMeta;
use App\Entity\TimesheetMeta;
use App\Entity\User;
use App\Entity\UserPreference;
use App\Event\AbstractMetaDisplayEvent;
use App\Event\ActivityMetaDisplayEvent;
use App\Event\CustomerMetaDisplayEvent;
use App\Event\ProjectMetaDisplayEvent;
use App\Event\TimesheetMetaDisplayEvent;
use App\Event\UserPreferenceDisplayEvent;
use App\Export\ColumnConverter;
use App\Export\DefaultTemplate;
use App\Export\Template;
use App\Repository\Query\TimesheetQuery;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Component\EventDispatcher\EventDispatcher;
#[CoversClass(ColumnConverter::class)]
class ColumnConverterTest extends TestCase
{
public function testDefaultValues(): void
{
$dispatcher = new EventDispatcher();
$security = $this->createMock(Security::class);
$logger = $this->createMock(LoggerInterface::class);
$logger->expects(self::never())->method('warning');
$template = new DefaultTemplate($dispatcher, 'foo');
$query = new TimesheetQuery();
$sut = new ColumnConverter($dispatcher, $security, $logger);
$columns = $sut->getColumns($template, $query);
$expected = [
'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',
];
self::assertEquals($expected, array_keys($columns));
}
public function testSkipsRate(): void
{
$user = new User();
$dispatcher = $this->createMock(EventDispatcher::class);
$security = $this->createMock(Security::class);
$security->method('getUser')->willReturn($user);
$security->method('isGranted')->willReturn(false);
$logger = $this->createMock(LoggerInterface::class);
$logger->expects(self::never())->method('warning');
$template = new DefaultTemplate($dispatcher, 'foo');
$query = new TimesheetQuery();
$query->setUser($user);
$sut = new ColumnConverter($dispatcher, $security, $logger);
$columns = $sut->getColumns($template, $query);
$expected = [
'date',
'begin',
'end',
'duration',
'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',
];
self::assertEquals($expected, array_keys($columns));
}
public function testWithMetaFields(): void
{
$user = new User();
$dispatcher = $this->createMock(EventDispatcher::class);
$dispatcher->method('dispatch')->willReturnCallback(function (AbstractMetaDisplayEvent|UserPreferenceDisplayEvent $event) {
if ($event instanceof CustomerMetaDisplayEvent) {
$event->addField((new CustomerMeta())->setName('foo_meta')->setIsVisible(true));
$event->addField((new CustomerMeta())->setName('bar_meta')->setIsVisible(true));
} elseif ($event instanceof ProjectMetaDisplayEvent) {
$event->addField((new ProjectMeta())->setName('visible_project')->setIsVisible(true));
$event->addField((new ProjectMeta())->setName('hidden_project')->setIsVisible(false));
} elseif ($event instanceof ActivityMetaDisplayEvent) {
$event->addField((new ActivityMeta())->setName('activity_world')->setIsVisible(true));
$event->addField((new ActivityMeta())->setName('hello_activity')->setIsVisible(false));
} elseif ($event instanceof TimesheetMetaDisplayEvent) {
$event->addField((new TimesheetMeta())->setName('timesheet_one')->setIsVisible(true));
$event->addField((new TimesheetMeta())->setName('timesheet_two')->setIsVisible(false));
} elseif ($event instanceof UserPreferenceDisplayEvent) {
$event->addPreference((new UserPreference('user_acme'))->setEnabled(true));
$event->addPreference((new UserPreference('user_foo'))->setEnabled(false));
}
return $event;
});
$security = $this->createMock(Security::class);
$security->method('getUser')->willReturn($user);
$security->method('isGranted')->willReturn(false);
$logger = $this->createMock(LoggerInterface::class);
$logger->expects(self::never())->method('warning');
$template = new DefaultTemplate($dispatcher, 'foo');
$query = new TimesheetQuery();
$query->setUser($user);
$sut = new ColumnConverter($dispatcher, $security, $logger);
$columns = $sut->getColumns($template, $query);
$expected = [
'date',
'begin',
'end',
'duration',
'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.timesheet_one',
'timesheet.meta.timesheet_two',
'customer.meta.foo_meta',
'customer.meta.bar_meta',
'project.meta.visible_project',
'project.meta.hidden_project',
'activity.meta.activity_world',
'activity.meta.hello_activity',
'user.meta.user_acme',
'user.meta.user_foo',
];
self::assertEquals($expected, array_keys($columns));
}
public function testWithAllAndUnknownColumns(): void
{
$user = new User();
$dispatcher = $this->createMock(EventDispatcher::class);
$security = $this->createMock(Security::class);
$security->method('getUser')->willReturn($user);
$security->method('isGranted')->willReturn(true);
$logger = $this->createMock(LoggerInterface::class);
$logger->expects(self::exactly(3))->method('warning');
$template = new Template('bar', 'foo');
$template->setColumns([
'date',
'begin',
'end',
'duration',
'duration_decimal',
'duration_seconds',
'break',
'break_decimal',
'break_seconds',
'exported',
'currency',
'rate',
'internal_rate',
'hourly_rate',
'fixed_rate',
'user.alias',
'unknown.1',
'activity.number',
'user.name',
'user.email',
'user.account_number',
'customer.name',
'project.name',
'activity.name',
'description',
'billable',
'tags',
'type',
'category',
'customer.number',
'project.tralalala',
'project.number',
'customer.vat_id',
'customer.is.never,evil',
'project.order_number',
]);
$query = new TimesheetQuery();
$query->setUser($user);
$sut = new ColumnConverter($dispatcher, $security, $logger);
$columns = $sut->getColumns($template, $query);
$expected = [
'date',
'begin',
'end',
'duration',
'duration_decimal',
'duration_seconds',
'break',
'break_decimal',
'break_seconds',
'exported',
'currency',
'rate',
'internal_rate',
'hourly_rate',
'fixed_rate',
'user.alias',
'activity.number',
'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',
];
self::assertEquals($expected, array_keys($columns));
}
}