Skip to content

Add more tests #256

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.

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

Merged
merged 10 commits into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
83 changes: 83 additions & 0 deletions tests/Column/Base/GlobalContextTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Yii\DataView\Tests\Column\Base;

use PHPUnit\Framework\TestCase;
use Stringable;
use Yiisoft\Data\Reader\Iterable\IterableDataReader;
use Yiisoft\Yii\DataView\Column\Base\GlobalContext;
use Yiisoft\Yii\DataView\Tests\Support\Mock;
use Yiisoft\Yii\DataView\Tests\Support\TestTrait;

/**
* @covers \Yiisoft\Yii\DataView\Column\Base\GlobalContext
*/
final class GlobalContextTest extends TestCase
{
use TestTrait;

private array $data = [
['id' => 1, 'name' => 'John'],
['id' => 2, 'name' => 'Mary'],
];

public function testConstructor(): void
{
$dataReader = new IterableDataReader($this->data);
$translator = Mock::translator('en');
$pathArguments = ['id' => 123];
$queryParameters = ['sort' => 'name'];
$translationCategory = 'app';

$context = new GlobalContext(
$dataReader,
$pathArguments,
$queryParameters,
$translator,
$translationCategory
);

$this->assertSame($dataReader, $context->dataReader);
$this->assertSame($pathArguments, $context->pathArguments);
$this->assertSame($queryParameters, $context->queryParameters);
}

public function testTranslateWithString(): void
{
$translator = Mock::translator('en');

$context = new GlobalContext(
new IterableDataReader($this->data),
[],
[],
$translator,
'app'
);

$this->assertSame('test.message', $context->translate('test.message'));
}

public function testTranslateWithStringable(): void
{
$stringable = new class () implements Stringable {
public function __toString(): string
{
return 'test.stringable';
}
};

$translator = Mock::translator('en');

$context = new GlobalContext(
new IterableDataReader($this->data),
[],
[],
$translator,
'app'
);

$this->assertSame('test.stringable', $context->translate($stringable));
}
}
69 changes: 69 additions & 0 deletions tests/Column/Base/RendererContainerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Yii\DataView\Tests\Column\Base;

use PHPUnit\Framework\TestCase;
use Psr\Container\ContainerInterface;
use RuntimeException;
use Yiisoft\Yii\DataView\Column\Base\RendererContainer;
use Yiisoft\Yii\DataView\Tests\Support\TestRenderer;

/**
* @covers \Yiisoft\Yii\DataView\Column\Base\RendererContainer
*/
final class RendererContainerTest extends TestCase
{
private TestRenderer $renderer;
private RendererContainer $rendererContainer;

protected function setUp(): void
{
$this->renderer = new TestRenderer();
$container = $this->createMock(ContainerInterface::class);
$container
->method('get')
->willReturnCallback(fn(string $class) => match ($class) {
TestRenderer::class => $this->renderer,
default => throw new RuntimeException("Unexpected class: $class"),
});
$this->rendererContainer = new RendererContainer($container);
}

public function testGetCreatesNewInstance(): void
{
$instance = $this->rendererContainer->get(TestRenderer::class);
$this->assertInstanceOf(TestRenderer::class, $instance);
}

public function testGetReturnsCachedInstance(): void
{
$instance1 = $this->rendererContainer->get(TestRenderer::class);
$instance2 = $this->rendererContainer->get(TestRenderer::class);
$this->assertSame($instance1, $instance2);
}

public function testAddConfigsCreatesNewInstanceWithConfig(): void
{
$container = $this->rendererContainer->addConfigs([
TestRenderer::class => ['value' => 'custom'],
]);

/** @var TestRenderer $instance */
$instance = $container->get(TestRenderer::class);
$this->assertSame('custom', $instance->getValue());
}

public function testAddConfigsMergesExistingConfig(): void
{
$container = $this->rendererContainer
->addConfigs([TestRenderer::class => ['value' => 'first']])
->addConfigs([TestRenderer::class => ['option' => 'second']]);

/** @var TestRenderer $instance */
$instance = $container->get(TestRenderer::class);
$this->assertSame('first', $instance->getValue());
$this->assertSame('second', $instance->getOption());
}
}
224 changes: 224 additions & 0 deletions tests/Column/CheckboxColumnRendererTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Yii\DataView\Tests\Column;

use PHPUnit\Framework\TestCase;
use Yiisoft\Data\Reader\Iterable\IterableDataReader;
use Yiisoft\Data\Reader\Sort;
use Yiisoft\Html\Tag\Input\Checkbox;
use Yiisoft\Yii\DataView\Column\Base\Cell;
use Yiisoft\Yii\DataView\Column\Base\DataContext;
use Yiisoft\Yii\DataView\Column\Base\GlobalContext;
use Yiisoft\Yii\DataView\Column\Base\HeaderContext;
use Yiisoft\Yii\DataView\Column\CheckboxColumn;
use Yiisoft\Yii\DataView\Column\CheckboxColumnRenderer;
use Yiisoft\Yii\DataView\Tests\Support\Mock;
use Yiisoft\Yii\DataView\UrlConfig;

final class CheckboxColumnRendererTest extends TestCase
{
private CheckboxColumnRenderer $renderer;
private Cell $cell;
private GlobalContext $globalContext;
private IterableDataReader $dataReader;

protected function setUp(): void
{
$this->renderer = new CheckboxColumnRenderer();
$this->cell = new Cell();
$this->dataReader = new IterableDataReader([
['id' => 1, 'name' => 'John'],
['id' => 2, 'name' => 'Mary'],
]);
$this->globalContext = new GlobalContext(
dataReader: $this->dataReader,
pathArguments: [],
queryParameters: [],
translator: Mock::translator('en'),
translationCategory: 'test'
);
}

public function testRenderColumn(): void
{
$column = new CheckboxColumn(columnAttributes: ['class' => 'test-class']);
$result = $this->renderer->renderColumn($column, $this->cell, $this->globalContext);
$this->assertSame(['class' => 'test-class'], $result->getAttributes());
}

public function testRenderHeaderWithoutHeaderAndSingleSelection(): void
{
$column = new CheckboxColumn(multiple: false);
$sort = Sort::any();
$context = new HeaderContext(
originalSort: $sort,
sort: $sort,
orderProperties: ['test' => 'test'],
sortableHeaderClass: 'sortable',
sortableHeaderPrepend: '',
sortableHeaderAppend: '',
sortableHeaderAscClass: 'asc',
sortableHeaderAscPrepend: '',
sortableHeaderAscAppend: '',
sortableHeaderDescClass: 'desc',
sortableHeaderDescPrepend: '',
sortableHeaderDescAppend: '',
sortableLinkAttributes: [],
sortableLinkAscClass: 'asc-link',
sortableLinkDescClass: 'desc-link',
pageToken: null,
pageSize: 10,
multiSort: false,
urlConfig: new UrlConfig(),
urlCreator: null,
translator: Mock::translator('en'),
translationCategory: 'test'
);
$result = $this->renderer->renderHeader($column, $this->cell, $context);
$this->assertNull($result);
}

public function testRenderHeaderWithoutHeaderAndMultipleSelection(): void
{
$column = new CheckboxColumn(multiple: true);
$sort = Sort::any();
$context = new HeaderContext(
originalSort: $sort,
sort: $sort,
orderProperties: ['test' => 'test'],
sortableHeaderClass: 'sortable',
sortableHeaderPrepend: '',
sortableHeaderAppend: '',
sortableHeaderAscClass: 'asc',
sortableHeaderAscPrepend: '',
sortableHeaderAscAppend: '',
sortableHeaderDescClass: 'desc',
sortableHeaderDescPrepend: '',
sortableHeaderDescAppend: '',
sortableLinkAttributes: [],
sortableLinkAscClass: 'asc-link',
sortableLinkDescClass: 'desc-link',
pageToken: null,
pageSize: 10,
multiSort: false,
urlConfig: new UrlConfig(),
urlCreator: null,
translator: Mock::translator('en'),
translationCategory: 'test'
);
$result = $this->renderer->renderHeader($column, $this->cell, $context);
$this->assertNotNull($result);
$this->assertStringContainsString('checkbox-selection-all', (string) $result->getContent()[0]);
}

public function testRenderHeaderWithCustomHeader(): void
{
$column = new CheckboxColumn(
header: 'Custom Header',
headerAttributes: ['class' => 'header-class']
);
$sort = Sort::any();
$context = new HeaderContext(
originalSort: $sort,
sort: $sort,
orderProperties: ['test' => 'test'],
sortableHeaderClass: 'sortable',
sortableHeaderPrepend: '',
sortableHeaderAppend: '',
sortableHeaderAscClass: 'asc',
sortableHeaderAscPrepend: '',
sortableHeaderAscAppend: '',
sortableHeaderDescClass: 'desc',
sortableHeaderDescPrepend: '',
sortableHeaderDescAppend: '',
sortableLinkAttributes: [],
sortableLinkAscClass: 'asc-link',
sortableLinkDescClass: 'desc-link',
pageToken: null,
pageSize: 10,
multiSort: false,
urlConfig: new UrlConfig(),
urlCreator: null,
translator: Mock::translator('en'),
translationCategory: 'test'
);
$result = $this->renderer->renderHeader($column, $this->cell, $context);
$this->assertNotNull($result);
$this->assertSame('Custom Header', $result->getContent()[0]);
$this->assertSame(['class' => 'header-class'], $result->getAttributes());
}

public function testRenderBodyWithDefaultNameAndValue(): void
{
$column = new CheckboxColumn();
$context = new DataContext(
preparedDataReader: $this->dataReader,
column: $column,
data: ['id' => 1, 'name' => 'John'],
key: 1,
index: 0
);
$result = $this->renderer->renderBody($column, $this->cell, $context);
$content = (string) $result->getContent()[0];
$this->assertStringContainsString('name="checkbox-selection"', $content);
$this->assertStringContainsString('value="1"', $content);
$this->assertFalse($result->shouldEncode());
}

public function testRenderBodyWithCustomNameAndValue(): void
{
$column = new CheckboxColumn(
inputAttributes: [
'name' => 'custom-name',
'value' => 'custom-value',
'class' => 'custom-class',
]
);
$context = new DataContext(
preparedDataReader: $this->dataReader,
column: $column,
data: ['id' => 1, 'name' => 'John'],
key: 1,
index: 0
);
$result = $this->renderer->renderBody($column, $this->cell, $context);
$content = (string) $result->getContent()[0];
$this->assertStringContainsString('name="custom-name"', $content);
$this->assertStringContainsString('value="custom-value"', $content);
$this->assertStringContainsString('class="custom-class"', $content);
}

public function testRenderBodyWithCustomContent(): void
{
$column = new CheckboxColumn(
content: static fn(Checkbox $input, DataContext $context): string => "<div>{$input->render()}</div>"
);
$context = new DataContext(
preparedDataReader: $this->dataReader,
column: $column,
data: ['id' => 1, 'name' => 'John'],
key: 1,
index: 0
);
$result = $this->renderer->renderBody($column, $this->cell, $context);
$content = (string) $result->getContent()[0];
$this->assertStringStartsWith('<div>', $content);
$this->assertStringEndsWith('</div>', $content);
}

public function testRenderFooterWithContent(): void
{
$column = new CheckboxColumn(footer: 'Test Footer');
$result = $this->renderer->renderFooter($column, $this->cell, $this->globalContext);
$this->assertSame('Test Footer', $result->getContent()[0]);
}

public function testRenderFooterWithoutContent(): void
{
$column = new CheckboxColumn();
$result = $this->renderer->renderFooter($column, $this->cell, $this->globalContext);
$this->assertEmpty($result->getContent());
}
}
Loading
Loading