CounterTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once("vendor/composer/vendor/autoload.php");
require_once(__DIR__ . "/../../Base.php");

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component\Counter\Counter;
use ILIAS\UI\Implementation\Component\Counter\Factory;

class CounterTest extends ILIAS_UI_TestBase
{
    public function getCounterFactory(): Factory
    {
        return new Factory();
    }

    public function testImplementsFactoryInterface(): void
    {
        $f = $this->getCounterFactory();

        $this->assertInstanceOf("ILIAS\\UI\\Component\\Counter\\Factory", $f);

        $this->assertInstanceOf("ILIAS\\UI\\Component\\Counter\\Counter", $f->status(0));
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Counter\\Counter", $f->novelty(0));
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getNumberProvider')]
    public function testStatusCounter(int $number): void
    {
        $f = $this->getCounterFactory();

        $c = $f->status($number);

        $this->assertNotNull($c);
        $this->assertEquals(C\Counter\Counter::STATUS, $c->getType());
        $this->assertEquals($number, $c->getNumber());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getNumberProvider')]
    public function testNoveltyCounter(int $number): void
    {
        $f = $this->getCounterFactory();

        $c = $f->novelty($number);

        $this->assertNotNull($c);
        $this->assertEquals(C\Counter\Counter::NOVELTY, $c->getType());
        $this->assertEquals($number, $c->getNumber());
    }

    public function testKnownCountersOnly(): void
    {
        $this->expectException(InvalidArgumentException::class);
        new Counter("FOO", 1);
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getNoNumberProvider')]
    public function testIntNumbersOnly($no_number): void
    {
        $this->expectException(TypeError::class);
        $f = $this->getCounterFactory();
        $f->status($no_number);
    }

    public static function getNumberProvider(): array
    {
        return [
            [-13],
            [0],
            [23],
            [4]
        ];
    }

    public static function getNoNumberProvider(): array
    {
        return [
            ["foo"],
            [9.1],
            [array()],
            [new stdClass()]
        ];
    }

    public static array $canonical_css_classes = [
        "status" => "badge badge-notify il-counter-status",
        "novelty" => "badge badge-notify il-counter-novelty"
    ];

    #[\PHPUnit\Framework\Attributes\DataProvider('getCounterTypeAndNumberProvider')]
    public function testRenderStatus(string $type, int $number): void
    {
        $f = $this->getCounterFactory();
        $r = $this->getDefaultRenderer();
        $c = $f->$type($number);

        $html = $this->normalizeHTML($r->render($c));

        $css_classes = self::$canonical_css_classes[$type];
        $expected = "<span class=\"il-counter\"><span class=\"$css_classes\">$number</span></span>";
        $this->assertHTMLEquals($expected, $html);
    }

    public static function getCounterTypeAndNumberProvider(): array
    {
        return [
            ["status", 42],
            ["novelty", 13],
            ["status", 1],
            ["novelty", 23],
        ];
    }
}