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

added new invoice fields, improved invoice templates (#1258)

Browse Source
This commit is contained in:
Kevin Papst
2019-11-18 12:01:26 +01:00
committed by GitHub
parent 2287c9951c
commit 47bd8b0ce7
50 changed files with 1530 additions and 1222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
tests/Entity/CustomerTest.php
View File

@@ -23,85 +23,89 @@ class CustomerTest extends TestCase
public function testDefaultValues()
{
$sut = new Customer();
$this->assertNull($sut->getId());
$this->assertNull($sut->getName());
$this->assertNull($sut->getNumber());
$this->assertNull($sut->getComment());
$this->assertTrue($sut->getVisible());
self::assertNull($sut->getId());
self::assertNull($sut->getName());
self::assertNull($sut->getNumber());
self::assertNull($sut->getComment());
self::assertTrue($sut->getVisible());
$this->assertNull($sut->getCompany());
$this->assertNull($sut->getContact());
$this->assertNull($sut->getAddress());
$this->assertNull($sut->getCountry());
$this->assertEquals('EUR', $sut->getCurrency());
$this->assertEquals('EUR', Customer::DEFAULT_CURRENCY);
$this->assertNull($sut->getPhone());
$this->assertNull($sut->getFax());
$this->assertNull($sut->getMobile());
$this->assertNull($sut->getEmail());
$this->assertNull($sut->getHomepage());
$this->assertNull($sut->getTimezone());
self::assertNull($sut->getCompany());
self::assertNull($sut->getVatId());
self::assertNull($sut->getContact());
self::assertNull($sut->getAddress());
self::assertNull($sut->getCountry());
self::assertEquals('EUR', $sut->getCurrency());
self::assertEquals('EUR', Customer::DEFAULT_CURRENCY);
self::assertNull($sut->getPhone());
self::assertNull($sut->getFax());
self::assertNull($sut->getMobile());
self::assertNull($sut->getEmail());
self::assertNull($sut->getHomepage());
self::assertNull($sut->getTimezone());
$this->assertNull($sut->getFixedRate());
$this->assertNull($sut->getHourlyRate());
$this->assertNull($sut->getColor());
$this->assertEquals(0.0, $sut->getBudget());
$this->assertEquals(0, $sut->getTimeBudget());
$this->assertInstanceOf(Collection::class, $sut->getMetaFields());
$this->assertEquals(0, $sut->getMetaFields()->count());
$this->assertNull($sut->getMetaField('foo'));
$this->assertInstanceOf(Collection::class, $sut->getTeams());
$this->assertEquals(0, $sut->getTeams()->count());
self::assertNull($sut->getFixedRate());
self::assertNull($sut->getHourlyRate());
self::assertNull($sut->getColor());
self::assertEquals(0.0, $sut->getBudget());
self::assertEquals(0, $sut->getTimeBudget());
self::assertInstanceOf(Collection::class, $sut->getMetaFields());
self::assertEquals(0, $sut->getMetaFields()->count());
self::assertNull($sut->getMetaField('foo'));
self::assertInstanceOf(Collection::class, $sut->getTeams());
self::assertEquals(0, $sut->getTeams()->count());
}
public function testSetterAndGetter()
{
$sut = new Customer();
$this->assertInstanceOf(Customer::class, $sut->setName('foo-bar'));
$this->assertEquals('foo-bar', $sut->getName());
$this->assertEquals('foo-bar', (string) $sut);
self::assertInstanceOf(Customer::class, $sut->setName('foo-bar'));
self::assertEquals('foo-bar', $sut->getName());
self::assertEquals('foo-bar', (string) $sut);
$this->assertInstanceOf(Customer::class, $sut->setVisible(false));
$this->assertFalse($sut->getVisible());
self::assertInstanceOf(Customer::class, $sut->setVisible(false));
self::assertFalse($sut->getVisible());
$this->assertInstanceOf(Customer::class, $sut->setComment('hello world'));
$this->assertEquals('hello world', $sut->getComment());
self::assertInstanceOf(Customer::class, $sut->setComment('hello world'));
self::assertEquals('hello world', $sut->getComment());
$this->assertInstanceOf(Customer::class, $sut->setColor('#fffccc'));
$this->assertEquals('#fffccc', $sut->getColor());
self::assertInstanceOf(Customer::class, $sut->setColor('#fffccc'));
self::assertEquals('#fffccc', $sut->getColor());
$this->assertInstanceOf(Customer::class, $sut->setCompany('test company'));
$this->assertEquals('test company', $sut->getCompany());
self::assertInstanceOf(Customer::class, $sut->setCompany('test company'));
self::assertEquals('test company', $sut->getCompany());
$this->assertInstanceOf(Customer::class, $sut->setContact('test contact'));
$this->assertEquals('test contact', $sut->getContact());
self::assertInstanceOf(Customer::class, $sut->setContact('test contact'));
self::assertEquals('test contact', $sut->getContact());
$this->assertInstanceOf(Customer::class, $sut->setPhone('0123456789'));
$this->assertEquals('0123456789', $sut->getPhone());
self::assertInstanceOf(Customer::class, $sut->setPhone('0123456789'));
self::assertEquals('0123456789', $sut->getPhone());
$this->assertInstanceOf(Customer::class, $sut->setFax('asdfghjkl'));
$this->assertEquals('asdfghjkl', $sut->getFax());
self::assertInstanceOf(Customer::class, $sut->setFax('asdfghjkl'));
self::assertEquals('asdfghjkl', $sut->getFax());
$this->assertInstanceOf(Customer::class, $sut->setMobile('76576534'));
$this->assertEquals('76576534', $sut->getMobile());
self::assertInstanceOf(Customer::class, $sut->setMobile('76576534'));
self::assertEquals('76576534', $sut->getMobile());
$this->assertInstanceOf(Customer::class, $sut->setEmail('test@example.com'));
$this->assertEquals('test@example.com', $sut->getEmail());
self::assertInstanceOf(Customer::class, $sut->setEmail('test@example.com'));
self::assertEquals('test@example.com', $sut->getEmail());
$this->assertInstanceOf(Customer::class, $sut->setHomepage('https://www.example.com'));
$this->assertEquals('https://www.example.com', $sut->getHomepage());
self::assertInstanceOf(Customer::class, $sut->setHomepage('https://www.example.com'));
self::assertEquals('https://www.example.com', $sut->getHomepage());
$this->assertInstanceOf(Customer::class, $sut->setFixedRate(13.47));
$this->assertEquals(13.47, $sut->getFixedRate());
self::assertInstanceOf(Customer::class, $sut->setFixedRate(13.47));
self::assertEquals(13.47, $sut->getFixedRate());
$this->assertInstanceOf(Customer::class, $sut->setHourlyRate(99));
$this->assertEquals(99, $sut->getHourlyRate());
self::assertInstanceOf(Customer::class, $sut->setHourlyRate(99));
self::assertEquals(99, $sut->getHourlyRate());
$this->assertInstanceOf(Customer::class, $sut->setBudget(12345.67));
$this->assertEquals(12345.67, $sut->getBudget());
self::assertInstanceOf(Customer::class, $sut->setBudget(12345.67));
self::assertEquals(12345.67, $sut->getBudget());
$this->assertInstanceOf(Customer::class, $sut->setTimeBudget(937321));
$this->assertEquals(937321, $sut->getTimeBudget());
self::assertInstanceOf(Customer::class, $sut->setTimeBudget(937321));
self::assertEquals(937321, $sut->getTimeBudget());
self::assertInstanceOf(Customer::class, $sut->setVatId('ID 1234567890'));
self::assertEquals('ID 1234567890', $sut->getVatId());
}
public function testMetaFields()
@@ -109,7 +113,7 @@ class CustomerTest extends TestCase
$sut = new Customer();
$meta = new CustomerMeta();
$meta->setName('foo')->setValue('bar')->setType('test');
$this->assertInstanceOf(Customer::class, $sut->setMetaField($meta));
self::assertInstanceOf(Customer::class, $sut->setMetaField($meta));
self::assertEquals(1, $sut->getMetaFields()->count());
$result = $sut->getMetaField('foo');
self::assertSame($result, $meta);
@@ -117,7 +121,7 @@ class CustomerTest extends TestCase
$meta2 = new CustomerMeta();
$meta2->setName('foo')->setValue('bar')->setType('test2');
$this->assertInstanceOf(Customer::class, $sut->setMetaField($meta2));
self::assertInstanceOf(Customer::class, $sut->setMetaField($meta2));
self::assertEquals(1, $sut->getMetaFields()->count());
self::assertCount(0, $sut->getVisibleMetaFields());

61
tests/Entity/InvoiceTemplateTest.php
View File

@@ -17,36 +17,63 @@ use PHPUnit\Framework\TestCase;
*/
class InvoiceTemplateTest extends TestCase
{
protected function assertIsFluent($actual)
public function testDefaultValues()
{
$this->assertInstanceOf(InvoiceTemplate::class, $actual);
$sut = new InvoiceTemplate();
self::assertNull($sut->getVatId());
self::assertNull($sut->getPaymentDetails());
self::assertNull($sut->getPaymentTerms());
self::assertNull($sut->getContact());
self::assertEquals(0.00, $sut->getVat());
self::assertNull($sut->getId());
self::assertNull($sut->getName());
self::assertNull($sut->getAddress());
self::assertNull($sut->getTitle());
self::assertNull($sut->getCompany());
self::assertEquals('default', $sut->getCalculator());
self::assertEquals('default', $sut->getNumberGenerator());
self::assertEquals('default', $sut->getRenderer());
self::assertEquals(30, $sut->getDueDays());
}
protected function getEntity()
public function testSetNullForOptionalValues()
{
$entity = new InvoiceTemplate();
$sut = new InvoiceTemplate();
return $entity;
self::assertInstanceOf(InvoiceTemplate::class, $sut->setPaymentDetails(null));
self::assertInstanceOf(InvoiceTemplate::class, $sut->setVatId(null));
self::assertInstanceOf(InvoiceTemplate::class, $sut->setContact(null));
self::assertInstanceOf(InvoiceTemplate::class, $sut->setAddress(null));
self::assertInstanceOf(InvoiceTemplate::class, $sut->setPaymentTerms(null));
}
public function testSetGetPaymentTerms()
public function testSetterAndGetter()
{
$sut = $this->getEntity();
$sut = new InvoiceTemplate();
$this->assertNull($sut->getPaymentTerms());
$this->assertIsFluent($sut->setPaymentTerms(null));
$this->assertIsFluent($sut->setPaymentTerms(''));
$this->assertIsFluent($sut->setPaymentTerms('foo bar'));
$this->assertEquals('foo bar', $sut->getPaymentTerms());
self::assertInstanceOf(InvoiceTemplate::class, $sut->setPaymentTerms('foo bar'));
self::assertEquals('foo bar', $sut->getPaymentTerms());
self::assertInstanceOf(InvoiceTemplate::class, $sut->setPaymentDetails('iuasdzgf isdfhvlksdjfbnvl ksdfbglisbdf'));
self::assertEquals('iuasdzgf isdfhvlksdjfbnvl ksdfbglisbdf', $sut->getPaymentDetails());
self::assertInstanceOf(InvoiceTemplate::class, $sut->setContact('hello world'));
self::assertEquals('hello world', $sut->getContact());
self::assertInstanceOf(InvoiceTemplate::class, $sut->setVat(7.31));
self::assertEquals(7.31, $sut->getVat());
self::assertInstanceOf(InvoiceTemplate::class, $sut->setVatId('1234567890'));
self::assertEquals('1234567890', $sut->getVatId());
}
public function testToString()
{
$sut = $this->getEntity();
$sut = new InvoiceTemplate();
$this->assertNull($sut->__toString());
$this->assertIsFluent($sut->setName('a template name'));
$this->assertEquals('a template name', $sut->__toString());
$this->assertEquals('a template name', (string) $sut);
self::assertInstanceOf(InvoiceTemplate::class, $sut->setName('a template name'));
self::assertEquals('a template name', $sut->__toString());
self::assertEquals('a template name', (string) $sut);
}
}

4
tests/Invoice/Renderer/CsvRendererTest.php
View File

@@ -33,7 +33,7 @@ class CsvRendererTest extends TestCase
$this->assertFalse($sut->supports($this->getInvoiceDocument('timesheet.html.twig')));
$this->assertFalse($sut->supports($this->getInvoiceDocument('foo.html.twig')));
$this->assertFalse($sut->supports($this->getInvoiceDocument('company.docx')));
$this->assertTrue($sut->supports($this->getInvoiceDocument('export.csv')));
$this->assertTrue($sut->supports($this->getInvoiceDocument('export.csv', true)));
$this->assertFalse($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
$this->assertFalse($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
}
@@ -51,7 +51,7 @@ class CsvRendererTest extends TestCase
{
/** @var CsvRenderer $sut */
$sut = $this->getAbstractRenderer(CsvRenderer::class);
$document = $this->getInvoiceDocument('export.csv');
$document = $this->getInvoiceDocument('export.csv', true);
/** @var BinaryFileResponse $response */
$response = $sut->render($document, $model);

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

@@ -73,6 +73,9 @@ class DebugRendererTest extends TestCase
'template.title',
'template.payment_terms',
'template.due_days',
'template.vat_id',
'template.contact',
'template.payment_details',
'query.begin',
'query.day',
'query.end',
@@ -84,6 +87,7 @@ class DebugRendererTest extends TestCase
'customer.name',
'customer.contact',
'customer.company',
'customer.vat',
'customer.country',
'customer.number',
'customer.homepage',

4
tests/Invoice/Renderer/OdsRendererTest.php
View File

@@ -35,7 +35,7 @@ class OdsRendererTest extends TestCase
$this->assertFalse($sut->supports($this->getInvoiceDocument('company.docx')));
$this->assertFalse($sut->supports($this->getInvoiceDocument('export.csv')));
$this->assertFalse($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
$this->assertTrue($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
$this->assertTrue($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods', true)));
}
public function getTestModel()
@@ -52,7 +52,7 @@ class OdsRendererTest extends TestCase
/** @var OdsRenderer $sut */
$sut = $this->getAbstractRenderer(OdsRenderer::class);
$model = $this->getInvoiceModel();
$document = $this->getInvoiceDocument('open-spreadsheet.ods');
$document = $this->getInvoiceDocument('open-spreadsheet.ods', true);
/** @var BinaryFileResponse $response */
$response = $sut->render($document, $model);

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

@@ -47,10 +47,16 @@ trait RendererTestTrait
* @param string $filename
* @return InvoiceDocument
*/
protected function getInvoiceDocument(string $filename)
protected function getInvoiceDocument(string $filename, bool $testOnly = false)
{
if (!$testOnly) {
return new InvoiceDocument(
new \SplFileInfo($this->getInvoiceTemplatePath() . $filename)
);
}
return new InvoiceDocument(
new \SplFileInfo($this->getInvoiceTemplatePath() . $filename)
new \SplFileInfo(__DIR__ . '/../templates/' . $filename)
);
}

4
tests/Invoice/Renderer/XlsxRendererTest.php
View File

@@ -34,7 +34,7 @@ class XlsxRendererTest extends TestCase
$this->assertFalse($sut->supports($this->getInvoiceDocument('foo.html.twig')));
$this->assertFalse($sut->supports($this->getInvoiceDocument('company.docx')));
$this->assertFalse($sut->supports($this->getInvoiceDocument('export.csv')));
$this->assertTrue($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
$this->assertTrue($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx', true)));
$this->assertFalse($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
}
@@ -52,7 +52,7 @@ class XlsxRendererTest extends TestCase
/** @var XlsxRenderer $sut */
$sut = $this->getAbstractRenderer(XlsxRenderer::class);
$model = $this->getInvoiceModel();
$document = $this->getInvoiceDocument('spreadsheet.xlsx');
$document = $this->getInvoiceDocument('spreadsheet.xlsx', true);
/** @var BinaryFileResponse $response */
$response = $sut->render($document, $model);

2
tests/Invoice/templates/export.csv Normal file
View File

@@ -0,0 +1,2 @@
start_date,start_timestamp,end_date,end_timestamp,duration,username,description,rate,amount,total
${entry.begin},${entry.begin_timestamp},${entry.end},${entry.end_timestamp},${entry.duration},${entry.user_name},${entry.description},${entry.rate},${entry.amount},${entry.total}
1 start_date start_timestamp end_date end_timestamp duration username description rate amount total
2 ${entry.begin} ${entry.begin_timestamp} ${entry.end} ${entry.end_timestamp} ${entry.duration} ${entry.user_name} ${entry.description} ${entry.rate} ${entry.amount} ${entry.total}

BIN
tests/Invoice/templates/open-spreadsheet.ods Normal file
View File

Binary file not shown.

BIN
tests/Invoice/templates/spreadsheet.xlsx Normal file
View File

Binary file not shown.

3
tests/Repository/InvoiceDocumentRepositoryTest.php
View File

@@ -25,10 +25,7 @@ class InvoiceDocumentRepositoryTest extends TestCase
protected static $defaultDocuments = [
'company.docx',
'default.html.twig',
'export.csv',
'freelancer.html.twig',
'open-spreadsheet.ods',
'spreadsheet.xlsx',
'timesheet.html.twig',
];