added export module (#538)

tests/Export/Renderer/AbstractRendererTest.php

@@ -0,0 +1,148 @@
+<?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\Renderer;
+
+use App\Entity\Activity;
+use App\Entity\Customer;
+use App\Entity\Project;
+use App\Entity\Timesheet;
+use App\Entity\User;
+use App\Export\RendererInterface;
+use App\Repository\Query\TimesheetQuery;
+use App\Twig\DateExtensions;
+use App\Twig\Extensions;
+use App\Utils\LocaleSettings;
+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
+{
+    /**
+     * @param string $classname
+     * @return RendererInterface
+     */
+    protected function getAbstractRenderer(string $classname)
+    {
+        $requestStack = new RequestStack();
+        $languages = [
+            'en' => [
+                'date' => 'Y.m.d',
+                'duration' => '%h:%m h'
+            ]
+        ];
+
+        $request = new Request();
+        $request->setLocale('en');
+        $requestStack->push($request);
+
+        $localeSettings = new LocaleSettings($requestStack, $languages);
+
+        $translator = $this->getMockBuilder(TranslatorInterface::class)->getMock();
+        $dateExtension = new DateExtensions($localeSettings);
+        $extensions = new Extensions($requestStack, $localeSettings);
+
+        return new $classname($translator, $dateExtension, $extensions);
+    }
+
+    /**
+     * @param RendererInterface $renderer
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
+    protected function render(RendererInterface $renderer)
+    {
+        $customer = new Customer();
+        $customer->setName('Customer Name');
+
+        $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)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet2 = new Timesheet();
+        $timesheet2
+            ->setDuration(400)
+            ->setRate(84.75)
+            ->setUser($user2)
+            ->setActivity($activity)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet3 = new Timesheet();
+        $timesheet3
+            ->setDuration(1800)
+            ->setRate(111.11)
+            ->setUser($user1)
+            ->setActivity($activity)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet4 = new Timesheet();
+        $timesheet4
+            ->setDuration(400)
+            ->setRate(1947.99)
+            ->setUser($user2)
+            ->setActivity($activity)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet5 = new Timesheet();
+        $timesheet5
+            ->setDuration(400)
+            ->setFixedRate(84)
+            ->setUser((new User())->setUsername('kevin'))
+            ->setActivity($activity)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $entries = [$timesheet, $timesheet2, $timesheet3, $timesheet4, $timesheet5];
+
+        $query = new TimesheetQuery();
+        $query->setActivity($activity);
+        $query->setBegin(new \DateTime());
+        $query->setEnd(new \DateTime());
+        $query->setProject($project);
+
+        return $renderer->render($entries, $query);
+    }
+}

tests/Export/Renderer/CsvRendererTest.php

@@ -0,0 +1,71 @@
+<?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\Renderer;
+
+use App\Export\Renderer\CsvRenderer;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+/**
+ * @covers \App\Export\Renderer\CsvRenderer
+ * @covers \App\Export\Renderer\AbstractSpreadsheetRenderer
+ * @covers \App\Export\Renderer\RendererTrait
+ */
+class CsvRendererTest extends AbstractRendererTest
+{
+    public function testConfiguration()
+    {
+        $sut = $this->getAbstractRenderer(CsvRenderer::class);
+
+        $this->assertEquals('csv', $sut->getId());
+        $this->assertEquals('csv', $sut->getTitle());
+        $this->assertEquals('csv', $sut->getIcon());
+    }
+
+    public function getTestModel()
+    {
+        return [
+            ['01:50 h', '2,437.12 €', '1,947.99 €', 7, 5, 1, 2, 2]
+        ];
+    }
+
+    /**
+     * @dataProvider getTestModel
+     */
+    public function testRender($totalDuration, $totalRate, $expectedRate, $expectedRows, $expectedDescriptions, $expectedUser1, $expectedUser2, $expectedUser3)
+    {
+        $sut = $this->getAbstractRenderer(CsvRenderer::class);
+
+        /** @var BinaryFileResponse $response */
+        $response = $this->render($sut);
+
+        $file = $response->getFile();
+        $this->assertEquals('text/csv', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=kimai-export.csv', $response->headers->get('Content-Disposition'));
+
+        $this->assertTrue(file_exists($file->getRealPath()));
+        $content = file_get_contents($file->getRealPath());
+
+        $this->assertContains('"' . $totalDuration . '"', $content);
+        $this->assertContains('"' . $totalRate . '"', $content);
+        $this->assertContains('"' . $expectedRate . '"', $content);
+        $this->assertEquals($expectedRows, substr_count($content, PHP_EOL));
+        $this->assertEquals($expectedDescriptions, substr_count($content, 'activity description'));
+        $this->assertEquals($expectedUser1, substr_count($content, ',"kevin",'));
+        $this->assertEquals($expectedUser3, substr_count($content, ',"hello-world",'));
+        $this->assertEquals($expectedUser2, substr_count($content, ',"foo-bar",'));
+
+        ob_start();
+        $response->sendContent();
+        $content2 = ob_get_clean();
+
+        $this->assertEquals($content, $content2);
+        $this->assertFalse(file_exists($file->getRealPath()));
+    }
+}

tests/Export/Renderer/HtmlRendererTest.php

@@ -0,0 +1,62 @@
+<?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\Renderer;
+
+use App\Export\Renderer\HtmlRenderer;
+use Symfony\Component\HttpFoundation\Request;
+use Twig\Loader\FilesystemLoader;
+
+/**
+ * @covers \App\Export\Renderer\HtmlRenderer
+ * @covers \App\Export\Renderer\RendererTrait
+ */
+class HtmlRendererTest extends AbstractRendererTest
+{
+    public function testConfiguration()
+    {
+        $sut = new HtmlRenderer(
+            $this->getMockBuilder(\Twig_Environment::class)->disableOriginalConstructor()->getMock()
+        );
+
+        $this->assertEquals('html', $sut->getId());
+        $this->assertEquals('print', $sut->getTitle());
+        $this->assertEquals('print', $sut->getIcon());
+    }
+
+    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();
+
+        $sut = new HtmlRenderer($twig);
+
+        $response = $this->render($sut);
+
+        $content = $response->getContent();
+
+        $this->assertContains('<h2>List of expenses</h2>', $content);
+        $this->assertContains('<h3>Summary</h3>', $content);
+
+        $this->assertContains('<td>Customer Name</td>', $content);
+        $this->assertContains('<td>project name</td>', $content);
+        $this->assertContains('<td class="duration">01:50 h</td>', $content);
+        $this->assertContains('<td class="cost">2,437.12 €</td>', $content);
+
+        $this->assertEquals(5, substr_count($content, '<td>activity description</td>'));
+    }
+}

tests/Export/Renderer/OdsRendererTest.php

@@ -0,0 +1,51 @@
+<?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\Renderer;
+
+use App\Export\Renderer\OdsRenderer;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+/**
+ * @covers \App\Export\Renderer\OdsRenderer
+ * @covers \App\Export\Renderer\AbstractSpreadsheetRenderer
+ * @covers \App\Export\Renderer\RendererTrait
+ */
+class OdsRendererTest extends AbstractRendererTest
+{
+    public function testConfiguration()
+    {
+        $sut = $this->getAbstractRenderer(OdsRenderer::class);
+
+        $this->assertEquals('ods', $sut->getId());
+        $this->assertEquals('ods', $sut->getTitle());
+        $this->assertEquals('ods', $sut->getIcon());
+    }
+
+    public function testRender()
+    {
+        $sut = $this->getAbstractRenderer(OdsRenderer::class);
+
+        /** @var BinaryFileResponse $response */
+        $response = $this->render($sut);
+
+        $file = $response->getFile();
+        $this->assertEquals('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=kimai-export.ods', $response->headers->get('Content-Disposition'));
+
+        $this->assertTrue(file_exists($file->getRealPath()));
+
+        ob_start();
+        $response->sendContent();
+        $content2 = ob_get_clean();
+        $this->assertNotEmpty($content2);
+
+        $this->assertFalse(file_exists($file->getRealPath()));
+    }
+}

tests/Export/Renderer/PdfRendererTest.php

@@ -0,0 +1,55 @@
+<?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\Renderer;
+
+use App\Export\Renderer\PDFRenderer;
+use Symfony\Component\HttpFoundation\Request;
+use Twig\Loader\FilesystemLoader;
+
+/**
+ * @covers \App\Export\Renderer\PDFRenderer
+ * @covers \App\Export\Renderer\RendererTrait
+ */
+class PdfRendererTest extends AbstractRendererTest
+{
+    public function testConfiguration()
+    {
+        $sut = new PDFRenderer(
+            $this->getMockBuilder(\Twig_Environment::class)->disableOriginalConstructor()->getMock()
+        );
+
+        $this->assertEquals('pdf', $sut->getId());
+        $this->assertEquals('pdf', $sut->getTitle());
+        $this->assertEquals('pdf', $sut->getIcon());
+    }
+
+    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();
+
+        $sut = new PDFRenderer($twig);
+
+        $response = $this->render($sut);
+
+        $this->assertEquals('application/pdf', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=kimai-export.pdf', $response->headers->get('Content-Disposition'));
+
+        $this->assertNotEmpty($response->getContent());
+    }
+}

tests/Export/Renderer/XlsxRendererTest.php

@@ -0,0 +1,51 @@
+<?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\Renderer;
+
+use App\Export\Renderer\XlsxRenderer;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+/**
+ * @covers \App\Export\Renderer\XlsxRenderer
+ * @covers \App\Export\Renderer\AbstractSpreadsheetRenderer
+ * @covers \App\Export\Renderer\RendererTrait
+ */
+class XlsxRendererTest extends AbstractRendererTest
+{
+    public function testConfiguration()
+    {
+        $sut = $this->getAbstractRenderer(XlsxRenderer::class);
+
+        $this->assertEquals('xlsx', $sut->getId());
+        $this->assertEquals('xlsx', $sut->getTitle());
+        $this->assertEquals('xlsx', $sut->getIcon());
+    }
+
+    public function testRender()
+    {
+        $sut = $this->getAbstractRenderer(XlsxRenderer::class);
+
+        /** @var BinaryFileResponse $response */
+        $response = $this->render($sut);
+
+        $file = $response->getFile();
+        $this->assertEquals('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=kimai-export.xlsx', $response->headers->get('Content-Disposition'));
+
+        $this->assertTrue(file_exists($file->getRealPath()));
+
+        ob_start();
+        $response->sendContent();
+        $content2 = ob_get_clean();
+        $this->assertNotEmpty($content2);
+
+        $this->assertFalse(file_exists($file->getRealPath()));
+    }
+}