kimai2/tests/Invoice/InvoiceModelTest.php

<?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\Invoice\Calculator\DefaultCalculator;
use App\Invoice\InvoiceModel;
use App\Invoice\InvoicePeriod;
use App\Repository\Query\InvoiceQuery;
use App\Tests\Invoice\NumberGenerator\IncrementingNumberGenerator;
use App\Tests\Invoice\Renderer\RendererTestTrait;
use App\Tests\Mocks\InvoiceModelFactoryFactory;
use App\Timesheet\RateCalculator\DecimalRateCalculator;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\TestCase;

#[CoversClass(InvoiceModel::class)]
#[CoversClass(InvoicePeriod::class)]
class InvoiceModelTest extends TestCase
{
    use RendererTestTrait;

    public function testEmptyObject(): void
    {
        $formatter = new DebugFormatter();
        $sut = (new InvoiceModelFactoryFactory($this))->create()->createModel($formatter, new Customer('foo'), new InvoiceTemplate(), new InvoiceQuery());

        self::assertNotNull($sut->getQuery());

        self::assertFalse($sut->isPreview());
        self::assertFalse($sut->isHideZeroTax());
        self::assertNull($sut->getCalculator());
        self::assertEmpty($sut->getEntries());
        self::assertIsArray($sut->getEntries());
        self::assertInstanceOf(\DateTimeInterface::class, $sut->getInvoiceDate());

        self::assertSame($formatter, $sut->getFormatter());

        $newFormatter = new DebugFormatter();
        $sut->setFormatter($newFormatter);
        self::assertNotSame($formatter, $sut->getFormatter());
        self::assertSame($newFormatter, $sut->getFormatter());
        self::assertEquals([], $sut->getOptions());

        $sut->setPreview(true);
        $sut->setHideZeroTax(true);
        self::assertTrue($sut->isPreview());
        self::assertTrue($sut->isHideZeroTax());
    }

    public function testEmptyObjectThrowsExceptionOnNumberGenerator(): void
    {
        $formatter = new DebugFormatter();
        $sut = (new InvoiceModelFactoryFactory($this))->create()->createModel($formatter, new Customer('foo'), new InvoiceTemplate(), new InvoiceQuery());

        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('InvoiceModel::getInvoiceNumber() cannot be called before calling setNumberGenerator()');
        $sut->getInvoiceNumber();
    }

    public function testSetter(): void
    {
        $customer = new Customer('foo');
        $query = new InvoiceQuery();
        $template = new InvoiceTemplate();
        $sut = (new InvoiceModelFactoryFactory($this))->create()->createModel(new DebugFormatter(), $customer, $template, $query);

        self::assertSame($query, $sut->getQuery());

        $calculator = new DefaultCalculator();
        self::assertInstanceOf(InvoiceModel::class, $sut->setCalculator($calculator));
        self::assertSame($calculator, $sut->getCalculator());

        $generator = new IncrementingNumberGenerator();
        self::assertInstanceOf(InvoiceModel::class, $sut->setNumberGenerator($generator));
        $number = $sut->getInvoiceNumber();
        self::assertEquals($number, $sut->getInvoiceNumber());

        self::assertSame($template, $sut->getTemplate());
        self::assertInstanceOf(\DateTimeInterface::class, $sut->getDueDate());

        $sut->setOption('foo-int', 123);
        $sut->setOption('foo-float', 123.45);
        $sut->setOption('foo-string', '12345');
        $sut->setOption('foo-null', null);
        $sut->setOption('foo-bool', true);
        $sut->setOption('foo-array', ['foo' => 'bar']);
        $sut->setOption('foo-array2', ['foo', 'bar']);
        self::assertEquals([
            'foo-int' => 123,
            'foo-float' => 123.45,
            'foo-string' => '12345',
            'foo-null' => null,
            'foo-bool' => true,
            'foo-array' => ['foo' => 'bar'],
            'foo-array2' => ['foo', 'bar']
        ], $sut->getOptions());
    }

    public function testDueDate(): void
    {
        $customer = new Customer('foo');
        $query = new InvoiceQuery();
        $template = new InvoiceTemplate();
        $sut = (new InvoiceModelFactoryFactory($this))->create()->createModel(new DebugFormatter(), $customer, $template, $query);

        $dueDate = $sut->getDueDate();
        $dueDays = $template->getDueDays();
        self::assertNotNull($dueDays);
        $expected = new \DateTimeImmutable('+' . $dueDays . ' days');

        self::assertEquals($expected->format('Y-m-d'), $dueDate->format('Y-m-d'));

        $sut->setInvoiceDate(new \DateTimeImmutable('2022-05-23'));
        $template->setDueDays(14);
        $dueDate = $sut->getDueDate();
        $expected = new \DateTimeImmutable('2022-06-06');
        self::assertEquals($expected->format('Y-m-d'), $dueDate->format('Y-m-d'));
    }

    public function testGetInvoicePeriod(): void
    {
        $sut = $this->getInvoiceModel();

        $period = $sut->getInvoicePeriod();

        self::assertSame('2020-08-12 18:00:00', $period->getStart()->format('Y-m-d H:i:s'));
        self::assertSame('2021-03-12 12:17:40', $period->getEnd()->format('Y-m-d H:i:s'));
    }

    public function testGetInvoicePeriodFallsBackToQueryDates(): void
    {
        $query = new InvoiceQuery();
        $query->setBegin(new \DateTime('2022-01-02 03:04:05'));
        $query->setEnd(new \DateTime('2022-06-07 08:09:10'));

        $sut = (new InvoiceModelFactoryFactory($this))->create()->createModel(
            new DebugFormatter(),
            new Customer('foo'),
            new InvoiceTemplate(),
            $query
        );

        $period = $sut->getInvoicePeriod();

        self::assertSame('2022-01-02 00:00:00', $period->getStart()->format('Y-m-d H:i:s'));
        self::assertSame('2022-06-07 23:59:59', $period->getEnd()->format('Y-m-d H:i:s'));
    }

    public function testGetInvoicePeriodFallsBackToInvoiceDateWithoutQuery(): void
    {
        $invoiceDate = new \DateTimeImmutable('2023-09-10 11:12:13');
        $sut = new InvoiceModel(
            new DebugFormatter(),
            new Customer('foo'),
            new InvoiceTemplate(),
            new DecimalRateCalculator()
        );
        $sut->setInvoiceDate($invoiceDate);

        $period = $sut->getInvoicePeriod();

        self::assertSame('2023-09-10 11:12:13', $period->getStart()->format('Y-m-d H:i:s'));
        self::assertSame('2023-09-10 11:12:13', $period->getEnd()->format('Y-m-d H:i:s'));
    }
}