improved invoice handling for fixed rates (#1058)

tests/Invoice/Calculator/AbstractCalculatorTest.php

@@ -16,7 +16,7 @@ use App\Entity\Project;
 use App\Entity\Timesheet;
 use App\Entity\User;
 use App\Invoice\CalculatorInterface;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
 use App\Repository\Query\InvoiceQuery;
 use PHPUnit\Framework\TestCase;
 

tests/Invoice/Calculator/ActivityInvoiceCalculatorTest.php

@@ -16,7 +16,7 @@ use App\Entity\Project;
 use App\Entity\Timesheet;
 use App\Entity\User;
 use App\Invoice\Calculator\ActivityInvoiceCalculator;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
 use App\Repository\Query\InvoiceQuery;
 
 /**

tests/Invoice/Calculator/DateInvoiceCalculatorTest.php

@@ -16,7 +16,7 @@ use App\Entity\Project;
 use App\Entity\Timesheet;
 use App\Entity\User;
 use App\Invoice\Calculator\DateInvoiceCalculator;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
 use App\Repository\Query\InvoiceQuery;
 use DateTime;
 

tests/Invoice/Calculator/DefaultCalculatorTest.php

@@ -9,11 +9,13 @@
 
 namespace App\Tests\Invoice\Calculator;
 
+use App\Entity\Activity;
 use App\Entity\Customer;
 use App\Entity\InvoiceTemplate;
 use App\Entity\Timesheet;
 use App\Invoice\Calculator\DefaultCalculator;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
+use App\Repository\Query\InvoiceQuery;
 
 /**
  * @covers \App\Invoice\Calculator\DefaultCalculator
@@ -33,16 +35,22 @@ class DefaultCalculatorTest extends AbstractCalculatorTest
         $template->setVat(19);
 
         $timesheet = new Timesheet();
+        $timesheet->setBegin(new \DateTime());
         $timesheet->setDuration(3600);
         $timesheet->setRate(293.27);
+        $timesheet->setActivity(new Activity());
 
         $timesheet2 = new Timesheet();
+        $timesheet2->setBegin(new \DateTime());
         $timesheet2->setDuration(400);
         $timesheet2->setRate(84);
+        $timesheet2->setActivity(new Activity());
 
         $timesheet3 = new Timesheet();
+        $timesheet3->setBegin(new \DateTime());
         $timesheet3->setDuration(1800);
         $timesheet3->setRate(111.11);
+        $timesheet3->setActivity(new Activity());
 
         $entries = [$timesheet, $timesheet2, $timesheet3];
 
@@ -50,6 +58,7 @@ class DefaultCalculatorTest extends AbstractCalculatorTest
         $model->setCustomer($customer);
         $model->setTemplate($template);
         $model->setEntries($entries);
+        $model->setQuery(new InvoiceQuery());
 
         $sut = new DefaultCalculator();
         $sut->setModel($model);
@@ -60,6 +69,5 @@ class DefaultCalculatorTest extends AbstractCalculatorTest
         $this->assertEquals('EUR', $sut->getCurrency());
         $this->assertEquals(488.38, $sut->getSubtotal());
         $this->assertEquals(5800, $sut->getTimeWorked());
-        $this->assertEquals($entries, $sut->getEntries());
     }
 }

tests/Invoice/Calculator/ProjectInvoiceCalculatorTest.php

@@ -16,7 +16,7 @@ use App\Entity\Project;
 use App\Entity\Timesheet;
 use App\Entity\User;
 use App\Invoice\Calculator\ProjectInvoiceCalculator;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
 use App\Repository\Query\InvoiceQuery;
 use DateTime;
 

tests/Invoice/Calculator/ShortInvoiceCalculatorTest.php

@@ -16,7 +16,7 @@ use App\Entity\Project;
 use App\Entity\Timesheet;
 use App\Entity\User;
 use App\Invoice\Calculator\ShortInvoiceCalculator;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
 use App\Repository\Query\InvoiceQuery;
 
 /**
@@ -104,8 +104,86 @@ class ShortInvoiceCalculatorTest extends AbstractCalculatorTest
         $this->assertEquals('activity description', $result->getDescription());
         $this->assertEquals(488.38, $result->getHourlyRate());
         $this->assertEquals(488.38, $result->getRate());
-        $this->assertEquals(488.38, $result->getFixedRate());
         $this->assertEquals(5800, $result->getDuration());
+        $this->assertNull($result->getFixedRate());
+    }
+
+    public function testWithMixedRateTypes()
+    {
+        $customer = new Customer();
+        $template = new InvoiceTemplate();
+        $template->setVat(19);
+
+        $project = new Project();
+        $project->setName('sdfsdf');
+
+        $activity = new Activity();
+        $activity->setName('activity description');
+        $activity->setProject($project);
+
+        $timesheet = new Timesheet();
+        $timesheet
+            ->setDuration(3600)
+            ->setRate(293.27)
+            ->setUser(new User())
+            ->setActivity($activity)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet2 = new Timesheet();
+        $timesheet2
+            ->setDuration(400)
+            ->setFixedRate(84)
+            ->setRate(84)
+            ->setUser(new User())
+            ->setActivity($activity)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $timesheet3 = new Timesheet();
+        $timesheet3
+            ->setDuration(1800)
+            ->setRate(111.11)
+            ->setUser(new User())
+            ->setActivity($activity)
+            ->setProject($project)
+            ->setBegin(new \DateTime())
+            ->setEnd(new \DateTime())
+        ;
+
+        $entries = [$timesheet, $timesheet2, $timesheet3];
+
+        $query = new InvoiceQuery();
+        $query->setActivity($activity);
+
+        $model = new InvoiceModel();
+        $model->setCustomer($customer);
+        $model->setTemplate($template);
+        $model->setEntries($entries);
+        $model->setQuery($query);
+
+        $sut = new ShortInvoiceCalculator();
+        $sut->setModel($model);
+
+        $this->assertEquals('short', $sut->getId());
+        $this->assertEquals(581.17, $sut->getTotal());
+        $this->assertEquals(19, $sut->getVat());
+        $this->assertEquals('EUR', $sut->getCurrency());
+        $this->assertEquals(488.38, $sut->getSubtotal());
+        $this->assertEquals(5400, $sut->getTimeWorked());
+        $this->assertEquals(1, count($sut->getEntries()));
+
+        /** @var Timesheet $result */
+        $result = $sut->getEntries()[0];
+        $this->assertEquals('activity description', $result->getDescription());
+        $this->assertEquals(488.38, $result->getHourlyRate());
+        $this->assertEquals(488.38, $result->getRate());
+        $this->assertEquals(5800, $result->getDuration());
+        $this->assertEquals(488.38, $result->getFixedRate());
     }
 
     public function testDescriptionByTimesheet()

tests/Invoice/Calculator/UserInvoiceCalculatorTest.php

@@ -16,7 +16,7 @@ use App\Entity\Project;
 use App\Entity\Timesheet;
 use App\Entity\User;
 use App\Invoice\Calculator\UserInvoiceCalculator;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
 use App\Repository\Query\InvoiceQuery;
 
 /**

tests/Invoice/InvoiceItemTest.php

@@ -0,0 +1,39 @@
+<?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\InvoiceItem;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Invoice\InvoiceItem
+ */
+class InvoiceItemTest extends TestCase
+{
+    public function testEmptyObject()
+    {
+        $sut = new InvoiceItem();
+
+        self::assertFalse($sut->isFixedRate());
+        self::assertNull($sut->getHourlyRate());
+        self::assertNull($sut->getFixedRate());
+        self::assertNull($sut->getEnd());
+        self::assertEquals(0.00, $sut->getRate());
+        self::assertNull($sut->getProject());
+        self::assertIsArray($sut->getAdditionalFields());
+        self::assertEmpty($sut->getAdditionalFields());
+        self::assertEquals(0, $sut->getAmount());
+        self::assertNull($sut->getBegin());
+        self::assertNull($sut->getActivity());
+        self::assertNull($sut->getUser());
+        self::assertNull($sut->getDescription());
+        self::assertEquals(0, $sut->getDuration());
+    }
+}

tests/Invoice/InvoiceModelTest.php

@@ -0,0 +1,73 @@
+<?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\Entity\Customer;
+use App\Entity\InvoiceTemplate;
+use App\Entity\Timesheet;
+use App\Invoice\Calculator\DefaultCalculator;
+use App\Invoice\InvoiceModel;
+use App\Invoice\NumberGenerator\DateNumberGenerator;
+use App\Repository\Query\InvoiceQuery;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Invoice\InvoiceModel
+ */
+class InvoiceModelTest extends TestCase
+{
+    public function testEmptyObject()
+    {
+        $sut = new InvoiceModel();
+
+        self::assertNull($sut->getQuery());
+        self::assertNull($sut->getCustomer());
+        self::assertNull($sut->getDueDate());
+        self::assertNull($sut->getCalculator());
+        self::assertNull($sut->getNumberGenerator());
+
+        self::assertEmpty($sut->getEntries());
+        self::assertIsArray($sut->getEntries());
+
+        self::assertNull($sut->getTemplate());
+        self::assertInstanceOf(\DateTime::class, $sut->getInvoiceDate());
+    }
+
+    public function testSetter()
+    {
+        $sut = new InvoiceModel();
+
+        $query = new InvoiceQuery();
+        self::assertInstanceOf(InvoiceModel::class, $sut->setQuery($query));
+        self::assertSame($query, $sut->getQuery());
+
+        $customer = new Customer();
+        self::assertInstanceOf(InvoiceModel::class, $sut->setCustomer($customer));
+        self::assertSame($customer, $sut->getCustomer());
+
+        $calculator = new DefaultCalculator();
+        self::assertInstanceOf(InvoiceModel::class, $sut->setCalculator($calculator));
+        self::assertSame($calculator, $sut->getCalculator());
+
+        $entries = [new Timesheet()];
+        self::assertInstanceOf(InvoiceModel::class, $sut->setEntries($entries));
+        self::assertSame($entries, $sut->getEntries());
+
+        $generator = new DateNumberGenerator();
+        self::assertInstanceOf(InvoiceModel::class, $sut->setNumberGenerator($generator));
+        self::assertSame($generator, $sut->getNumberGenerator());
+
+        $template = new InvoiceTemplate();
+        self::assertNull($sut->getDueDate());
+        self::assertInstanceOf(InvoiceModel::class, $sut->setTemplate($template));
+        self::assertSame($template, $sut->getTemplate());
+        self::assertInstanceOf(\DateTime::class, $sut->getDueDate());
+    }
+}

tests/Invoice/NumberGenerator/DateNumberGeneratorTest.php

@@ -9,8 +9,8 @@
 
 namespace App\Tests\Invoice\NumberGenerator;
 
+use App\Invoice\InvoiceModel;
 use App\Invoice\NumberGenerator\DateNumberGenerator;
-use App\Model\InvoiceModel;
 use PHPUnit\Framework\TestCase;
 
 /**

tests/Invoice/Renderer/CsvRendererTest.php

@@ -9,8 +9,8 @@
 
 namespace App\Tests\Invoice\Renderer;
 
+use App\Invoice\InvoiceModel;
 use App\Invoice\Renderer\CsvRenderer;
-use App\Model\InvoiceModel;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 

tests/Invoice/Renderer/DebugRenderer.php

@@ -10,9 +10,9 @@
 namespace App\Tests\Invoice\Renderer;
 
 use App\Entity\InvoiceDocument;
+use App\Invoice\InvoiceModel;
 use App\Invoice\Renderer\RendererTrait;
 use App\Invoice\RendererInterface;
-use App\Model\InvoiceModel;
 use Symfony\Component\HttpFoundation\Response;
 
 class DebugRenderer implements RendererInterface

tests/Invoice/Renderer/DebugRendererTest.php

@@ -10,7 +10,7 @@
 namespace App\Tests\Invoice\Renderer;
 
 use App\Entity\InvoiceDocument;
-use App\Model\InvoiceModel;
+use App\Invoice\InvoiceModel;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Response;
 

tests/Invoice/Renderer/OdsRendererTest.php

@@ -9,8 +9,8 @@
 
 namespace App\Tests\Invoice\Renderer;
 
+use App\Invoice\InvoiceModel;
 use App\Invoice\Renderer\OdsRenderer;
-use App\Model\InvoiceModel;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 

tests/Invoice/Renderer/RendererTestTrait.php

@@ -22,9 +22,9 @@ use App\Entity\Timesheet;
 use App\Entity\TimesheetMeta;
 use App\Entity\User;
 use App\Invoice\Calculator\DefaultCalculator;
+use App\Invoice\InvoiceModel;
 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;
@@ -82,10 +82,7 @@ trait RendererTestTrait
         return new $classname($translator, $dateExtension, $extensions);
     }
 
-    /**
-     * @return InvoiceModel
-     */
-    protected function getInvoiceModel()
+    protected function getInvoiceModel(): InvoiceModel
     {
         $customer = new Customer();
         $customer->setCurrency('EUR');

tests/Invoice/Renderer/TwigRendererTest.php

@@ -65,6 +65,6 @@ class TwigRendererTest extends KernelTestCase
         $this->assertContains('<h2 class="page-header">
            <span contenteditable="true">a test invoice template title</span>
         </h2>', $content);
-        $this->assertEquals(5, substr_count($content, 'activity description / project name'));
+        $this->assertEquals(5, substr_count($content, 'activity description'));
     }
 }

tests/Invoice/Renderer/XlsxRendererTest.php

@@ -9,8 +9,8 @@
 
 namespace App\Tests\Invoice\Renderer;
 
+use App\Invoice\InvoiceModel;
 use App\Invoice\Renderer\XlsxRenderer;
-use App\Model\InvoiceModel;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;