SortingTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Badge\test;

use ILIAS\Badge\Sorting;
use ilBadge;
use ilBadgeAssignment;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Depends;

class SortingTest extends TestCase
{
    public function testConstruct(): void
    {
        $sort = new Sorting();
        $this->assertInstanceOf(Sorting::class, $sort);
    }

    #[DataProvider('sortProvider')]
    #[Depends('testConstruct')]
    public function testSorting(array $input, string $key, string $label, string $what, string $method, array $equal, array $less, array $greater): void
    {
        $sort = new Sorting(...$input);
        $this->assertEquals($key, $sort->key());
        $this->assertEquals($label, $sort->label());
        $this->assertEquals(0, $sort->compare($this->pair($what, $method, $equal[0]), $this->pair($what, $method, $equal[1])));
        $this->assertEquals(-1, $this->sign($sort->compare($this->pair($what, $method, $less[0]), $this->pair($what, $method, $less[1]))));
        $this->assertEquals(1, $this->sign($sort->compare($this->pair($what, $method, $greater[0]), $this->pair($what, $method, $greater[1]))));
    }

    #[Depends('testConstruct')]
    public function testOptions(): void
    {
        $this->assertEquals([
            'title_asc',
            'title_desc',
            'date_asc',
            'date_desc',
        ], array_keys((new Sorting())->options()));
    }

    public static function sortProvider(): array
    {
        return [
            'Default sort is title_asc' => [[], 'title_asc', 'sort_by_title_asc', 'badge', 'getTitle', ['A', 'a'], ['f', 'G'], ['d', 'c']],
            'Descending title' => [['title_desc'], 'title_desc', 'sort_by_title_desc', 'badge', 'getTitle', ['A', 'a'], ['d', 'c'], ['f', 'G']],
            'Ascending date' => [['date_asc'], 'date_asc', 'sort_by_date_asc', 'assignment', 'getTimestamp', [7, 7], [8, 30], [20, 6]],
            'Descending date' => [['date_desc'], 'date_desc', 'sort_by_date_desc', 'assignment', 'getTimestamp', [7, 7], [20, 6], [8, 30]],
            'Random input results in title_asc' => [['Lorem ipsum'], 'title_asc', 'sort_by_title_asc', 'badge', 'getTitle', ['A', 'a'], ['f', 'G'], ['d', 'c']]
        ];
    }

    private function pair(string $what, string $method, $value): array
    {
        $badge = $this->getMockBuilder(ilBadge::class)->disableOriginalConstructor()->getMock();
        $assignment = $this->getMockBuilder(ilBadgeAssignment::class)->disableOriginalConstructor()->getMock();

        $pair = [
            'badge' => $badge,
            'assignment' => $assignment,
        ];

        $pair[$what]->method($method)->willReturn($value);

        return $pair;
    }

    private function sign(int $x): int
    {
        return !$x ? 0 : $x / abs($x);
    }
}