improved invoices with new renderer (#306)

* added docx renderer and demo template * added csv renderer and demo template * added xlsx renderer and demo template * added ods renderer and demo template * added user calculator * added invoice documentation
2018-09-21 01:27:56 +02:00
parent b035fc9ebd
commit 53f82a808b
121 changed files with 4094 additions and 770 deletions
--- a/tests/Invoice/Renderer/AbstractRendererTest.php
+++ b/tests/Invoice/Renderer/AbstractRendererTest.php
@@ -0,0 +1,176 @@
+<?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\Renderer;
+
+use App\Entity\Activity;
+use App\Entity\Customer;
+use App\Entity\InvoiceDocument;
+use App\Entity\InvoiceTemplate;
+use App\Entity\Project;
+use App\Entity\Timesheet;
+use App\Entity\User;
+use App\Invoice\Calculator\DefaultCalculator;
+use App\Invoice\NumberGenerator\DateNumberGenerator;
+use App\Invoice\Renderer\AbstractRenderer;
+use App\Model\InvoiceModel;
+use App\Repository\Query\InvoiceQuery;
+use App\Twig\DateExtensions;
+use App\Twig\Extensions;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Translation\TranslatorInterface;
+
+abstract class AbstractRendererTest extends KernelTestCase
+{
+    /**
+     * @return string
+     */
+    protected function getInvoiceTemplatePath()
+    {
+        return __DIR__ . '/../../../templates/invoice/renderer/';
+    }
+
+    /**
+     * @param string $filename
+     * @return InvoiceDocument
+     */
+    protected function getInvoiceDocument(string $filename)
+    {
+        return new InvoiceDocument(
+            new \SplFileInfo($this->getInvoiceTemplatePath() . $filename)
+        );
+    }
+
+    /**
+     * @param string $classname
+     * @return AbstractRenderer
+     */
+    protected function getAbstractRenderer(string $classname)
+    {
+        $requestStack = new RequestStack();
+        $dateSettings = [];
+        $languages = [];
+
+        $request = new Request();
+        $request->setLocale('en');
+        $requestStack->push($request);
+
+        $translator = $this->getMockBuilder(TranslatorInterface::class)->getMock();
+        $dateExtension = new DateExtensions($requestStack, $dateSettings);
+        $extensions = new Extensions($requestStack, $languages);
+
+        return new $classname($translator, $dateExtension, $extensions);
+    }
+
+    /**
+     * @return InvoiceModel
+     */
+    protected function getInvoiceModel()
+    {
+        $customer = new Customer();
+        $template = new InvoiceTemplate();
+        $template->setTitle('a test invoice template title');
+        $template->setVat(19);
+
+        $project = new Project();
+        $project->setName('project name');
+        $project->setCustomer($customer);
+
+        $activity = new Activity();
+        $activity->setName('activity description');
+        $activity->setProject($project);
+
+        $userMethods = ['getId', 'getPreferenceValue', 'getUsername'];
+        $user1 = $this->getMockBuilder(User::class)->setMethods($userMethods)->disableOriginalConstructor()->getMock();
+        $user1->method('getId')->willReturn(1);
+        $user1->method('getPreferenceValue')->willReturn('50');
+        $user1->method('getUsername')->willReturn('foo-bar');
+
+        $user2 = $this->getMockBuilder(User::class)->setMethods($userMethods)->disableOriginalConstructor()->getMock();
+        $user2->method('getId')->willReturn(2);
+        $user2->method('getUsername')->willReturn('hello-world');
+
+        $timesheet = new Timesheet();
+        $timesheet
+            ->setDuration(3600)
+            ->setRate(293.27)
+            ->setUser($user1)
+            ->setActivity($activity)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet2 = new Timesheet();
+        $timesheet2
+            ->setDuration(400)
+            ->setRate(84.75)
+            ->setUser($user2)
+            ->setActivity($activity)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet3 = new Timesheet();
+        $timesheet3
+            ->setDuration(1800)
+            ->setRate(111.11)
+            ->setUser($user1)
+            ->setActivity($activity)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet4 = new Timesheet();
+        $timesheet4
+            ->setDuration(400)
+            ->setRate(1947.99)
+            ->setUser($user2)
+            ->setActivity($activity)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet5 = new Timesheet();
+        $timesheet5
+            ->setDuration(400)
+            ->setFixedRate(84)
+            ->setUser((new User())->setUsername('kevin'))
+            ->setActivity($activity)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $entries = [$timesheet, $timesheet2, $timesheet3, $timesheet4, $timesheet5];
+
+        $query = new InvoiceQuery();
+        $query->setActivity($activity);
+        $query->setBegin(new \DateTime());
+        $query->setEnd(new \DateTime());
+
+        $model = new InvoiceModel();
+        $model->setCustomer($customer);
+        $model->setTemplate($template);
+        $model->setEntries($entries);
+        $model->setQuery($query);
+
+        $calculator = new DefaultCalculator();
+        $calculator->setModel($model);
+
+        $model->setCalculator($calculator);
+
+        $numberGenerator = new DateNumberGenerator();
+        $numberGenerator->setModel($model);
+
+        $model->setNumberGenerator($numberGenerator);
+
+        return $model;
+    }
+}
--- a/tests/Invoice/Renderer/CsvRendererTest.php
+++ b/tests/Invoice/Renderer/CsvRendererTest.php
@@ -0,0 +1,67 @@
+<?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\Renderer;
+
+use App\Invoice\Renderer\CsvRenderer;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+/**
+ * @covers \App\Invoice\Renderer\CsvRenderer
+ * @covers \App\Invoice\Renderer\AbstractRenderer
+ * @covers \App\Invoice\Renderer\AbstractSpreadsheetRenderer
+ */
+class CsvRendererTest extends AbstractRendererTest
+{
+    public function testSupports()
+    {
+        $sut = $this->getAbstractRenderer(CsvRenderer::class);
+
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('default.html.twig')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('freelancer.html.twig')));
+        $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->assertFalse($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
+    }
+
+    public function testRender()
+    {
+        /** @var CsvRenderer $sut */
+        $sut = $this->getAbstractRenderer(CsvRenderer::class);
+        $model = $this->getInvoiceModel();
+        $document = $this->getInvoiceDocument('export.csv');
+        /** @var BinaryFileResponse $response */
+        $response = $sut->render($document, $model);
+
+        $file = $response->getFile();
+        $this->assertEquals('text/csv', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=export.csv', $response->headers->get('Content-Disposition'));
+
+        $this->assertTrue(file_exists($file->getRealPath()));
+        $content = file_get_contents($file->getRealPath());
+
+        $this->assertNotContains('${', $content);
+        $this->assertContains(',"1,947.99"', $content);
+        $this->assertEquals(6, substr_count($content, PHP_EOL));
+        $this->assertEquals(5, substr_count($content, 'activity description'));
+        $this->assertEquals(1, substr_count($content, ',"kevin",'));
+        $this->assertEquals(2, substr_count($content, ',"hello-world",'));
+        $this->assertEquals(2, substr_count($content, ',"foo-bar",'));
+
+        ob_start();
+        $response->sendContent();
+        $content2 = ob_get_clean();
+
+        $this->assertEquals($content, $content2);
+        $this->assertFalse(file_exists($file->getRealPath()));
+    }
+}
--- a/tests/Invoice/Renderer/DocxRendererTest.php
+++ b/tests/Invoice/Renderer/DocxRendererTest.php
@@ -0,0 +1,69 @@
+<?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\Renderer;
+
+use App\Invoice\Renderer\DocxRenderer;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+/**
+ * @covers \App\Invoice\Renderer\DocxRenderer
+ * @covers \App\Invoice\Renderer\AbstractRenderer
+ */
+class DocxRendererTest extends AbstractRendererTest
+{
+    public function testSupports()
+    {
+        $sut = $this->getAbstractRenderer(DocxRenderer::class);
+
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('default.html.twig')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('freelancer.html.twig')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('timesheet.html.twig')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('foo.html.twig')));
+        $this->assertTrue($sut->supports($this->getInvoiceDocument('company.docx')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('export.csv')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
+    }
+
+    public function testRender()
+    {
+        /** @var DocxRenderer $sut */
+        $sut = $this->getAbstractRenderer(DocxRenderer::class);
+        $model = $this->getInvoiceModel();
+        $document = $this->getInvoiceDocument('company.docx');
+        /** @var BinaryFileResponse $response */
+        $response = $sut->render($document, $model);
+
+        $file = $response->getFile();
+        $this->assertEquals('application/vnd.openxmlformats-officedocument.wordprocessingml.document', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=company.docx', $response->headers->get('Content-Disposition'));
+
+        $this->assertTrue(file_exists($file->getRealPath()));
+
+        // TODO test document content?
+        /*
+        $content = file_get_contents($file->getRealPath());
+        $this->assertNotContains('${', $content);
+        $this->assertContains(',"1,947.99" ', $content);
+        $this->assertEquals(6, substr_count($content, PHP_EOL));
+        $this->assertEquals(5, substr_count($content, 'activity description'));
+        $this->assertEquals(1, substr_count($content, ',"kevin",'));
+        $this->assertEquals(2, substr_count($content, ',"hello-world",'));
+        $this->assertEquals(2, substr_count($content, ',"foo-bar",'));
+        */
+
+        ob_start();
+        $response->sendContent();
+        $content2 = ob_get_clean();
+        $this->assertNotEmpty($content2);
+
+        $this->assertFalse(file_exists($file->getRealPath()));
+    }
+}
--- a/tests/Invoice/Renderer/OdsRendererTest.php
+++ b/tests/Invoice/Renderer/OdsRendererTest.php
@@ -0,0 +1,70 @@
+<?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\Renderer;
+
+use App\Invoice\Renderer\OdsRenderer;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+/**
+ * @covers \App\Invoice\Renderer\OdsRenderer
+ * @covers \App\Invoice\Renderer\AbstractRenderer
+ * @covers \App\Invoice\Renderer\AbstractSpreadsheetRenderer
+ */
+class OdsRendererTest extends AbstractRendererTest
+{
+    public function testSupports()
+    {
+        $sut = $this->getAbstractRenderer(OdsRenderer::class);
+
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('default.html.twig')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('freelancer.html.twig')));
+        $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->assertFalse($sut->supports($this->getInvoiceDocument('export.csv')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
+        $this->assertTrue($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
+    }
+
+    public function testRender()
+    {
+        /** @var OdsRenderer $sut */
+        $sut = $this->getAbstractRenderer(OdsRenderer::class);
+        $model = $this->getInvoiceModel();
+        $document = $this->getInvoiceDocument('open-spreadsheet.ods');
+        /** @var BinaryFileResponse $response */
+        $response = $sut->render($document, $model);
+
+        $file = $response->getFile();
+        $this->assertEquals('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=open-spreadsheet.ods', $response->headers->get('Content-Disposition'));
+
+        $this->assertTrue(file_exists($file->getRealPath()));
+
+        // TODO test spreadsheet content?
+        /*
+        $content = file_get_contents($file->getRealPath());
+        $this->assertNotContains('${', $content);
+        $this->assertContains(',"1,947.99" ', $content);
+        $this->assertEquals(6, substr_count($content, PHP_EOL));
+        $this->assertEquals(5, substr_count($content, 'activity description'));
+        $this->assertEquals(1, substr_count($content, ',"kevin",'));
+        $this->assertEquals(2, substr_count($content, ',"hello-world",'));
+        $this->assertEquals(2, substr_count($content, ',"foo-bar",'));
+        */
+
+        ob_start();
+        $response->sendContent();
+        $content2 = ob_get_clean();
+        $this->assertNotEmpty($content2);
+
+        $this->assertFalse(file_exists($file->getRealPath()));
+    }
+}
--- a/tests/Invoice/Renderer/TwigRendererTest.php
+++ b/tests/Invoice/Renderer/TwigRendererTest.php
@@ -0,0 +1,65 @@
+<?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\Renderer;
+
+use App\Invoice\Renderer\TwigRenderer;
+use Symfony\Component\HttpFoundation\Request;
+use Twig\Loader\FilesystemLoader;
+
+/**
+ * @covers \App\Invoice\Renderer\TwigRenderer
+ */
+class TwigRendererTest extends AbstractRendererTest
+{
+    public function testSupports()
+    {
+        $loader = new FilesystemLoader();
+        $env = new \Twig_Environment($loader);
+        $sut = new TwigRenderer($env);
+
+        $this->assertTrue($sut->supports($this->getInvoiceDocument('default.html.twig')));
+        $this->assertTrue($sut->supports($this->getInvoiceDocument('freelancer.html.twig')));
+        $this->assertTrue($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->assertFalse($sut->supports($this->getInvoiceDocument('export.csv')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
+    }
+
+    public function testRender()
+    {
+        $kernel = self::bootKernel();
+        /** @var \Twig_Environment $twig */
+        $twig = $kernel->getContainer()->get('twig');
+        $stack = $kernel->getContainer()->get('request_stack');
+        $request = new Request();
+        $request->setLocale('en');
+        $stack->push($request);
+
+        /** @var FilesystemLoader $loader */
+        $loader = $twig->getLoader();
+        $loader->addPath($this->getInvoiceTemplatePath(), 'invoice');
+
+        $sut = new TwigRenderer($twig);
+
+        $model = $this->getInvoiceModel();
+
+        $document = $this->getInvoiceDocument('timesheet.html.twig');
+        $response = $sut->render($document, $model);
+
+        $content = $response->getContent();
+
+        $this->assertContains('<h2 class="page-header">
+           <span contenteditable="true">a test invoice template title</span>
+        </h2>', $content);
+        $this->assertEquals(5, substr_count($content, '<td>activity description / project name</td>'));
+    }
+}
--- a/tests/Invoice/Renderer/XlsxRendererTest.php
+++ b/tests/Invoice/Renderer/XlsxRendererTest.php
@@ -0,0 +1,70 @@
+<?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\Renderer;
+
+use App\Invoice\Renderer\XlsxRenderer;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+/**
+ * @covers \App\Invoice\Renderer\XlsxRenderer
+ * @covers \App\Invoice\Renderer\AbstractRenderer
+ * @covers \App\Invoice\Renderer\AbstractSpreadsheetRenderer
+ */
+class XlsxRendererTest extends AbstractRendererTest
+{
+    public function testSupports()
+    {
+        $sut = $this->getAbstractRenderer(XlsxRenderer::class);
+
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('default.html.twig')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('freelancer.html.twig')));
+        $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->assertFalse($sut->supports($this->getInvoiceDocument('export.csv')));
+        $this->assertTrue($sut->supports($this->getInvoiceDocument('spreadsheet.xlsx')));
+        $this->assertFalse($sut->supports($this->getInvoiceDocument('open-spreadsheet.ods')));
+    }
+
+    public function testRender()
+    {
+        /** @var XlsxRenderer $sut */
+        $sut = $this->getAbstractRenderer(XlsxRenderer::class);
+        $model = $this->getInvoiceModel();
+        $document = $this->getInvoiceDocument('spreadsheet.xlsx');
+        /** @var BinaryFileResponse $response */
+        $response = $sut->render($document, $model);
+
+        $file = $response->getFile();
+        $this->assertEquals('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=spreadsheet.xlsx', $response->headers->get('Content-Disposition'));
+
+        $this->assertTrue(file_exists($file->getRealPath()));
+
+        // TODO test document content?
+        /*
+        $content = file_get_contents($file->getRealPath());
+        $this->assertNotContains('${', $content);
+        $this->assertContains(',"1,947.99" ', $content);
+        $this->assertEquals(6, substr_count($content, PHP_EOL));
+        $this->assertEquals(5, substr_count($content, 'activity description'));
+        $this->assertEquals(1, substr_count($content, ',"kevin",'));
+        $this->assertEquals(2, substr_count($content, ',"hello-world",'));
+        $this->assertEquals(2, substr_count($content, ',"foo-bar",'));
+        */
+
+        ob_start();
+        $response->sendContent();
+        $content2 = ob_get_clean();
+        $this->assertNotEmpty($content2);
+
+        $this->assertFalse(file_exists($file->getRealPath()));
+    }
+}