respect-validation/tests/unit/Rules/SubdivisionCodeTest.php
Henrique Moody 9c9c76ebfb
Use "sokil/php-isocodes" on SubdivisionCode
Inside the "data/" directory, we have files with lists of subdivisions
that need to be updated. We have to update them manually, or we automate
that task with a script and GitHub actions.

The two options are very time consuming and also not ideal. We don't
want to deal with that problem and, thinking that the user of this
library may want to show the data that we validate, we should create a
whole library to make it more usable.

The "sokil/php-isocodes" is a simple library that, even supports
translations. It's frequently updated and has gone to major performance
updates.

I am not fond of the idea of requiring an external library to install
Validation, as I have seen that gone wrong before [1]. Ideally, that
would be an optional dependency for people who would like to use those
rules, but to make that happen, we need to release a MAJOR version.

[1]: d072b4de6a

Signed-off-by: Henrique Moody <henriquemoody@gmail.com>
2021-02-06 15:09:04 +01:00

115 lines
2.9 KiB
PHP

<?php
/*
* This file is part of Respect/Validation.
*
* (c) Alexandre Gomes Gaigalas <alexandre@gaigalas.net>
*
* For the full copyright and license information, please view the LICENSE file
* that was distributed with this source code.
*/
declare(strict_types=1);
namespace Respect\Validation\Rules;
use Respect\Validation\Exceptions\ComponentException;
use Respect\Validation\Exceptions\SubdivisionCodeException;
use Respect\Validation\Test\TestCase;
/**
* @covers \Respect\Validation\Exceptions\SubdivisionCodeException
* @covers \Respect\Validation\Rules\SubdivisionCode
*
* @author Gabriel Caruso <carusogabriel34@gmail.com>
* @author Henrique Moody <henriquemoody@gmail.com>
*/
final class SubdivisionCodeTest extends TestCase
{
/**
* @test
*/
public function shouldThrowsExceptionWhenInvalidFormat(): void
{
$this->expectException(ComponentException::class);
$this->expectExceptionMessage('"whatever" is not a supported country code');
new SubdivisionCode('whatever');
}
/**
* @test
*/
public function shouldNotAcceptWrongNamesOnConstructor(): void
{
$this->expectException(ComponentException::class);
$this->expectExceptionMessage('"JK" is not a supported country code');
new SubdivisionCode('JK');
}
/**
* @return mixed[][]
*/
public function providerForValidSubdivisionCodeInformation(): array
{
return [
['BR', 'SP'],
['MV', '00'],
['US', 'CA'],
];
}
/**
* @dataProvider providerForValidSubdivisionCodeInformation
*
* @test
*/
public function shouldValidateValidSubdivisionCodeInformation(string $countryCode, ?string $input): void
{
$countrySubdivision = new SubdivisionCode($countryCode);
self::assertTrue($countrySubdivision->validate($input));
}
/**
* @return mixed[][]
*/
public function providerForInvalidSubdivisionCodeInformation(): array
{
return [
['BR', 'CA'],
['MV', 0],
['US', 'CE'],
['AQ', null],
['YT', ''],
];
}
/**
* @dataProvider providerForInvalidSubdivisionCodeInformation
*
* @test
*
* @param mixed $input
*/
public function shouldNotValidateInvalidSubdivisionCodeInformation(string $countryCode, $input): void
{
$countrySubdivision = new SubdivisionCode($countryCode);
self::assertFalse($countrySubdivision->validate($input));
}
/**
* @test
*/
public function shouldThrowsSubdivisionCodeException(): void
{
$countrySubdivision = new SubdivisionCode('BR');
$this->expectException(SubdivisionCodeException::class);
$this->expectExceptionMessage('"CA" must be a subdivision code of "Brazil"');
$countrySubdivision->assert('CA');
}
}