Skip to content
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.

Sign up for GitHub

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

Cleanup and tests #245

Merged
merged 8 commits into from
Feb 14, 2025
Merged

Cleanup and tests #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
89069ce
Remove unused exception class
samdark Feb 12, 2025
eefa3d1
cleanup
samdark Feb 12, 2025
078aa01
Add test for GridView::emptyCellAttributes()
samdark Feb 12, 2025
e93f142
Add attribtes
samdark Feb 12, 2025
c02cd8c
tests
samdark Feb 12, 2025
42e727e
Expand GridView immutability tests
samdark Feb 14, 2025
5beb2e1
Expand BaseListView immutability tests
samdark Feb 14, 2025
6143e91
Remove redundant asserts
samdark Feb 14, 2025
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
43 changes: 0 additions & 43 deletions src/Exception/UrlGeneratorNotSetException.php
View file
Open in desktop

This file was deleted.

267 changes: 265 additions & 2 deletions tests/GridView/BaseTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,8 @@ public function testColumnGroupEnabledEmpty(): void

public function testEmptyCell(): void
{
$attributes = ['class' => 'empty-cell'];

Assert::equalsWithoutLE(
<<<HTML
<div id="w1-grid">
Expand All @@ -191,7 +193,7 @@ public function testEmptyCell(): void
</thead>
<tbody>
<tr>
<td>Empty cell</td>
<td class="empty-cell">Empty cell</td>
</tr>
</tbody>
</table>
Expand All @@ -200,7 +202,7 @@ public function testEmptyCell(): void
HTML,
GridView::widget()
->columns(new DataColumn('id'))
->emptyCell('Empty cell')
->emptyCell('Empty cell', $attributes)
->id('w1-grid')
->dataReader($this->createOffsetPaginator([['id' => '']], 10))
->render()
Expand Down Expand Up @@ -703,4 +705,265 @@ public function testNoSortInUrlWhenLimited(): void

$this->assertStringNotContainsString('sort=', $output);
}

public function testEmptyCellAttributes(): void
{
$attributes = ['class' => 'empty-cell', 'data-test' => 'test-value'];

$html = GridView::widget()
->id('w1-grid')
->emptyCellAttributes($attributes)
->columns(
new SerialColumn(),
new DataColumn('id'),
new DataColumn('name'),
new DataColumn('age'),
)
->dataReader($this->createOffsetPaginator([
[
'id' => 1,
'name' => '',
'age' => 42,
],
], 10))
->render();

Assert::equalsWithoutLE(
<<<HTML
<div id="w1-grid">
<table>
<thead>
<tr>
<th>#</th>
<th>Id</th>
<th>Name</th>
<th>Age</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>1</td>
<td class="empty-cell" data-test="test-value">&nbsp;</td>
<td>42</td>
</tr>
</tbody>
</table>
<div>Page <b>1</b> of <b>1</b></div>
</div>
HTML,
$html
);
}

public function testAddTableClass(): void
{
$reader = new IterableDataReader($this->data);
$paginator = $this->createOffsetPaginator($this->data, 10);

$gridView = GridView::widget()
->dataReader($paginator)
->columns(
new DataColumn(property: 'id'),
new DataColumn(property: 'name')
);

$newGridView = $gridView->addTableClass('test-class', 'another-class');

// Assert original instance not modified
$this->assertStringNotContainsString('test-class', $gridView->render());

// Assert new instance has classes
$html = $newGridView->render();
$this->assertStringContainsString('test-class', $html);
$this->assertStringContainsString('another-class', $html);
}

public function testTableClass(): void
{
$paginator = $this->createOffsetPaginator($this->data, 10);

$gridView = GridView::widget()
->dataReader($paginator)
->columns(
new DataColumn(property: 'id'),
new DataColumn(property: 'name')
)
->addTableClass('initial-class');

$newGridView = $gridView->tableClass('test-class', 'another-class', null);

// Assert immutability
$this->assertNotSame($gridView, $newGridView);

// Assert original instance still has initial class
$html = $gridView->render();
$this->assertStringContainsString('initial-class', $html);
$this->assertStringNotContainsString('test-class', $html);

// Assert new instance has new classes and old class is removed
$html = $newGridView->render();
$this->assertStringContainsString('test-class', $html);
$this->assertStringContainsString('another-class', $html);
$this->assertStringNotContainsString('initial-class', $html);
}

public function testTbodyAttributes(): void
{
$paginator = $this->createOffsetPaginator($this->data, 10);

$gridView = GridView::widget()
->dataReader($paginator)
->columns(
new DataColumn(property: 'id'),
new DataColumn(property: 'name')
);

$newGridView = $gridView->tbodyAttributes([
'class' => 'tbody-class',
'data-test' => 'test-value',
'id' => 'test-tbody',
]);

// Assert immutability
$this->assertNotSame($gridView, $newGridView);

// Assert original instance doesn't have attributes
$html = $gridView->render();
$this->assertStringNotContainsString('tbody-class', $html);
$this->assertStringNotContainsString('data-test', $html);
$this->assertStringNotContainsString('test-tbody', $html);

// Assert new instance has all attributes
$html = $newGridView->render();
$this->assertStringContainsString('tbody-class', $html);
$this->assertStringContainsString('data-test="test-value"', $html);
$this->assertStringContainsString('id="test-tbody"', $html);
}

public function testAddTbodyClass(): void
{
$paginator = $this->createOffsetPaginator($this->data, 10);

$gridView = GridView::widget()
->dataReader($paginator)
->columns(
new DataColumn(property: 'id'),
new DataColumn(property: 'name')
)
->tbodyAttributes(['class' => 'initial-class']);

$newGridView = $gridView->addTbodyClass('test-class', 'another-class', null);

// Assert immutability
$this->assertNotSame($gridView, $newGridView);

// Assert original instance still has only initial class
$html = $gridView->render();
$this->assertStringContainsString('initial-class', $html);
$this->assertStringNotContainsString('test-class', $html);
$this->assertStringNotContainsString('another-class', $html);

// Assert new instance has all classes including the initial one
$html = $newGridView->render();
$this->assertStringContainsString('initial-class', $html);
$this->assertStringContainsString('test-class', $html);
$this->assertStringContainsString('another-class', $html);
}

public function testTbodyClass(): void
{
$paginator = $this->createOffsetPaginator($this->data, 10);

$gridView = GridView::widget()
->dataReader($paginator)
->columns(
new DataColumn(property: 'id'),
new DataColumn(property: 'name')
)
->tbodyAttributes(['class' => 'initial-class']);

$newGridView = $gridView->tbodyClass('test-class', 'another-class', null);

// Assert immutability
$this->assertNotSame($gridView, $newGridView);

// Assert original instance still has initial class
$html = $gridView->render();
$this->assertStringContainsString('initial-class', $html);
$this->assertStringNotContainsString('test-class', $html);
$this->assertStringNotContainsString('another-class', $html);

// Assert new instance has new classes and old class is removed
$html = $newGridView->render();
$this->assertStringContainsString('test-class', $html);
$this->assertStringContainsString('another-class', $html);
$this->assertStringNotContainsString('initial-class', $html);
}

public function testHeaderCellAttributes(): void
{
$paginator = $this->createOffsetPaginator($this->data, 10);

$gridView = GridView::widget()
->dataReader($paginator)
->columns(
new DataColumn(property: 'id'),
new DataColumn(property: 'name')
);

$newGridView = $gridView->headerCellAttributes([
'class' => 'header-class',
'data-test' => 'test-value',
'scope' => 'col',
]);

// Assert immutability
$this->assertNotSame($gridView, $newGridView);

// Assert original instance doesn't have attributes
$html = $gridView->render();
$this->assertStringNotContainsString('header-class', $html);
$this->assertStringNotContainsString('data-test="test-value"', $html);
$this->assertStringNotContainsString('scope="col"', $html);

// Assert new instance has all attributes
$html = $newGridView->render();
$this->assertStringContainsString('header-class', $html);
$this->assertStringContainsString('data-test="test-value"', $html);
$this->assertStringContainsString('scope="col"', $html);
}

public function testBodyCellAttributes(): void
{
$paginator = $this->createOffsetPaginator($this->data, 10);

$gridView = GridView::widget()
->dataReader($paginator)
->columns(
new DataColumn(property: 'id'),
new DataColumn(property: 'name')
);

$newGridView = $gridView->bodyCellAttributes([
'class' => 'cell-class',
'data-test' => 'test-value',
'title' => 'Cell title',
]);

// Assert immutability
$this->assertNotSame($gridView, $newGridView);

// Assert original instance doesn't have attributes
$html = $gridView->render();
$this->assertStringNotContainsString('cell-class', $html);
$this->assertStringNotContainsString('data-test="test-value"', $html);
$this->assertStringNotContainsString('title="Cell title"', $html);

// Assert new instance has all attributes
$html = $newGridView->render();
$this->assertStringContainsString('cell-class', $html);
$this->assertStringContainsString('data-test="test-value"', $html);
$this->assertStringContainsString('title="Cell title"', $html);
}
}
35 changes: 35 additions & 0 deletions tests/GridView/ImmutableTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,21 @@ public function testBaseListView(): void
$this->assertNotSame($baseListView, $baseListView->toolbar(''));
$this->assertNotSame($baseListView, $baseListView->urlArguments([]));
$this->assertNotSame($baseListView, $baseListView->urlQueryParameters([]));
$this->assertNotSame($baseListView, $baseListView->pageSizeTag(null));
$this->assertNotSame($baseListView, $baseListView->pageSizeAttributes([]));
$this->assertNotSame($baseListView, $baseListView->pageSizeTemplate(null));
$this->assertNotSame($baseListView, $baseListView->pageSizeWidget(null));
$this->assertNotSame($baseListView, $baseListView->pageSizeParameterName(''));
$this->assertNotSame($baseListView, $baseListView->pageParameterName(''));
$this->assertNotSame($baseListView, $baseListView->previousPageParameterName(''));
$this->assertNotSame($baseListView, $baseListView->urlParameterProvider(null));
$this->assertNotSame($baseListView, $baseListView->enableMultiSort());
$this->assertNotSame($baseListView, $baseListView->ignoreMissingPage(true));
$this->assertNotSame($baseListView, $baseListView->pageNotFoundExceptionCallback(null));
$this->assertNotSame($baseListView, $baseListView->urlCreator(null));
$this->assertNotSame($baseListView, $baseListView->offsetPaginationConfig([]));
$this->assertNotSame($baseListView, $baseListView->keysetPaginationConfig([]));
$this->assertNotSame($baseListView, $baseListView->pageSizeConstraint(true));
}

/**
Expand All @@ -64,6 +79,26 @@ public function testGridView(): void
$this->assertNotSame($gridView, $gridView->enableHeader(false));
$this->assertNotSame($gridView, $gridView->bodyRowAttributes([]));
$this->assertNotSame($gridView, $gridView->tableAttributes([]));
$this->assertNotSame($gridView, $gridView->addColumnRendererConfigs([]));
$this->assertNotSame($gridView, $gridView->filterCellAttributes([]));
$this->assertNotSame($gridView, $gridView->filterCellInvalidClass(null));
$this->assertNotSame($gridView, $gridView->filterErrorsContainerAttributes([]));
$this->assertNotSame($gridView, $gridView->keepPageOnSort(true));
$this->assertNotSame($gridView, $gridView->emptyCellAttributes([]));
$this->assertNotSame($gridView, $gridView->addTableClass(null));
$this->assertNotSame($gridView, $gridView->tableClass(null));
$this->assertNotSame($gridView, $gridView->tbodyAttributes([]));
$this->assertNotSame($gridView, $gridView->addTbodyClass(null));
$this->assertNotSame($gridView, $gridView->tbodyClass(null));
$this->assertNotSame($gridView, $gridView->headerCellAttributes([]));
$this->assertNotSame($gridView, $gridView->bodyCellAttributes([]));
$this->assertNotSame($gridView, $gridView->sortableLinkAttributes([]));
$this->assertNotSame($gridView, $gridView->sortableHeaderPrepend(''));
$this->assertNotSame($gridView, $gridView->sortableHeaderAppend(''));
$this->assertNotSame($gridView, $gridView->sortableHeaderAscPrepend(''));
$this->assertNotSame($gridView, $gridView->sortableHeaderAscAppend(''));
$this->assertNotSame($gridView, $gridView->sortableHeaderDescPrepend(''));
$this->assertNotSame($gridView, $gridView->sortableHeaderDescAppend(''));
}

private function createBaseListView(): DataView\BaseListView
Expand Down
Loading