mirror of
https://github.com/wiosna-dev/common-library.git
synced 2026-03-12 09:31:51 +01:00
Collection/storage of templates
This commit is contained in:
Meritoo
188
tests/Collection/TemplatesTest.php
Normal file
188
tests/Collection/TemplatesTest.php
Normal file
@@ -0,0 +1,188 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* (c) Meritoo.pl, http://www.meritoo.pl
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Meritoo\Test\Common\Collection;
|
||||
|
||||
use Generator;
|
||||
use Meritoo\Common\Collection\Templates;
|
||||
use Meritoo\Common\Exception\ValueObject\Template\TemplateNotFoundException;
|
||||
use Meritoo\Common\Test\Base\BaseTestCase;
|
||||
use Meritoo\Common\Type\OopVisibilityType;
|
||||
use Meritoo\Common\ValueObject\Template;
|
||||
|
||||
/**
|
||||
* Test case for the collection/storage of templates
|
||||
*
|
||||
* @author Meritoo <github@meritoo.pl>
|
||||
* @copyright Meritoo <http://www.meritoo.pl>
|
||||
*
|
||||
* @internal
|
||||
* @covers \Meritoo\Common\Collection\Templates
|
||||
*/
|
||||
class TemplatesTest extends BaseTestCase
|
||||
{
|
||||
public function testConstructor(): void
|
||||
{
|
||||
static::assertConstructorVisibilityAndArguments(
|
||||
Templates::class,
|
||||
OopVisibilityType::IS_PUBLIC,
|
||||
1
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $description Description of test
|
||||
* @param array $templates Pairs of key-value where: key - template's index, value - template's content
|
||||
* @param Templates $expected Expected collection/storage of templates
|
||||
*
|
||||
* @dataProvider provideArrayWithTemplates
|
||||
*/
|
||||
public function testFromArray(string $description, array $templates, Templates $expected): void
|
||||
{
|
||||
static::assertEquals($expected, Templates::fromArray($templates), $description);
|
||||
}
|
||||
|
||||
public function testFindTemplateUsingEmptyCollection(): void
|
||||
{
|
||||
$template = 'Template with \'%s\' index was not found. Did you provide all required templates?';
|
||||
$message = sprintf($template, 'test');
|
||||
|
||||
$this->expectException(TemplateNotFoundException::class);
|
||||
$this->expectExceptionMessage($message);
|
||||
|
||||
$templates = new Templates();
|
||||
$templates->findTemplate('test');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Templates $templates All templates
|
||||
* @param string $index Index that contains required template
|
||||
* @param string $expectedMessage Expected message of exception
|
||||
*
|
||||
* @dataProvider provideTemplatesWithNotExistingIndex
|
||||
*/
|
||||
public function testFindTemplateUsingNotExistingIndex(
|
||||
Templates $templates,
|
||||
string $index,
|
||||
string $expectedMessage
|
||||
): void {
|
||||
$this->expectException(TemplateNotFoundException::class);
|
||||
$this->expectExceptionMessage($expectedMessage);
|
||||
|
||||
$templates->findTemplate($index);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $description Description of test
|
||||
* @param Templates $templates All templates
|
||||
* @param string $index Index that contains required template
|
||||
* @param Template $expected Expected template
|
||||
*
|
||||
* @dataProvider provideTemplatesToFind
|
||||
*/
|
||||
public function testFindTemplate(string $description, Templates $templates, string $index, Template $expected): void
|
||||
{
|
||||
static::assertEquals($expected, $templates->findTemplate($index), $description);
|
||||
}
|
||||
|
||||
public function provideArrayWithTemplates(): ?Generator
|
||||
{
|
||||
yield[
|
||||
'An empty array',
|
||||
[],
|
||||
new Templates(),
|
||||
];
|
||||
|
||||
yield[
|
||||
'Number-based indexes',
|
||||
[
|
||||
'First name: %first_name%',
|
||||
'Last name: %last_name%',
|
||||
],
|
||||
new Templates([
|
||||
new Template('First name: %first_name%'),
|
||||
new Template('Last name: %last_name%'),
|
||||
]),
|
||||
];
|
||||
|
||||
yield[
|
||||
'String-based indexes',
|
||||
[
|
||||
'first' => 'First name: %first_name%',
|
||||
'last' => 'Last name: %last_name%',
|
||||
],
|
||||
new Templates([
|
||||
'first' => new Template('First name: %first_name%'),
|
||||
'last' => new Template('Last name: %last_name%'),
|
||||
]),
|
||||
];
|
||||
}
|
||||
|
||||
public function provideTemplatesWithNotExistingIndex(): ?Generator
|
||||
{
|
||||
$template = 'Template with \'%s\' index was not found. Did you provide all required templates?';
|
||||
|
||||
yield[
|
||||
new Templates(),
|
||||
'test',
|
||||
sprintf($template, 'test'),
|
||||
];
|
||||
|
||||
yield[
|
||||
new Templates([
|
||||
'first' => new Template('First name: %first_name%'),
|
||||
'last' => new Template('Last name: %last_name%'),
|
||||
]),
|
||||
'test',
|
||||
sprintf($template, 'test'),
|
||||
];
|
||||
|
||||
yield[
|
||||
new Templates([
|
||||
'first' => new Template('First name: %first_name%'),
|
||||
'last' => new Template('Last name: %last_name%'),
|
||||
]),
|
||||
'',
|
||||
sprintf($template, ''),
|
||||
];
|
||||
|
||||
yield[
|
||||
new Templates([
|
||||
'first' => new Template('First name: %first_name%'),
|
||||
'last' => new Template('Last name: %last_name%'),
|
||||
]),
|
||||
'4',
|
||||
sprintf($template, 4),
|
||||
];
|
||||
}
|
||||
|
||||
public function provideTemplatesToFind(): ?Generator
|
||||
{
|
||||
yield[
|
||||
'2 templates only',
|
||||
new Templates([
|
||||
'first' => new Template('First name: %first_name%'),
|
||||
'last' => new Template('Last name: %last_name%'),
|
||||
]),
|
||||
'first',
|
||||
new Template('First name: %first_name%'),
|
||||
];
|
||||
|
||||
yield[
|
||||
'Different indexes',
|
||||
new Templates([
|
||||
'first' => new Template('First name: %first_name%'),
|
||||
'last' => new Template('Last name: %last_name%'),
|
||||
1 => new Template('Hi %name%, how are you?'),
|
||||
'2' => new Template('Your score is: %score%'),
|
||||
]),
|
||||
'1',
|
||||
new Template('Hi %name%, how are you?'),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,71 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* (c) Meritoo.pl, http://www.meritoo.pl
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Meritoo\Test\Common\Exception\ValueObject\Template;
|
||||
|
||||
use Generator;
|
||||
use Meritoo\Common\Exception\ValueObject\Template\TemplateNotFoundException;
|
||||
use Meritoo\Common\Test\Base\BaseTestCase;
|
||||
use Meritoo\Common\Type\OopVisibilityType;
|
||||
|
||||
/**
|
||||
* Test case of an exception used while template with given index was not found
|
||||
*
|
||||
* @author Meritoo <github@meritoo.pl>
|
||||
* @copyright Meritoo <http://www.meritoo.pl>
|
||||
*
|
||||
* @internal
|
||||
* @covers \Meritoo\Common\Exception\ValueObject\Template\TemplateNotFoundException
|
||||
*/
|
||||
class TemplateNotFoundExceptionTest extends BaseTestCase
|
||||
{
|
||||
public function testConstructor(): void
|
||||
{
|
||||
static::assertConstructorVisibilityAndArguments(
|
||||
TemplateNotFoundException::class,
|
||||
OopVisibilityType::IS_PUBLIC,
|
||||
3
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $description Description of test
|
||||
* @param string $index Index that should contain template, but it was not found
|
||||
* @param TemplateNotFoundException $expected Expected exception
|
||||
*
|
||||
* @dataProvider provideIndexAndException
|
||||
*/
|
||||
public function testCreate(string $description, string $index, TemplateNotFoundException $expected): void
|
||||
{
|
||||
$created = TemplateNotFoundException::create($index);
|
||||
static::assertEquals($expected, $created, $description);
|
||||
}
|
||||
|
||||
public function provideIndexAndException(): ?Generator
|
||||
{
|
||||
$template = 'Template with \'%s\' index was not found. Did you provide all required templates?';
|
||||
|
||||
yield[
|
||||
'An empty string',
|
||||
'',
|
||||
new TemplateNotFoundException(sprintf($template, '')),
|
||||
];
|
||||
|
||||
yield[
|
||||
'Non-empty string',
|
||||
'test',
|
||||
new TemplateNotFoundException(sprintf($template, 'test')),
|
||||
];
|
||||
|
||||
yield[
|
||||
'Integer',
|
||||
'2',
|
||||
new TemplateNotFoundException(sprintf($template, 2)),
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user