GlyphTest.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\Symbol\Glyph as G;
use ILIAS\UI\Component\Counter as C;
use ILIAS\UI\Implementation\Component as I;
use ILIAS\UI\Implementation\Component\Symbol\Glyph\Glyph;
use ILIAS\UI\Implementation\Component\Symbol\Glyph\Renderer;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\UI\HelpTextRetriever;
use PHPUnit\Framework\Attributes\DataProvider;

class GlyphTest extends ILIAS_UI_TestBase
{
    public function getGlyphFactory(): G\Factory
    {
        return new I\Symbol\Glyph\Factory();
    }

    public function getCounterFactory(): C\Factory
    {
        return new I\Counter\Factory();
    }

    public static array $canonical_css_classes = array(
        G\Glyph::SETTINGS => "glyphicon glyphicon-cog",
        G\Glyph::EXPAND => "glyphicon glyphicon-triangle-right",
        G\Glyph::COLLAPSE => "glyphicon glyphicon-triangle-bottom",
        G\Glyph::ADD => "glyphicon glyphicon-plus-sign",
        G\Glyph::REMOVE => "glyphicon glyphicon-minus-sign",
        G\Glyph::UP => "glyphicon glyphicon-circle-arrow-up",
        G\Glyph::DOWN => "glyphicon glyphicon-circle-arrow-down",
        G\Glyph::BACK => "glyphicon glyphicon-chevron-left",
        G\Glyph::NEXT => "glyphicon glyphicon-chevron-right",
        G\Glyph::SORT_ASCENDING => "glyphicon glyphicon-arrow-up",
        G\Glyph::SORT_DESCENDING => "glyphicon glyphicon-arrow-down",
        G\Glyph::USER => "glyphicon glyphicon-user",
        G\Glyph::MAIL => "glyphicon glyphicon-envelope",
        G\Glyph::NOTIFICATION => "glyphicon glyphicon-bell",
        G\Glyph::TAG => "glyphicon glyphicon-tag",
        G\Glyph::NOTE => "glyphicon glyphicon-pushpin",
        G\Glyph::COMMENT => "glyphicon glyphicon-comment",
        G\Glyph::BRIEFCASE => "glyphicon glyphicon-briefcase",
        G\Glyph::LIKE => "glyphicon il-glyphicon-like",
        G\Glyph::LOVE => "glyphicon il-glyphicon-love",
        G\Glyph::DISLIKE => "glyphicon il-glyphicon-dislike",
        G\Glyph::LAUGH => "glyphicon il-glyphicon-laugh",
        G\Glyph::ASTOUNDED => "glyphicon il-glyphicon-astounded",
        G\Glyph::SAD => "glyphicon il-glyphicon-sad",
        G\Glyph::ANGRY => "glyphicon il-glyphicon-angry",
        G\Glyph::EYEOPEN => "glyphicon glyphicon-eye-open",
        G\Glyph::EYECLOSED => "glyphicon glyphicon-eye-close",
        G\Glyph::ATTACHMENT => "glyphicon glyphicon-paperclip",
        G\Glyph::RESET => "glyphicon glyphicon-reset",
        G\Glyph::APPLY => "glyphicon glyphicon-apply",
        G\Glyph::SEARCH => "glyphicon glyphicon-search",
        G\Glyph::HELP => "glyphicon glyphicon-question-sign",
        G\Glyph::CALENDAR => "glyphicon glyphicon-calendar",
        G\Glyph::TIME => "glyphicon glyphicon-time",
        G\Glyph::CLOSE => "glyphicon glyphicon-remove",
        G\Glyph::MORE => "glyphicon glyphicon-option-horizontal",
        G\Glyph::DISCLOSURE => "glyphicon glyphicon-option-vertical",
        G\Glyph::LANGUAGE => "glyphicon glyphicon-lang",
        G\Glyph::LOGIN => "glyphicon glyphicon-login",
        G\Glyph::LOGOUT => "glyphicon glyphicon-logout",
        G\Glyph::BULLETLIST => "glyphicon glyphicon-bulletlist",
        G\Glyph::NUMBEREDLIST => "glyphicon glyphicon-numberedlist",
        G\Glyph::LISTINDENT => "glyphicon glyphicon-listindent",
        G\Glyph::LISTOUTDENT => "glyphicon glyphicon-listoutdent",
        G\Glyph::FILTER => "glyphicon glyphicon-filter",
        G\Glyph::COLLAPSE_HORIZONTAL => "glyphicon glyphicon-triangle-left",
        G\Glyph::HEADER => "glyphicon glyphicon-header",
        G\Glyph::ITALIC => "glyphicon glyphicon-italic",
        G\Glyph::BOLD => "glyphicon glyphicon-bold",
        G\Glyph::LINK => "glyphicon glyphicon-link",
        G\Glyph::LAUNCH => "glyphicon glyphicon-launch",
        G\Glyph::ENLARGE => "glyphicon glyphicon-enlarge",
        G\Glyph::LIST_VIEW => "glyphicon glyphicon-listView",
        G\Glyph::PREVIEW => "glyphicon glyphicon-preview",
        G\Glyph::SORT => "glyphicon glyphicon-sort",
        G\Glyph::COLUMN_SELECTION => "glyphicon glyphicon-columnSelection",
        G\Glyph::TILE_VIEW => "glyphicon glyphicon-tileView",
        G\Glyph::DRAG_HANDLE => "glyphicon glyphicon-dragHandle",
        G\Glyph::CHECKED => "glyphicon glyphicon-checked",
        G\Glyph::UNCHECKED => "glyphicon glyphicon-unchecked",
    );

    public static array $aria_labels = array(
        G\Glyph::SETTINGS => "settings",
        G\Glyph::EXPAND => "expand_content",
        G\Glyph::COLLAPSE => "collapse_content",
        G\Glyph::ADD => "add",
        G\Glyph::REMOVE => "remove",
        G\Glyph::UP => "up",
        G\Glyph::DOWN => "down",
        G\Glyph::BACK => "back",
        G\Glyph::NEXT => "next",
        G\Glyph::SORT_ASCENDING => "sort_ascending",
        G\Glyph::SORT_DESCENDING => "sort_descending",
        G\Glyph::USER => "show_who_is_online",
        G\Glyph::MAIL => "mail",
        G\Glyph::NOTIFICATION => "notifications",
        G\Glyph::TAG => "tags",
        G\Glyph::NOTE => "notes",
        G\Glyph::COMMENT => "comments",
        G\Glyph::BRIEFCASE => "briefcase",
        G\Glyph::LIKE => "like",
        G\Glyph::LOVE => "love",
        G\Glyph::DISLIKE => "dislike",
        G\Glyph::LAUGH => "laugh",
        G\Glyph::ASTOUNDED => "astounded",
        G\Glyph::SAD => "sad",
        G\Glyph::ANGRY => "angry",
        G\Glyph::EYEOPEN => "eyeopened",
        G\Glyph::EYECLOSED => "eyeclosed",
        G\Glyph::ATTACHMENT => "attachment",
        G\Glyph::RESET => "reset",
        G\Glyph::APPLY => "apply",
        G\Glyph::SEARCH => "search",
        G\Glyph::HELP => "help",
        G\Glyph::CALENDAR => "calendar",
        G\Glyph::TIME => "time",
        G\Glyph::CLOSE => "close",
        G\Glyph::MORE => "show_more",
        G\Glyph::DISCLOSURE => "disclose",
        G\Glyph::LANGUAGE => "switch_language",
        G\Glyph::LOGIN => "log_in",
        G\Glyph::LOGOUT => "log_out",
        G\Glyph::BULLETLIST => "bulletlist_action",
        G\Glyph::NUMBEREDLIST => "numberedlist_action",
        G\Glyph::LISTINDENT => "listindent",
        G\Glyph::LISTOUTDENT => "listoutdent",
        G\Glyph::FILTER => "filter",
        G\Glyph::COLLAPSE_HORIZONTAL => "collapse/back",
        G\Glyph::HEADER => "header_action",
        G\Glyph::ITALIC => "italic_action",
        G\Glyph::BOLD => "bold_action",
        G\Glyph::LINK => "link_action",
        G\Glyph::LAUNCH => "launch",
        G\Glyph::ENLARGE => "enlarge",
        G\Glyph::LIST_VIEW => "list_view",
        G\Glyph::PREVIEW => "preview",
        G\Glyph::SORT => "sort",
        G\Glyph::COLUMN_SELECTION => "column_selection",
        G\Glyph::TILE_VIEW => "tile_view",
        G\Glyph::DRAG_HANDLE => "drag_handle",
        G\Glyph::CHECKED => "checked",
        G\Glyph::UNCHECKED => "unchecked",
    );

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testImplementsFactoryInterface(string $factory_method): void
    {
        $f = $this->getGlyphFactory();

        $this->assertInstanceOf("ILIAS\\UI\\Component\\Symbol\\Glyph\\Factory", $f);
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Symbol\\Glyph\\Glyph", $f->$factory_method());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testGlyphTypes(string $factory_method): void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();

        $this->assertNotNull($g);
        $this->assertEquals($factory_method, $g->getType());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testGlyphNoAction(string $factory_method): void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();

        $this->assertNotNull($g);
        $this->assertEquals(null, $g->getAction());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testWithUnavailableAction(string $factory_method): void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();
        $g2 = $f->$factory_method()->withUnavailableAction();

        $this->assertTrue($g->isActive());
        $this->assertFalse($g2->isActive());
    }

    public function testWithHighlight(): void
    {
        $gf = $this->getGlyphFactory();

        $g = $gf->mail();
        $g2 = $g->withHighlight();

        $this->assertFalse($g->isHighlighted());
        $this->assertTrue($g2->isHighlighted());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testNoCounter(string $factory_method): void
    {
        $f = $this->getGlyphFactory();
        $g = $f->$factory_method();

        $this->assertCount(0, $g->getCounters());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getCounterTypeProvider')]
    public function testOneCounter(string $counter_type): void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();
        $number = 1;

        $g = $gf
            ->mail()
            ->withCounter(
                $cf->$counter_type($number)
            );

        $counters = $g->getCounters();
        $this->assertCount(1, $counters);
        $c = $counters[0];
        $this->assertEquals($counter_type, $c->getType());
        $this->assertEquals($number, $c->getNumber());
    }

    public function testTwoCounters(): void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();
        $number_s = 1;
        $number_n = 2;

        $g = $gf
            ->mail()
            ->withCounter(
                $cf->status($number_s)
            )
            ->withCounter(
                $cf->novelty($number_n)
            );

        $counters = $g->getCounters();
        $this->assertCount(2, $counters);
        $vals = array_map(function ($c) {
            return array($c->getType(), $c->getNumber());
        }, $counters);
        $this->assertContains(array("status", $number_s), $vals);
        $this->assertContains(array("novelty", $number_n), $vals);
    }

    public function testOnlyTwoCounters(): void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();
        $number_s = 1;
        $number_n1 = 2;
        $number_n2 = 2;

        $g = $gf
            ->mail()
            ->withCounter(
                $cf->status($number_s)
            )
            ->withCounter(
                $cf->novelty($number_n1)
            )
            ->withCounter(
                $cf->novelty($number_n2)
            );

        $counters = $g->getCounters();
        $this->assertCount(2, $counters);
        $vals = array_map(function ($c) {
            return array($c->getType(), $c->getNumber());
        }, $counters);
        $this->assertContains(array("status", $number_s), $vals);
        $this->assertContains(array("novelty", $number_n2), $vals);
    }

    public function testImmutabilityWithCounter(): void
    {
        $gf = $this->getGlyphFactory();
        $cf = $this->getCounterFactory();

        $g = $gf->mail();
        $g
            ->withCounter(
                $cf->novelty(0)
            );

        $counters = $g->getCounters();
        $this->assertCount(0, $counters);
    }

    public function testKnownGlyphsOnly(): void
    {
        $this->expectException(InvalidArgumentException::class);
        new Glyph("FOO", "FAA");
    }

    public static function getGlyphTypeProvider(): array
    {
        $glyph_reflection = new ReflectionClass(G\Glyph::class);
        $constant_values = array_values($glyph_reflection->getConstants());
        return array_map(function ($val) {
            return [$val];
        }, $constant_values);
    }

    public static function getCounterTypeProvider(): array
    {
        return [
            ["status"],
            ["novelty"]
        ];
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testRenderSimple(string $type): void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
        $c = $f->$type();

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

        $css_classes = self::$canonical_css_classes[$type];
        $aria_label = self::$aria_labels[$type];

        $expected = '<a class="glyph" aria-label="' . $aria_label . '"><span class="' . $css_classes . '" aria-hidden="true"></span></a>';
        $this->assertEquals($expected, $html);
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testRenderWithUnavailableAction(string $type): void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
        $c = $f->$type()->withUnavailableAction();

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

        $css_classes = self::$canonical_css_classes[$type];
        $aria_label = self::$aria_labels[$type];

        $expected = '
        <a class="glyph disabled" aria-label="' . $aria_label . '" aria-disabled="true">
            <span class="' . $css_classes . '" aria-hidden="true"></span>
        </a>';
        $this->assertEquals($this->brutallyTrimHTML($expected), $this->brutallyTrimHTML($html));
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getCounterTypeProvider')]
    public function testRenderWithCounter(string $type): void
    {
        $fg = $this->getGlyphFactory();
        $fc = $this->getCounterFactory();
        $r = $this->getDefaultRenderer();
        $c = $fg->mail()->withCounter($fc->$type(42));

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

        $css_classes = self::$canonical_css_classes[G\Glyph::MAIL];
        $aria_label = self::$aria_labels[G\Glyph::MAIL];

        $expected = '
            <a class="glyph" aria-label="' . $aria_label . '">
                    <span class="' . $css_classes . '" aria-hidden="true"></span>
                    <span class="il-counter"><span class="badge badge-notify il-counter-' . $type . '">42</span></span>
                    <span class="il-counter-spacer">42</span>
            </a>';
        $this->assertHTMLEquals($expected, $html);
    }

    public function testRenderWithTwoCounters(): void
    {
        $fg = $this->getGlyphFactory();
        $fc = $this->getCounterFactory();
        $r = $this->getDefaultRenderer();
        $c = $fg->mail()
                ->withCounter($fc->novelty(42))
                ->withCounter($fc->status(7));

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

        $css_classes = self::$canonical_css_classes[G\Glyph::MAIL];
        $aria_label = self::$aria_labels[G\Glyph::MAIL];
        $expected = '<a class="glyph" aria-label="' . $aria_label . '">' .
                    '<span class="' . $css_classes . '" aria-hidden="true"></span>' .
                    '<span class="il-counter"><span class="badge badge-notify il-counter-status">7</span></span>' .
                    '<span class="il-counter"><span class="badge badge-notify il-counter-novelty">42</span></span>' .
                    '<span class="il-counter-spacer">42</span>' .
                    '</a>';
        $this->assertHTMLEquals($expected, $html);
    }

    public function testDontRenderCounter(): void
    {
        $this->expectException(\LogicException::class);
        $r = new Renderer(
            $this->getUIFactory(),
            $this->getTemplateFactory(),
            $this->getLanguage(),
            $this->getJavaScriptBinding(),
            new ilImagePathResolver(),
            $this->createMock(DataFactory::class),
            $this->createMock(HelpTextRetriever::class),
            $this->getUploadLimitResolver()
        );
        $f = $this->getCounterFactory();

        $r->render($f->status(0), $this->getDefaultRenderer());
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getGlyphTypeProvider')]
    public function testRenderWithOnLoadCode(string $type): void
    {
        $f = $this->getGlyphFactory();
        $r = $this->getDefaultRenderer();
        $ids = array();
        $c = $f->$type()
                ->withOnLoadCode(function ($id) use (&$ids): string {
                    $ids[] = $id;
                    return "";
                });

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

        $this->assertCount(1, $ids);

        $css_classes = self::$canonical_css_classes[$type];
        $aria_label = self::$aria_labels[$type];

        $id = $ids[0];
        $expected = '<a class="glyph" aria-label="' . $aria_label . '" id="' . $id . '"><span class="' . $css_classes . '" aria-hidden="true"></span></a>';
        $this->assertEquals($expected, $html);
    }
}