mirror of
https://github.com/anthonyaxenov/atol-online.git
synced 2024-11-25 00:04:21 +00:00
Вторая итерация Receipt
- фикс nullable-свойств и геттеров - проверка на пустоту в `setPayments()`, `setItems()` и `setVats()` - часть тестов с покрытием (конструктор, агент, исключения при пустых коллекциях)
This commit is contained in:
parent
a34a6927d1
commit
b39e76f312
@ -15,7 +15,10 @@ use AtolOnline\Collections\Items;
|
||||
use AtolOnline\Collections\Payments;
|
||||
use AtolOnline\Collections\Vats;
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Exceptions\TooHighPriceException;
|
||||
use AtolOnline\Exceptions\EmptyItemsException;
|
||||
use AtolOnline\Exceptions\EmptyPaymentsException;
|
||||
use AtolOnline\Exceptions\EmptyVatsException;
|
||||
use AtolOnline\Exceptions\InvalidEntityInCollectionException;
|
||||
use AtolOnline\Exceptions\TooLongAddCheckPropException;
|
||||
use AtolOnline\Exceptions\TooLongCashierException;
|
||||
use Exception;
|
||||
@ -75,22 +78,26 @@ class Receipt extends Entity
|
||||
/**
|
||||
* @var string|null Дополнительный реквизит
|
||||
*/
|
||||
protected ?string $add_check_props;
|
||||
protected ?string $add_check_props = null;
|
||||
|
||||
/**
|
||||
* @var AdditionalUserProps|null Дополнительный реквизит пользователя
|
||||
*/
|
||||
protected ?AdditionalUserProps $add_user_props;
|
||||
protected ?AdditionalUserProps $add_user_props = null;
|
||||
|
||||
/**
|
||||
* Конструктор
|
||||
*
|
||||
* @param Client $client
|
||||
* @param Company $company
|
||||
* @param Items $items
|
||||
* @param Payments $payments
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function __construct(
|
||||
Client $client,
|
||||
Company $company,
|
||||
Items $items,
|
||||
Payments $payments,
|
||||
) {
|
||||
public function __construct(Client $client, Company $company, Items $items, Payments $payments)
|
||||
{
|
||||
$this->setClient($client)->setCompany($company)->setItems($items)->setPayments($payments);
|
||||
}
|
||||
|
||||
@ -141,7 +148,7 @@ class Receipt extends Entity
|
||||
/**
|
||||
* Возвращает установленного агента
|
||||
*
|
||||
* @return AgentInfo
|
||||
* @return AgentInfo|null
|
||||
*/
|
||||
public function getAgentInfo(): ?AgentInfo
|
||||
{
|
||||
@ -198,9 +205,15 @@ class Receipt extends Entity
|
||||
* @todo исключение при пустой коллекции
|
||||
* @param Items $items
|
||||
* @return Receipt
|
||||
* @throws EmptyItemsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function setItems(Items $items): self
|
||||
{
|
||||
if ($items->isEmpty()) {
|
||||
throw new EmptyItemsException();
|
||||
}
|
||||
$items->checkItemsClasses();
|
||||
$this->items = $items;
|
||||
return $this;
|
||||
}
|
||||
@ -218,12 +231,15 @@ class Receipt extends Entity
|
||||
/**
|
||||
* Устанаваливает коллекцию оплат
|
||||
*
|
||||
* @todo исключение при пустой коллекции
|
||||
* @param Payments $payments
|
||||
* @return Receipt
|
||||
* @throws EmptyPaymentsException
|
||||
*/
|
||||
public function setPayments(Payments $payments): self
|
||||
{
|
||||
if ($payments->isEmpty()) {
|
||||
throw new EmptyPaymentsException();
|
||||
}
|
||||
$this->payments = $payments;
|
||||
return $this;
|
||||
}
|
||||
@ -243,9 +259,13 @@ class Receipt extends Entity
|
||||
*
|
||||
* @param Vats|null $vats
|
||||
* @return Receipt
|
||||
* @throws EmptyVatsException
|
||||
*/
|
||||
public function setVats(?Vats $vats): self
|
||||
{
|
||||
if ($vats->isEmpty()) {
|
||||
throw new EmptyVatsException();
|
||||
}
|
||||
$this->vats = $vats;
|
||||
return $this;
|
||||
}
|
||||
@ -297,7 +317,7 @@ class Receipt extends Entity
|
||||
throw new TooLongCashierException($cashier);
|
||||
}
|
||||
}
|
||||
$this->cashier = empty($cashier) ? null : $cashier;
|
||||
$this->cashier = $cashier ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
@ -364,7 +384,7 @@ class Receipt extends Entity
|
||||
'company' => $this->getCompany(),
|
||||
'items' => $this->getItems(),
|
||||
'total' => $this->getTotal(),
|
||||
'payment' => $this->getPayments(),
|
||||
'payments' => $this->getPayments(),
|
||||
];
|
||||
$this->getAgentInfo()?->jsonSerialize() && $json['agent_info'] = $this->getAgentInfo();
|
||||
$this->getSupplier()?->jsonSerialize() && $json['vats'] = $this->getVats();
|
||||
|
22
src/Exceptions/EmptyItemsException.php
Normal file
22
src/Exceptions/EmptyItemsException.php
Normal file
@ -0,0 +1,22 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать документу пустую коллекцию предметов расчёта
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 21
|
||||
*/
|
||||
class EmptyItemsException extends AtolException
|
||||
{
|
||||
protected $message = 'Документ не может содержать пустую коллекцию предметов расчёта';
|
||||
}
|
22
src/Exceptions/EmptyPaymentsException.php
Normal file
22
src/Exceptions/EmptyPaymentsException.php
Normal file
@ -0,0 +1,22 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать документу пустую коллекцию оплат
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 30
|
||||
*/
|
||||
class EmptyPaymentsException extends AtolException
|
||||
{
|
||||
protected $message = 'Документ не может содержать пустую коллекцию оплат';
|
||||
}
|
22
src/Exceptions/EmptyVatsException.php
Normal file
22
src/Exceptions/EmptyVatsException.php
Normal file
@ -0,0 +1,22 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать документу пустую коллекцию ставок НДС
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 31
|
||||
*/
|
||||
class EmptyVatsException extends AtolException
|
||||
{
|
||||
protected $message = 'Документ не может содержать пустую коллекцию ставок НДС';
|
||||
}
|
259
tests/AtolOnline/Tests/Entities/ReceiptTest.php
Normal file
259
tests/AtolOnline/Tests/Entities/ReceiptTest.php
Normal file
@ -0,0 +1,259 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
namespace AtolOnline\Tests\Entities;
|
||||
|
||||
use AtolOnline\{
|
||||
Collections\Items,
|
||||
Collections\Payments,
|
||||
Entities\AgentInfo,
|
||||
Entities\Client,
|
||||
Entities\Company,
|
||||
Entities\Item,
|
||||
Entities\MoneyTransferOperator,
|
||||
Entities\PayingAgent,
|
||||
Entities\Receipt,
|
||||
Entities\ReceivePaymentsOperator,
|
||||
Enums\AgentTypes,
|
||||
Enums\SnoTypes,
|
||||
Tests\BasicTestCase};
|
||||
use AtolOnline\Exceptions\{
|
||||
EmptyItemNameException,
|
||||
EmptyItemsException,
|
||||
EmptyPaymentsException,
|
||||
InvalidEntityInCollectionException,
|
||||
InvalidEnumValueException,
|
||||
InvalidInnLengthException,
|
||||
InvalidPhoneException,
|
||||
NegativeItemPriceException,
|
||||
NegativeItemQuantityException,
|
||||
NegativePaymentSumException,
|
||||
TooHighItemPriceException,
|
||||
TooHighPaymentSumException,
|
||||
TooLongItemNameException,
|
||||
TooLongPayingAgentOperationException,
|
||||
TooManyException};
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Набор тестов для проверки работы класса чека прихода, расхода, возврата прихода, возврата расхода
|
||||
*/
|
||||
class ReceiptTest extends BasicTestCase
|
||||
{
|
||||
/**
|
||||
* Тестирует конструктор и корректное приведение к json
|
||||
*
|
||||
* @covers \AtolOnline\Entities\Receipt
|
||||
* @covers \AtolOnline\Entities\Receipt::setClient
|
||||
* @covers \AtolOnline\Entities\Receipt::setCompany
|
||||
* @covers \AtolOnline\Entities\Receipt::setItems
|
||||
* @covers \AtolOnline\Entities\Receipt::setPayments
|
||||
* @covers \AtolOnline\Entities\Receipt::getClient
|
||||
* @covers \AtolOnline\Entities\Receipt::getCompany
|
||||
* @covers \AtolOnline\Entities\Receipt::getItems
|
||||
* @covers \AtolOnline\Entities\Receipt::getPayments
|
||||
* @covers \AtolOnline\Entities\Receipt::getTotal
|
||||
* @covers \AtolOnline\Entities\Receipt::jsonSerialize
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function testConstructor(): void
|
||||
{
|
||||
$receipt = $this->validReceipt();
|
||||
$this->assertIsAtolable($receipt);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует установку данных агента
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::setAgentInfo
|
||||
* @covers \AtolOnline\Entities\Receipt::getAgentInfo
|
||||
* @covers \AtolOnline\Entities\Receipt::jsonSerialize
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPhoneException
|
||||
* @throws TooLongPayingAgentOperationException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function testSetAgentInfo(): void
|
||||
{
|
||||
$agent_info = new AgentInfo(
|
||||
AgentTypes::ANOTHER,
|
||||
new PayingAgent('test', ['+79518888888']),
|
||||
new ReceivePaymentsOperator(['+79519999999']),
|
||||
new MoneyTransferOperator('MTO Name', '9876543210', 'London', ['+79517777777']),
|
||||
);
|
||||
$receipt = $this->validReceipt()->setAgentInfo($agent_info);
|
||||
$this->assertArrayHasKey('agent_info', $receipt->jsonSerialize());
|
||||
$this->assertEquals($receipt->getAgentInfo(), $receipt->jsonSerialize()['agent_info']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при передаче пустой коллекции предметов расчёта
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt
|
||||
* @covers \AtolOnline\Entities\Receipt::setVats
|
||||
* @covers \AtolOnline\Collections\Items::checkCount
|
||||
* @covers \AtolOnline\Exceptions\EmptyItemsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws EmptyPaymentsException
|
||||
*/
|
||||
public function testEmptyItemsException(): void
|
||||
{
|
||||
$this->expectException(EmptyItemsException::class);
|
||||
new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items([]),
|
||||
new Payments($this->generatePaymentObjects())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при передаче коллекции предметов расчёта с некорректным содержимым
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt
|
||||
* @covers \AtolOnline\Entities\Receipt::setVats
|
||||
* @covers \AtolOnline\Collections\Items::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\Items::checkItemClass
|
||||
* @covers \AtolOnline\Exceptions\InvalidEntityInCollectionException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
*/
|
||||
public function testInvalidItemInCollectionException(): void
|
||||
{
|
||||
$this->expectException(InvalidEntityInCollectionException::class);
|
||||
$this->expectErrorMessage('Коллекция AtolOnline\Collections\Items должна содержать объекты AtolOnline\Entities\Item');
|
||||
new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items(['qwerty']),
|
||||
new Payments($this->generatePaymentObjects())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при передаче пустой коллекции оплат
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt
|
||||
* @covers \AtolOnline\Entities\Receipt::setPayments
|
||||
* @covers \AtolOnline\Collections\Payments::checkCount
|
||||
* @covers \AtolOnline\Exceptions\EmptyPaymentsException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws EmptyItemsException
|
||||
*/
|
||||
public function testEmptyPaymentsException(): void
|
||||
{
|
||||
$this->expectException(EmptyPaymentsException::class);
|
||||
new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items([new Item('test item', 2, 3)]),
|
||||
new Payments([])
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при передаче коллекции предметов расчёта с некорректным содержимым
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt
|
||||
* @covers \AtolOnline\Entities\Receipt::setVats
|
||||
* @covers \AtolOnline\Collections\Items::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\Items::checkItemClass
|
||||
* @covers \AtolOnline\Exceptions\InvalidEntityInCollectionException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
*/
|
||||
public function testInvalidPaymentInCollectionException(): void
|
||||
{
|
||||
$this->expectException(InvalidEntityInCollectionException::class);
|
||||
$this->expectErrorMessage('Коллекция AtolOnline\Collections\Payments должна содержать объекты AtolOnline\Entities\Payment');
|
||||
new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items([new Item('test item', 2, 3)]),
|
||||
new Payments(['qwerty'])
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает валидный тестовый объект чека
|
||||
*
|
||||
* @return Receipt
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
*/
|
||||
protected function validReceipt(): Receipt
|
||||
{
|
||||
return new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items($this->generateItemObjects()),
|
||||
new Payments($this->generatePaymentObjects())
|
||||
);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user