MainBarTest.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2018 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */

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

use \ILIAS\UI\Component as C;
use \ILIAS\UI\Implementation\Component as I;
use \ILIAS\UI\Implementation\Component\MainControls\Slate\Legacy;
use \ILIAS\UI\Component\Signal;

class MainBarTest extends ILIAS_UI_TestBase
{
    public function setUp() : void
    {
        $sig_gen = new I\SignalGenerator();
        $this->button_factory = new I\Button\Factory($sig_gen);
        $this->link_factory = new I\Link\Factory();
        $this->icon_factory = new I\Symbol\Icon\Factory();
        $counter_factory = new I\Counter\Factory();
        $slate_factory = new I\MainControls\Slate\Factory(
            $sig_gen,
            $counter_factory,
            new I\Symbol\Factory(
                new I\Symbol\Icon\Factory(),
                new I\Symbol\Glyph\Factory(),
                new I\Symbol\Avatar\Factory()
            )
        );
        $this->factory = new I\MainControls\Factory($sig_gen, $slate_factory);

        $this->mainbar = $this->factory->mainBar();
    }

    public function testConstruction()
    {
        $this->assertInstanceOf(
            "ILIAS\\UI\\Component\\MainControls\\MainBar",
            $this->mainbar
        );
    }

    protected function getButton()
    {
        $symbol = $this->icon_factory->custom('', '');
        return $this->button_factory->bulky($symbol, 'TestEntry', '#');
    }

    protected function getLink()
    {
        $symbol = $this->icon_factory->custom('', '');
        $target = new \ILIAS\Data\URI("http://www.ilias.de");
        return $this->link_factory->bulky($symbol, 'TestEntry', $target);
    }

    protected function getSlate()
    {
        $mock = $this->getMockBuilder(Legacy::class)
            ->disableOriginalConstructor()
            ->setMethods(["transformToLegacyComponent"])
            ->getMock();

        $mock->method('transformToLegacyComponent')->willReturn('content');
        return $mock;
    }

    public function testAddEntry()
    {
        $btn = $this->getButton();
        $lnk = $this->getLink();
        $mb = $this->mainbar
            ->withAdditionalEntry('testbtn', $btn)
            ->withAdditionalEntry('testlnk', $lnk);

        $entries = $mb->getEntries();
        $expected = [
            'testbtn' => $btn,
            'testlnk' => $lnk,
        ];
        $this->assertEquals($expected, $entries);
        return $mb;
    }

    public function testDisallowedEntry()
    {
        $this->expectException(\InvalidArgumentException::class);
        $mb = $this->mainbar->withAdditionalEntry('test', 'wrong_param');
    }

    public function testDouplicateIdEntry()
    {
        $this->expectException(\InvalidArgumentException::class);
        $btn = $this->getButton();
        $mb = $this->mainbar
            ->withAdditionalEntry('test', $btn)
            ->withAdditionalEntry('test', $btn);
    }

    public function testDisallowedToolEntry()
    {
        $this->expectException(\TypeError::class);
        $mb = $this->mainbar->withAdditionalToolEntry('test', 'wrong_param');
    }

    public function testAddToolEntryWithoutToolsButton()
    {
        $this->expectException(\LogicException::class);
        $mb = $this->mainbar->withAdditionalToolEntry('test', $this->getSlate());
    }

    public function testAddToolEntry()
    {
        $slate = $this->getSlate();
        $mb = $this->mainbar
            ->withToolsButton($this->getButton())
            ->withAdditionalToolEntry('test', $slate);
        $entries = $mb->getToolEntries();
        $this->assertEquals($slate, $entries['test']);
    }

    public function testDouplicateIdToolEntry()
    {
        $this->expectException(\InvalidArgumentException::class);
        $btn = $this->getButton();
        $slate = $this->getSlate();
        $mb = $this->mainbar->withToolsButton($btn)
            ->withAdditionalToolEntry('test', $slate)
            ->withAdditionalToolEntry('test', $slate);
    }

    public function testActive($mb)
    {
        $mb = $mb->withActive('testbtn');
        $this->assertEquals('testbtn', $mb->getActive());
    }

    public function testWithInvalidActive()
    {
        $this->expectException(\InvalidArgumentException::class);
        $mb = $this->mainbar
            ->withActive('this-is-not-a-valid-entry');
    }

    public function testSignalsPresent()
    {
        $this->assertInstanceOf(Signal::class, $this->mainbar->getEntryClickSignal());
        $this->assertInstanceOf(Signal::class, $this->mainbar->getToolsClickSignal());
        $this->assertInstanceOf(Signal::class, $this->mainbar->getToolsRemovalSignal());
        $this->assertInstanceOf(Signal::class, $this->mainbar->getDisengageAllSignal());
    }

    public function getUIFactory()
    {
        $factory = new class extends NoUIFactory {
            public function button()
            {
                return $this->button_factory;
            }
            public function symbol() : C\Symbol\Factory
            {
                $f_icon = new I\Symbol\Icon\Factory();
                $f_glyph = new I\Symbol\Glyph\Factory();
                $f_avatar = new I\Symbol\Avatar\Factory();

                return new I\Symbol\Factory($f_icon, $f_glyph, $f_avatar);
            }
            public function mainControls() : C\MainControls\Factory
            {
                $sig_gen = new I\SignalGenerator();
                $counter_factory = new I\Counter\Factory();
                $symbol_factory = new I\Symbol\Factory(
                    new I\Symbol\Icon\Factory(),
                    new I\Symbol\Glyph\Factory(),
                    new I\Symbol\Avatar\Factory()
                );
                $slate_factory = new I\MainControls\Slate\Factory($sig_gen, $counter_factory, $symbol_factory);
                return new I\MainControls\Factory($sig_gen, $slate_factory);
            }
            public function legacy($legacy)
            {
                $sig_gen = new I\SignalGenerator();
                return new I\Legacy\Legacy($legacy, $sig_gen);
            }
        };
        $factory->button_factory = $this->button_factory;
        return $factory;
    }

    public function brutallyTrimHTML($html)
    {
        $html = str_replace(["\n", "\r", "\t"], "", $html);
        $html = preg_replace('# {2,}#', " ", $html);
        $html = preg_replace('/<!--(.|\s)*?-->/', '', $html);
        return trim($html);
    }

    public function testRendering()
    {
        $r = $this->getDefaultRenderer();
        $icon = $this->icon_factory->custom('', '');

        $sf = $this->factory->slate();
        $slate = $sf->combined('1', $icon, '')
            ->withAdditionalEntry(
                $sf->combined('1.1', $icon, '')
                    ->withAdditionalEntry(
                        $sf->combined('1.1.1', $icon, '')
                    )
            );

        $mb = $this->factory->mainBar()
            ->withMoreButton(
                $this->button_factory->bulky($icon, 'more', '')
            )
            ->withAdditionalEntry('test1', $this->getButton())
            ->withAdditionalEntry('test2', $this->getButton())
            ->withAdditionalEntry('slate', $slate);

        $html = $r->render($mb);

        $expected = <<<EOT
                        <div class="il-maincontrols-mainbar" id="id_12">
                                <nav class="il-mainbar" aria-label="mainbar_aria_label">
                                        <div class="il-mainbar-triggers">
                                                <div class="il-mainbar-entries" role="menubar" style="visibility: hidden">
                                                        <button class="btn btn-bulky" data-action="#" id="id_1" ><div class="icon custom small" aria-label=""><img src="" /></div><span class="bulky-label">TestEntry</span></button>
                                                        <button class="btn btn-bulky" data-action="#" id="id_2" ><div class="icon custom small" aria-label=""><img src="" /></div><span class="bulky-label">TestEntry</span></button>
                                                        <button class="btn btn-bulky" id="id_3" role="menuitem" aria-haspopup="true" ><div class="icon custom small" aria-label=""><img src="" /></div><span class="bulky-label">1</span></button>
                                                        <button class="btn btn-bulky" id="id_9" role="menuitem" aria-haspopup="true" ><span class="glyph" aria-label="show_more"><span class="glyphicon glyphicon-option-horizontal" aria-hidden="true"></span></span><span class="bulky-label">more</span></button>
                                                </div>
                                        </div>
                                </nav>

                                <div class="il-mainbar-slates">
                                        <div class="il-mainbar-tools-entries">
                                                <div class="il-mainbar-tools-entries-bg"></div>
                                        </div>
                                        <div class="il-maincontrols-slate disengaged" id="id_8" data-depth-level="1" role="menu">
                                                <div class="il-maincontrols-slate-content" data-replace-marker="content">
                                                        <button class="btn btn-bulky" id="id_4" ><div class="icon custom small" aria-label=""><img src="" /></div><span class="bulky-label">1.1</span></button>

                                                        <div class="il-maincontrols-slate disengaged" id="id_7" data-depth-level="2">
                                                                <div class="il-maincontrols-slate-content" data-replace-marker="content">
                                                                        <button class="btn btn-bulky" id="id_5" ><div class="icon custom small" aria-label=""><img src="" /></div><span class="bulky-label">1.1.1</span></button>

                                                                        <div class="il-maincontrols-slate disengaged" id="id_6" data-depth-level="3">
                                                                                <div class="il-maincontrols-slate-content" data-replace-marker="content"></div>
                                                                        </div>
                                                                </div>
                                                        </div>

                                                </div>
                                        </div>

                                        <div class="il-maincontrols-slate disengaged" id="id_10" data-depth-level="1" role="menu">
                                                <div class="il-maincontrols-slate-content" data-replace-marker="content"></div>
                                        </div>

                                        <div class="il-mainbar-close-slates">
                                                <button class="btn btn-bulky" id="id_11" ><span class="glyph" href="#" aria-label="back"><span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span></span><span class="bulky-label">close</span></button>
                                        </div>
                                </div>
                        </div>
EOT;

        $this->assertEquals(
            $this->brutallyTrimHTML($expected),
            $this->brutallyTrimHTML($html)
        );
    }
}