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

Release 1.6.2 (#1289)

Browse Source 
* include user teams in user entity
* prevent unauthorized access via API
* improve teamlead permission handling in team timesheets
* add team data to user entity
* add security tests
* highlight menu for invoice template copy
* unified handling of invoice data across all templates
* access to the current users data in invoice templates
* permission improvement in invoice form
* allow to skip record rows
* allow to add new invoice locations without overwriting the global ones
* allow to order user preferences
* change permission for normal users with access to view_other_timesheets
* properly validate invoice template field length
* allow to replace multiple variables in cell values text
* upgraded office invoice template
* doctrine deprecation fix
* upgrade phpoffice/phpword
* fix future begin check for default rounding rules
* dashboard widget counter: respect visibility and teams - fixes #1161
* fix future begin check for default rounding rules
* added new events for pre and post invoice rendering
* fix permission issue for users without team seeing all records
* prevent error in spreadsheet renderer for empty invoices
This commit is contained in:
Kevin Papst
2019-12-02 10:57:03 +01:00
committed by GitHub
parent 47414cfd0e
commit 984c852ab6
78 changed files with 1279 additions and 625 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
tests/Invoice/Calculator/AbstractCalculatorTest.php
View File

@@ -18,6 +18,7 @@ use App\Entity\User;
use App\Invoice\CalculatorInterface;
use App\Invoice\InvoiceModel;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\DebugFormatter;
use PHPUnit\Framework\TestCase;
abstract class AbstractCalculatorTest extends TestCase
@@ -28,7 +29,7 @@ abstract class AbstractCalculatorTest extends TestCase
$template = new InvoiceTemplate();
$query = new InvoiceQuery();
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setQuery($query);
@@ -80,7 +81,7 @@ abstract class AbstractCalculatorTest extends TestCase
->setActivity($activity)
->setProject($project);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries([$timesheet]);

3
tests/Invoice/Calculator/ActivityInvoiceCalculatorTest.php
View File

@@ -18,6 +18,7 @@ use App\Entity\User;
use App\Invoice\Calculator\ActivityInvoiceCalculator;
use App\Invoice\InvoiceModel;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\DebugFormatter;
/**
* @covers \App\Invoice\Calculator\ActivityInvoiceCalculator
@@ -105,7 +106,7 @@ class ActivityInvoiceCalculatorTest extends AbstractCalculatorTest
$query = new InvoiceQuery();
$query->setActivity($activity1);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);

3
tests/Invoice/Calculator/DateInvoiceCalculatorTest.php
View File

@@ -18,6 +18,7 @@ use App\Entity\User;
use App\Invoice\Calculator\DateInvoiceCalculator;
use App\Invoice\InvoiceModel;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\DebugFormatter;
use DateTime;
/**
@@ -106,7 +107,7 @@ class DateInvoiceCalculatorTest extends AbstractCalculatorTest
$query = new InvoiceQuery();
$query->setProject($project1);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);

3
tests/Invoice/Calculator/DefaultCalculatorTest.php
View File

@@ -16,6 +16,7 @@ use App\Entity\Timesheet;
use App\Invoice\Calculator\DefaultCalculator;
use App\Invoice\InvoiceModel;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\DebugFormatter;
/**
* @covers \App\Invoice\Calculator\DefaultCalculator
@@ -57,7 +58,7 @@ class DefaultCalculatorTest extends AbstractCalculatorTest
$entries = [$timesheet, $timesheet2, $timesheet3];
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);

3
tests/Invoice/Calculator/ProjectInvoiceCalculatorTest.php
View File

@@ -18,6 +18,7 @@ use App\Entity\User;
use App\Invoice\Calculator\ProjectInvoiceCalculator;
use App\Invoice\InvoiceModel;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\DebugFormatter;
use DateTime;
/**
@@ -106,7 +107,7 @@ class ProjectInvoiceCalculatorTest extends AbstractCalculatorTest
$query = new InvoiceQuery();
$query->setProject($project1);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);

7
tests/Invoice/Calculator/ShortInvoiceCalculatorTest.php
View File

@@ -19,6 +19,7 @@ use App\Invoice\Calculator\ShortInvoiceCalculator;
use App\Invoice\InvoiceItem;
use App\Invoice\InvoiceModel;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\DebugFormatter;
/**
* @covers \App\Invoice\Calculator\ShortInvoiceCalculator
@@ -86,7 +87,7 @@ class ShortInvoiceCalculatorTest extends AbstractCalculatorTest
$query = new InvoiceQuery();
$query->setActivity($activity);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);
@@ -167,7 +168,7 @@ class ShortInvoiceCalculatorTest extends AbstractCalculatorTest
$query = new InvoiceQuery();
$query->setActivity($activity);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);
@@ -246,7 +247,7 @@ class ShortInvoiceCalculatorTest extends AbstractCalculatorTest
$query = new InvoiceQuery();
$query->setActivity($activity);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);

3
tests/Invoice/Calculator/UserInvoiceCalculatorTest.php
View File

@@ -18,6 +18,7 @@ use App\Entity\User;
use App\Invoice\Calculator\UserInvoiceCalculator;
use App\Invoice\InvoiceModel;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\DebugFormatter;
/**
* @covers \App\Invoice\Calculator\UserInvoiceCalculator
@@ -104,7 +105,7 @@ class UserInvoiceCalculatorTest extends AbstractCalculatorTest
$query = new InvoiceQuery();
$query->setActivity($activity);
$model = new InvoiceModel();
$model = new InvoiceModel(new DebugFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);

79
tests/Invoice/DebugFormatter.php Normal file
View File

@@ -0,0 +1,79 @@
<?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\Invoice;
use App\Invoice\InvoiceFormatter;
class DebugFormatter implements InvoiceFormatter
{
/**
* @param \DateTime $date
* @return mixed
*/
public function getFormattedDateTime(\DateTime $date)
{
return $date->format('d.m.Y');
}
/**
* @param \DateTime $date
* @return mixed
*/
public function getFormattedTime(\DateTime $date)
{
return $date->format('H:i');
}
/**
* @param mixed $amount
* @param string|null $currency
* @return mixed
*/
public function getFormattedMoney($amount, $currency)
{
if (null !== $currency) {
return $amount . ' ' . $currency;
}
return $amount;
}
/**
* @param \DateTime $date
* @return mixed
*/
public function getFormattedMonthName(\DateTime $date)
{
return $date->format('m');
}
/**
* @param mixed $seconds
* @return mixed
*/
public function getFormattedDuration($seconds)
{
return $seconds;
}
/**
* @param mixed $seconds
* @return mixed
*/
public function getFormattedDecimalDuration($seconds)
{
return $seconds;
}
public function getCurrencySymbol(string $currency): string
{
return $currency;
}
}

2
tests/Invoice/InvoiceItemTest.php
View File

@@ -35,5 +35,7 @@ class InvoiceItemTest extends TestCase
self::assertNull($sut->getUser());
self::assertNull($sut->getDescription());
self::assertEquals(0, $sut->getDuration());
self::assertNull($sut->getCategory());
self::assertNull($sut->getType());
}
}

7
tests/Invoice/InvoiceModelTest.php
View File

@@ -25,7 +25,8 @@ class InvoiceModelTest extends TestCase
{
public function testEmptyObject()
{
$sut = new InvoiceModel();
$formatter = new DebugFormatter();
$sut = new InvoiceModel($formatter);
self::assertNull($sut->getQuery());
self::assertNull($sut->getCustomer());
@@ -38,11 +39,13 @@ class InvoiceModelTest extends TestCase
self::assertNull($sut->getTemplate());
self::assertInstanceOf(\DateTime::class, $sut->getInvoiceDate());
self::assertSame($formatter, $sut->getFormatter());
}
public function testSetter()
{
$sut = new InvoiceModel();
$sut = new InvoiceModel(new DebugFormatter());
$query = new InvoiceQuery();
self::assertInstanceOf(InvoiceModel::class, $sut->setQuery($query));

3
tests/Invoice/NumberGenerator/DateNumberGeneratorTest.php
View File

@@ -11,6 +11,7 @@ namespace App\Tests\Invoice\NumberGenerator;
use App\Invoice\InvoiceModel;
use App\Invoice\NumberGenerator\DateNumberGenerator;
use App\Tests\Invoice\DebugFormatter;
use PHPUnit\Framework\TestCase;
/**
@@ -21,7 +22,7 @@ class DateNumberGeneratorTest extends TestCase
public function testGetInvoiceNumber()
{
$sut = new DateNumberGenerator();
$sut->setModel(new InvoiceModel());
$sut->setModel(new InvoiceModel(new DebugFormatter()));
$this->assertEquals(date('ymd'), $sut->getInvoiceNumber());
$this->assertEquals('default', $sut->getId());

64
tests/Invoice/Renderer/DebugRenderer.php
View File

@@ -11,14 +11,12 @@ namespace App\Tests\Invoice\Renderer;
use App\Entity\InvoiceDocument;
use App\Invoice\InvoiceModel;
use App\Invoice\Renderer\RendererTrait;
use App\Invoice\Renderer\AbstractRenderer;
use App\Invoice\RendererInterface;
use Symfony\Component\HttpFoundation\Response;
class DebugRenderer implements RendererInterface
class DebugRenderer extends AbstractRenderer implements RendererInterface
{
use RendererTrait;
/**
* @return string[]
*/
@@ -35,60 +33,6 @@ class DebugRenderer implements RendererInterface
return 'array';
}
/**
* @param \DateTime $date
* @return mixed
*/
protected function getFormattedDateTime(\DateTime $date)
{
return $date->format('d.m.Y');
}
/**
* @param \DateTime $date
* @return mixed
*/
protected function getFormattedTime(\DateTime $date)
{
return $date->format('H:i');
}
/**
* @param mixed $amount
* @return mixed
*/
protected function getFormattedMoney($amount)
{
return $amount;
}
/**
* @param \DateTime $date
* @return mixed
*/
protected function getFormattedMonthName(\DateTime $date)
{
return $date->format('m');
}
/**
* @param mixed $seconds
* @return mixed
*/
protected function getFormattedDuration($seconds)
{
return $seconds;
}
/**
* @param mixed $seconds
* @return mixed
*/
protected function getFormattedDecimalDuration($seconds)
{
return $seconds;
}
/**
* Render the given InvoiceDocument with the data from the InvoiceModel into a stupid array for testing only.
*
@@ -99,12 +43,12 @@ class DebugRenderer implements RendererInterface
public function render(InvoiceDocument $document, InvoiceModel $model): Response
{
$result = [
'model' => $this->modelToReplacer($model),
'model' => $model->toArray(),
'entries' => [],
];
foreach ($model->getCalculator()->getEntries() as $entry) {
$result['entries'][] = $this->timesheetToArray($entry);
$result['entries'][] = $model->itemToArray($entry);
}
return new Response(json_encode($result));

26
tests/Invoice/Renderer/DebugRendererTest.php
View File

@@ -58,15 +58,19 @@ class DebugRendererTest extends TestCase
'invoice.date',
'invoice.number',
'invoice.currency',
'invoice.currency_symbol',
'invoice.vat',
'invoice.tax',
'invoice.tax_nc',
'invoice.tax_plain',
'invoice.total_time',
'invoice.duration_decimal',
'invoice.total',
'invoice.total_nc',
'invoice.total_plain',
'invoice.subtotal',
'invoice.subtotal_nc',
'invoice.subtotal_plain',
'template.name',
'template.company',
'template.address',
@@ -93,14 +97,28 @@ class DebugRendererTest extends TestCase
'customer.homepage',
'customer.comment',
'customer.fixed_rate',
'customer.fixed_rate_nc',
'customer.fixed_rate_plain',
'customer.hourly_rate',
'customer.hourly_rate_nc',
'customer.hourly_rate_plain',
'customer.meta.foo-customer',
'activity.id',
'activity.name',
'activity.comment',
'activity.fixed_rate',
'activity.fixed_rate_nc',
'activity.fixed_rate_plain',
'activity.hourly_rate',
'activity.hourly_rate_nc',
'activity.hourly_rate_plain',
'activity.meta.foo-activity',
'user.alias',
'user.email',
'user.name',
'user.title',
'user.meta.hello',
'user.meta.kitty',
];
if ($hasProject) {
@@ -111,7 +129,11 @@ class DebugRendererTest extends TestCase
'project.order_date',
'project.order_number',
'project.fixed_rate',
'project.fixed_rate_nc',
'project.fixed_rate_plain',
'project.hourly_rate',
'project.hourly_rate_nc',
'project.hourly_rate_plain',
'project.meta.foo-project',
]);
}
@@ -131,8 +153,10 @@ class DebugRendererTest extends TestCase
'entry.amount',
'entry.rate',
'entry.rate_nc',
'entry.rate_plain',
'entry.total',
'entry.total_nc',
'entry.total_plain',
'entry.currency',
'entry.duration',
'entry.duration_decimal',
@@ -154,6 +178,8 @@ class DebugRendererTest extends TestCase
'entry.customer',
'entry.project_id',
'entry.customer_id',
'entry.category',
'entry.type',
];
$keys = array_merge($keys, $metaFields);

32
tests/Invoice/Renderer/RendererTestTrait.php
View File

@@ -21,7 +21,10 @@ use App\Entity\ProjectMeta;
use App\Entity\Timesheet;
use App\Entity\TimesheetMeta;
use App\Entity\User;
use App\Entity\UserPreference;
use App\Invoice\Calculator\DefaultCalculator;
use App\Invoice\DefaultInvoiceFormatter;
use App\Invoice\InvoiceFormatter;
use App\Invoice\InvoiceModel;
use App\Invoice\NumberGenerator\DateNumberGenerator;
use App\Invoice\Renderer\AbstractRenderer;
@@ -65,6 +68,11 @@ trait RendererTestTrait
* @return AbstractRenderer
*/
protected function getAbstractRenderer(string $classname)
{
return new $classname();
}
protected function getFormatter(): InvoiceFormatter
{
$requestStack = new RequestStack();
$languages = [
@@ -85,11 +93,19 @@ trait RendererTestTrait
$dateExtension = new DateExtensions($localeSettings);
$extensions = new Extensions($localeSettings);
return new $classname($translator, $dateExtension, $extensions);
return new DefaultInvoiceFormatter($translator, $dateExtension, $extensions);
}
protected function getInvoiceModel(): InvoiceModel
{
$user = new User();
$user->setUsername('one-user');
$user->setTitle('user title');
$user->setAlias('genious alias');
$user->setEmail('fantastic@four');
$user->addPreference((new UserPreference())->setName('kitty')->setValue('kat'));
$user->addPreference((new UserPreference())->setName('hello')->setValue('world'));
$customer = new Customer();
$customer->setCurrency('EUR');
$customer->setMetaField((new CustomerMeta())->setName('foo-customer')->setValue('bar-customer')->setIsVisible(true));
@@ -185,11 +201,12 @@ trait RendererTestTrait
$query->setEnd(new \DateTime());
$query->setProject($project);
$model = new InvoiceModel();
$model = new InvoiceModel($this->getFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);
$model->setQuery($query);
$model->setUser($user);
$calculator = new DefaultCalculator();
$calculator->setModel($model);
@@ -206,6 +223,14 @@ trait RendererTestTrait
protected function getInvoiceModelOneEntry(): InvoiceModel
{
$user = new User();
$user->setUsername('one-user');
$user->setTitle('user title');
$user->setAlias('genious alias');
$user->setEmail('fantastic@four');
$user->addPreference((new UserPreference())->setName('kitty')->setValue('kat'));
$user->addPreference((new UserPreference())->setName('hello')->setValue('world'));
$customer = new Customer();
$customer->setCurrency('USD');
$customer->setMetaField((new CustomerMeta())->setName('foo-customer')->setValue('bar-customer')->setIsVisible(true));
@@ -248,11 +273,12 @@ trait RendererTestTrait
$query->setBegin(new \DateTime());
$query->setEnd(new \DateTime());
$model = new InvoiceModel();
$model = new InvoiceModel($this->getFormatter());
$model->setCustomer($customer);
$model->setTemplate($template);
$model->setEntries($entries);
$model->setQuery($query);
$model->setUser($user);
$calculator = new DefaultCalculator();
$calculator->setModel($model);