improve export filename (#2958)

tests/Export/ExportFilenameTest.php

@@ -0,0 +1,96 @@
+<?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\Customer;
+use App\Entity\Project;
+use App\Entity\User;
+use App\Export\ExportFilename;
+use App\Repository\Query\TimesheetQuery;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Export\ExportFilename
+ */
+class ExportFilenameTest extends TestCase
+{
+    public function testExportFilename()
+    {
+        $datePrefix = date('Ymd');
+
+        $query = new TimesheetQuery();
+
+        $sut = new ExportFilename($query);
+
+        self::assertEquals($datePrefix . '-kimai-export', $sut->getFilename());
+        self::assertEquals($datePrefix . '-kimai-export', (string) $sut);
+
+        $customer = new Customer();
+        $customer->setName('foo');
+        $query = new TimesheetQuery();
+        $query->addCustomer($customer);
+        $sut = new ExportFilename($query);
+
+        self::assertEquals($datePrefix . '-foo', $sut->getFilename());
+        self::assertEquals($datePrefix . '-foo', (string) $sut);
+
+        $customer->setCompany('barß / laölala #   ldksjf 123 MyAwesome GmbH');
+        $sut = new ExportFilename($query);
+
+        self::assertEquals($datePrefix . '-barss_laolala_ldksjf_123_MyAwesome_GmbH', $sut->getFilename());
+        self::assertEquals($datePrefix . '-barss_laolala_ldksjf_123_MyAwesome_GmbH', (string) $sut);
+
+        $customer->setCompany('까깨꺄꺠꺼께껴꼐꼬꽈sssss');
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-kkakkaekkyakkyaekkeokkekkyeokkyekkokkwasssss', $sut->getFilename());
+
+        $customer->setCompany('\"#+ß.!$%&/()=?\\n=/*-+´_<>@' . "\n");
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-ss_n_-', $sut->getFilename());
+
+        $project = new Project();
+        $project->setName('Demo ProjecT1');
+        $customer->setCompany('\"#+ß.!$%&/()=?\\n=/*-+´_<>@' . "\n");
+        $query->addProject($project);
+
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-ss_n_--Demo_ProjecT1', $sut->getFilename());
+
+        $user = new User();
+        $user->setUsername('thorsten');
+        $query->addUser($user);
+
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-ss_n_--Demo_ProjecT1-thorsten', $sut->getFilename());
+        $user->setAlias('Martin Müller-Lüdenscheidt');
+
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-ss_n_--Demo_ProjecT1-Martin_Muller-Ludenscheidt', $sut->getFilename());
+
+        $user = $this->createMock(User::class);
+        $user->method('getId')->willReturn(1);
+        $query->addUser($user);
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-ss_n_--Demo_ProjecT1', $sut->getFilename());
+
+        $project = new Project();
+        $project->setName('Project2');
+        $query->addProject($project);
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-ss_n_-', $sut->getFilename());
+
+        $customer = new Customer();
+        $customer->setName('Customer AAAA');
+        $query->addCustomer($customer);
+
+        $sut = new ExportFilename($query);
+        self::assertEquals($datePrefix . '-kimai-export', $sut->getFilename());
+    }
+}

tests/Export/Renderer/CsvRendererTest.php

@@ -49,8 +49,9 @@ class CsvRendererTest extends AbstractRendererTest
         $response = $this->render($sut);
 
         $file = $response->getFile();
+        $prefix = date('Ymd');
         $this->assertEquals('text/csv', $response->headers->get('Content-Type'));
-        $this->assertEquals('attachment; filename=kimai-export.csv', $response->headers->get('Content-Disposition'));
+        $this->assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.csv', $response->headers->get('Content-Disposition'));
 
         $this->assertTrue(file_exists($file->getRealPath()));
         $content = file_get_contents($file->getRealPath());

tests/Export/Renderer/PdfRendererTest.php

@@ -58,8 +58,9 @@ class PdfRendererTest extends AbstractRendererTest
 
         $response = $this->render($sut);
 
+        $prefix = date('Ymd');
         $this->assertEquals('application/pdf', $response->headers->get('Content-Type'));
-        $this->assertEquals('attachment; filename=kimai-export.pdf', $response->headers->get('Content-Disposition'));
+        $this->assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.pdf', $response->headers->get('Content-Disposition'));
 
         $this->assertNotEmpty($response->getContent());
     }

tests/Export/Renderer/XlsxRendererTest.php

@@ -39,8 +39,9 @@ class XlsxRendererTest extends AbstractRendererTest
         $response = $this->render($sut);
 
         $file = $response->getFile();
+        $prefix = date('Ymd');
         $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->assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.xlsx', $response->headers->get('Content-Disposition'));
 
         $this->assertTrue(file_exists($file->getRealPath()));
 

tests/Export/Timesheet/CsvRendererTest.php

@@ -46,8 +46,9 @@ class CsvRendererTest extends AbstractRendererTest
         $response = $this->render($sut);
 
         $file = $response->getFile();
+        $prefix = date('Ymd');
         $this->assertEquals('text/csv', $response->headers->get('Content-Type'));
-        $this->assertEquals('attachment; filename=kimai-export.csv', $response->headers->get('Content-Disposition'));
+        $this->assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.csv', $response->headers->get('Content-Disposition'));
 
         $this->assertTrue(file_exists($file->getRealPath()));
         $content = file_get_contents($file->getRealPath());

tests/Export/Timesheet/PdfRendererTest.php

@@ -51,8 +51,9 @@ class PdfRendererTest extends AbstractRendererTest
 
         $response = $this->render($sut);
 
+        $prefix = date('Ymd');
         $this->assertEquals('application/pdf', $response->headers->get('Content-Type'));
-        $this->assertEquals('attachment; filename=kimai-export.pdf', $response->headers->get('Content-Disposition'));
+        $this->assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.pdf', $response->headers->get('Content-Disposition'));
 
         $this->assertNotEmpty($response->getContent());
     }

tests/Export/Timesheet/XlsxRendererTest.php

@@ -36,8 +36,9 @@ class XlsxRendererTest extends AbstractRendererTest
         $response = $this->render($sut);
 
         $file = $response->getFile();
+        $prefix = date('Ymd');
         $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->assertEquals('attachment; filename=' . $prefix . '-Customer_Name-project_name.xlsx', $response->headers->get('Content-Disposition'));
 
         $this->assertTrue(file_exists($file->getRealPath()));