Класс `Supplier`, покрытый тестами

Это было слишком легко :(
pull/10/head
Anthony Axenov 2021-11-24 17:57:24 +08:00
parent c5b57ec26d
commit 3b75c8b983
2 changed files with 180 additions and 0 deletions

View File

@ -0,0 +1,85 @@
<?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\Entities;
use AtolOnline\Constants\Constraints;
use AtolOnline\Exceptions\InvalidPhoneException;
use Illuminate\Support\Collection;
/**
* Класс, описывающий поставшика
*
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 20-21
*/
class Supplier extends Entity
{
/**
* @var Collection Телефоны платёжного агента (1073)
*/
protected Collection $phones;
/**
* Конструктор
*
* @param array|Collection|null $phones Телефон оператора по приёму платежей (1074)
* @throws InvalidPhoneException
*/
public function __construct(
array|Collection|null $phones = null,
) {
$this->setPhones($phones);
}
/**
* Возвращает установленные номера телефонов
*
* @todo вытащить в трейт
* @return Collection
*/
public function getPhones(): Collection
{
return $this->phones;
}
/**
* Устанавливает массив номеров телефонов
*
* @todo вытащить в трейт
* @param array|Collection|null $phones
* @return $this
* @throws InvalidPhoneException
*/
public function setPhones(array|Collection|null $phones): self
{
if (!is_null($phones)) {
$phones = is_array($phones) ? collect($phones) : $phones;
$phones->each(function ($phone) {
$phone = preg_replace('/[^\d]/', '', trim($phone));
if (preg_match(Constraints::PATTERN_PHONE, $phone) != 1) {
throw new InvalidPhoneException($phone);
}
});
}
$this->phones = empty($phones) ? collect() : $phones;
return $this;
}
/**
* @inheritDoc
*/
public function jsonSerialize(): array
{
$json = [];
!$this->getPhones()->isEmpty() && $json['phones'] = $this->getPhones()->toArray();
return $json;
}
}

View File

@ -0,0 +1,95 @@
<?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\{
Entities\Supplier,
Exceptions\InvalidPhoneException,
Tests\BasicTestCase};
/**
* Набор тестов для проверки работы класса поставщика
*/
class SupplierTest extends BasicTestCase
{
/**
* Тестирует конструктор без передачи значений и корректное приведение к json
*
* @covers \AtolOnline\Entities\Supplier
* @covers \AtolOnline\Entities\Supplier::jsonSerialize
*/
public function testConstructorWithoutArgs(): void
{
$this->assertEquals('[]', (string)(new Supplier()));
}
/**
* Тестирует конструктор с передачей значений и корректное приведение к json
*
* @covers \AtolOnline\Entities\Supplier
* @covers \AtolOnline\Entities\Supplier::jsonSerialize
* @covers \AtolOnline\Entities\Supplier::setPhones
* @covers \AtolOnline\Entities\Supplier::getPhones
* @throws InvalidPhoneException
*/
public function testConstructorWithArgs(): void
{
$this->assertAtolable(new Supplier(['+122997365456']), ['phones' => ['+122997365456']]);
}
/**
* Провайдер массивов телефонов, которые приводятся к null
*
* @return array<array>
*/
public function providerNullablePhonesArrays(): array
{
return [
[[]],
[null],
[collect()],
];
}
/**
* Тестирует установку пустых телефонов
*
* @dataProvider providerNullablePhonesArrays
* @covers \AtolOnline\Entities\Supplier
* @covers \AtolOnline\Entities\Supplier::setPhones
* @covers \AtolOnline\Entities\Supplier::getPhones
* @throws InvalidPhoneException
*/
public function testNullablePhones(mixed $phones): void
{
$agent = new Supplier($phones);
$this->assertIsCollection($agent->getPhones());
$this->assertTrue($agent->getPhones()->isEmpty());
}
/**
* Тестирует установку невалидных телефонов
*
* @covers \AtolOnline\Entities\Supplier
* @covers \AtolOnline\Entities\Supplier::setPhones
* @covers \AtolOnline\Exceptions\InvalidPhoneException
* @throws InvalidPhoneException
*/
public function testInvalidPhoneException(): void
{
$this->expectException(InvalidPhoneException::class);
(new Supplier())->setPhones([
'12345678901234567', // good
'+123456789012345678', // good
'12345678901234567890', // bad
'+12345678901234567890', // bad
]);
}
}