Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle TypeError when dim1 is omitted on VAT lines #199

Merged
merged 2 commits into from
Apr 26, 2022
Merged

Handle TypeError when dim1 is omitted on VAT lines #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab68fc8
Handle case where dim1 is empty on vat line
rojtjo Aug 25, 2021
09567f7
Adding test ensure no TypeError is thrown when omitting dim1 on vat line
rojtjo Aug 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/DomDocuments/TransactionsDocument.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,11 @@ public function addTransaction(BaseTransaction $transaction)
$lineElement->setAttribute('id', $transactionLine->getId());
$linesElement->appendChild($lineElement);

$dim1Element = $this->createNodeWithTextContent('dim1', $transactionLine->getDim1());
$lineElement->appendChild($dim1Element);
$dim1 = $transactionLine->getDim1();
if (!empty($dim1)) {
$dim1Element = $this->createNodeWithTextContent('dim1', $dim1);
$lineElement->appendChild($dim1Element);
}

$dim2 = $transactionLine->getDim2();
if (!empty($dim2)) {
Expand Down
231 changes: 231 additions & 0 deletions tests/UnitTests/DomDocuments/TransactionsDocumentUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
<?php

declare(strict_types=1);

namespace PhpTwinfield\UnitTests;

use DateTimeImmutable;
use Money\Currency;
use Money\Money;
use PhpTwinfield\BaseTransaction;
use PhpTwinfield\CashTransaction;
use PhpTwinfield\CashTransactionLine;
use PhpTwinfield\DomDocuments\TransactionsDocument;
use PhpTwinfield\Enums\Destiny;
use PhpTwinfield\Enums\LineType;
use PhpTwinfield\JournalTransaction;
use PhpTwinfield\JournalTransactionLine;
use PhpTwinfield\Office;
use PhpTwinfield\PurchaseTransaction;
use PhpTwinfield\PurchaseTransactionLine;
use PhpTwinfield\SalesTransaction;
use PhpTwinfield\SalesTransactionLine;
use PHPUnit\Framework\TestCase;
use TypeError;

final class TransactionsDocumentUnitTest extends TestCase
{
/**
* @test
* @dataProvider transactionsProvider
*/
public function vat_transaction_line_dim1_can_be_empty(BaseTransaction $transaction): void
{
$caughtException = null;
$document = new TransactionsDocument();

try {
$document->addTransaction($transaction);
} catch (TypeError $e) {
$caughtException = $e;
}

$this->assertNull($caughtException);
}

public function transactionsProvider(): array
{
return [
'cash transaction' => [$this->fakeCashTransactionWithoutDim1OnVatLine()],
'journal transaction' => [$this->fakeJournalTransactionWithoutDim1OnVatLine()],
'purchase transaction' => [$this->fakeSalesTransactionWithoutDim1OnVatLine()],
'sales transaction' => [$this->fakeSalesTransactionWithoutDim1OnVatLine()],
];
}

private function fakeCashTransactionWithoutDim1OnVatLine(): CashTransaction
{
$cashTransaction = new CashTransaction();
$cashTransaction
->setOffice(Office::fromCode('001'))
->setDestiny(Destiny::TEMPORARY())
->setRaiseWarning(false)
->setCode('CASH')
->setCurrency(new Currency('EUR'))
->setDate(new DateTimeImmutable('2013-11-04'))
->setStatementnumber(4)
->setStartvalue(Money::EUR(97401));

$totalLine = new CashTransactionLine();
$totalLine
->setLineType(LineType::TOTAL())
->setId(1)
->setDim1('1002')
->setValue(Money::EUR(12100));

$detailLine = new CashTransactionLine();
$detailLine
->setLineType(LineType::DETAIL())
->setId(2)
->setDim1('1300')
->setDim2('1000')
->setValue(Money::EUR(10000))
->setVatCode('VH')
->setInvoiceNumber('11001770')
->setDescription('Invoice paid');

$vatLine = new CashTransactionLine();
$vatLine
->setLineType(LineType::VAT())
->setId(3)
->setValue(Money::EUR(2100))
->setVatCode('VH');

$cashTransaction
->addLine($totalLine)
->addLine($detailLine)
->addLine($vatLine);

return $cashTransaction;
}

private function fakeJournalTransactionWithoutDim1OnVatLine(): JournalTransaction
{
$journalTransaction = new JournalTransaction();
$journalTransaction
->setDestiny(Destiny::TEMPORARY())
->setCode('MEMO')
->setCurrency(new Currency('EUR'))
->setDate(new \DateTimeImmutable('2013-11-04'))
->setOffice(Office::fromCode('001'));

$detailLine = new JournalTransactionLine();
$detailLine
->setLineType(LineType::DETAIL())
->setId(2)
->setDim1('1300')
->setDim2('1000')
->setValue(Money::EUR(10000))
->setVatCode('VH')
->setInvoiceNumber('11001770')
->setDescription('Invoice paid');

$vatLine = new JournalTransactionLine();
$vatLine
->setLineType(LineType::VAT())
->setId(3)
->setValue(Money::EUR(2100))
->setVatCode('VH');

$journalTransaction
->addLine($detailLine)
->addLine($vatLine);

return $journalTransaction;
}

private function fakePurchaseTransactionWithoutDim1OnVatLine(): PurchaseTransaction
{
$purchaseTransaction = new PurchaseTransaction();
$purchaseTransaction
->setDestiny(Destiny::TEMPORARY())
->setRaiseWarning(false)
->setCode('INK')
->setCurrency(new Currency('EUR'))
->setDate(new DateTimeImmutable('2013-05-02'))
->setPeriod('2013/05')
->setInvoiceNumber('20130-5481')
->setPaymentReference('+++100/0160/01495+++')
->setOffice(Office::fromCode('001'))
->setDueDate(new DateTimeImmutable('2013-05-06'));

$totalLine = new PurchaseTransactionLine();
$totalLine
->setLineType(LineType::TOTAL())
->setId(1)
->setDim1('1600')
->setDim2('2000')
->setValue(Money::EUR(12100))
->setDescription('');

$detailLine = new PurchaseTransactionLine();
$detailLine
->setLineType(LineType::DETAIL())
->setId(2)
->setDim1('8020')
->setValue(Money::EUR(10000))
->setDescription('Outfit')
->setVatCode('IH');

$vatLine = new PurchaseTransactionLine();
$vatLine
->setLineType(LineType::VAT())
->setId(3)
->setValue(Money::EUR(2100))
->setVatCode('VH');

$purchaseTransaction
->addLine($totalLine)
->addLine($detailLine)
->addLine($vatLine);

return $purchaseTransaction;
}

private function fakeSalesTransactionWithoutDim1OnVatLine(): SalesTransaction
{
$salesTransaction = new SalesTransaction();
$salesTransaction
->setDestiny(Destiny::TEMPORARY())
->setRaiseWarning(false)
->setCode('SLS')
->setCurrency(new Currency('EUR'))
->setDate(new DateTimeImmutable('2013-05-02'))
->setPeriod('2013/05')
->setInvoiceNumber('20130-6000')
->setPaymentReference('+++100/0160/01495+++')
->setOffice(Office::fromCode('001'));

$totalLine = new SalesTransactionLine();
$totalLine
->setLineType(LineType::TOTAL())
->setId(1)
->setDim1('1300')
->setDim2('1000')
->setValue(Money::EUR(12100))
->setDescription('');

$detailLine = new SalesTransactionLine();
$detailLine
->setLineType(LineType::DETAIL())
->setId(2)
->setDim1('8020')
->setValue(Money::EUR(10000))
->setDescription('Outfit')
->setVatCode('VH');

$vatLine = new SalesTransactionLine();
$vatLine
->setLineType(LineType::VAT())
->setId(3)
->setValue(Money::EUR(2100))
->setVatCode('VH');

$salesTransaction
->addLine($totalLine)
->addLine($detailLine)
->addLine($vatLine);

return $salesTransaction;
}
}