ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
FieldLeafNodeTest.php
Go to the documentation of this file.
1<?php
2
18declare(strict_types=1);
19
20use ILIAS\UI\Component\Input\Field\Node\NodeRetrieval;
21use ILIAS\UI\Implementation\Render\JavaScriptBinding;
22use ILIAS\UI\Implementation\Component\Input\Field;
23use ILIAS\UI\Implementation\Component;
24use PHPUnit\Framework\MockObject\MockObject;
25
26require_once(__DIR__ . "/../../../../../../../../vendor/composer/vendor/autoload.php");
27require_once(__DIR__ . "/../../../../Base.php");
28
32class FieldLeafNodeTest extends \ILIAS_UI_TestBase
33{
34 protected Component\Symbol\Glyph\Glyph & MockObject $glyph_stub;
35 protected string $glyph_html;
36 protected Component\Symbol\Icon\Icon & MockObject $icon_stub;
37 protected string $icon_html;
38
39 protected Component\Symbol\Glyph\Factory & MockObject $glyph_factory;
40 protected Component\Symbol\Icon\Factory & MockObject $icon_factory;
41 protected Component\Symbol\Factory & MockObject $symbol_factory;
42
43 protected function setUp(): void
44 {
45 [$this->glyph_stub, $this->glyph_html] = $this->getGlyphStub();
46 [$this->icon_stub, $this->icon_html] = $this->getIconStub();
47
48 $this->glyph_factory = $this->createMock(Component\Symbol\Glyph\Factory::class);
49 $this->glyph_factory->method($this->anything())->willReturn($this->glyph_stub);
50
51 $this->icon_factory = $this->createMock(Component\Symbol\Icon\Factory::class);
52 $this->icon_factory->method('standard')->willReturn($this->icon_stub);
53
54 $this->symbol_factory = $this->createMock(Component\Symbol\Factory::class);
55 $this->symbol_factory->method('glyph')->willReturn($this->glyph_factory);
56 $this->symbol_factory->method('icon')->willReturn($this->icon_factory);
57
58 parent::setUp();
59 }
60
61 public function getDefaultRenderer(
62 ?JavaScriptBinding $js_binding = null,
63 array $with_stub_renderings = [],
64 array $with_additional_contexts = [],
65 ): TestDefaultRenderer {
66 $with_stub_renderings = array_merge($with_stub_renderings, [
67 $this->glyph_stub,
68 $this->icon_stub,
69 ]);
70
71 return parent::getDefaultRenderer($js_binding, $with_stub_renderings, $with_additional_contexts);
72 }
73
74 public function getUIFactory(): \NoUIFactory
75 {
76 return new class ($this->symbol_factory) extends \NoUIFactory {
77 public function __construct(
78 protected Component\Symbol\Factory $symbol_factory,
79 ) {
80 }
81 public function symbol(): Component\Symbol\Factory
82 {
83 return $this->symbol_factory;
84 }
85 };
86 }
87
88 public function testRender(): void
89 {
90 $node_id = 'some-existing-node-id';
91 $node_name = 'some existing node name';
92
93 $component = $this->getNodeFactory()->leaf($node_id, $node_name);
94 $renderer = $this->getDefaultRenderer();
95
96 $expected = <<<HTML
97<li data-node-id="$node_id" class="c-input-node c-input-node__leaf c-drilldown__leaf">
98 <p class="il-link link-bulky c-input-node__name" tabindex="0">
99 $this->icon_html<span data-node-name>$node_name</span>
100 </p>
101 <button type="button" class="c-input-node__select" aria-label="select_node">
102 <span data-action="select">$this->glyph_html</span>
103 <span class="hidden" data-action="remove">$this->glyph_html</span>
104 </button>
105</li>
106HTML;
107
108 $actual = $renderer->render($component);
109
110 $this->assertEquals(
111 $this->brutallyTrimHTML($expected),
112 $this->brutallyTrimHTML($actual),
113 );
114 }
115
116 protected function testRenderWithIcon(): void
117 {
118 [$icon_stub, $icon_html] = $this->createSimpleRenderingStub(Component\Symbol\Icon\Custom::class);
119
120 $component = $this->getNodeFactory()->leaf('', '');
121 $renderer = $this->getDefaultRenderer(null, [$icon_stub]);
122
123 $actual = $renderer->render($component);
124
125 $this->assertTrue(str_contains($actual, $icon_html));
126 }
127
128 public function testRenderWithoutIcon(): void
129 {
130 $first_node_name_letter = 's';
131 $node_name = "{$first_node_name_letter}ome existing node name";
132
133 $this->icon_factory->expects($this->once())->method('standard');
134 $this->icon_stub->expects($this->once())->method('withAbbreviation')->with($first_node_name_letter);
135
136 $component = $this->getNodeFactory()->leaf('', $node_name);
137 $renderer = $this->getDefaultRenderer();
138
139 $actual = $renderer->render($component);
140
141 $this->assertTrue(str_contains($actual, $this->icon_html));
142 }
143
144 protected function getNodeFactory(): Field\Node\Factory
145 {
146 return new Field\Node\Factory();
147 }
148
150 protected function getGlyphStub(): array
151 {
152 return $this->createSimpleRenderingStub(Component\Symbol\Glyph\Glyph::class);
153 }
154
156 protected function getIconStub(): array
157 {
158 return $this->createSimpleRenderingStub(Component\Symbol\Icon\Standard::class);
159 }
160
162 protected function createSimpleRenderingStub(string $class_name): array
163 {
164 $stub = $this->createMock($class_name);
165 $html = sha1($class_name);
166 $stub->method('getCanonicalName')->willReturn($html);
167 $stub->method($this->anything())->willReturnSelf();
168 return [$stub, $html];
169 }
170}
$renderer
$renderer
Definition: build_bootstrap.php:83
FieldLeafNodeTest\$icon_factory
Component Symbol Icon Factory &MockObject $icon_factory
Definition: FieldLeafNodeTest.php:40
FieldLeafNodeTest\createSimpleRenderingStub
createSimpleRenderingStub(string $class_name)
Definition: FieldLeafNodeTest.php:162
FieldLeafNodeTest\$icon_stub
Component Symbol Icon Icon &MockObject $icon_stub
Definition: FieldLeafNodeTest.php:36
FieldLeafNodeTest\$symbol_factory
Component Symbol Factory &MockObject $symbol_factory
Definition: FieldLeafNodeTest.php:41
FieldLeafNodeTest\$glyph_factory
Component Symbol Glyph Factory &MockObject $glyph_factory
Definition: FieldLeafNodeTest.php:39
FieldLeafNodeTest\$glyph_stub
Component Symbol Glyph Glyph &MockObject $glyph_stub
Definition: FieldLeafNodeTest.php:34
FieldLeafNodeTest\getDefaultRenderer
getDefaultRenderer(?JavaScriptBinding $js_binding=null, array $with_stub_renderings=[], array $with_additional_contexts=[],)
Definition: FieldLeafNodeTest.php:61
ILIAS\Data\DateFormat\Factory
Factory for Date Formats.
Definition: Factory.php:27
ILIAS_UI_TestBase
Provides common functionality for UI tests.
Definition: Base.php:337
ILIAS\UI\Component\Input\Field\Factory
This is what a factory for input fields looks like.
Definition: Factory.php:31
ILIAS\UI\Component\Symbol\Symbol
This describes a symbol.
Definition: Symbol.php:30
ILIAS\UI\Implementation\Render\JavaScriptBinding
Provides methods to interface with javascript.
Definition: JavaScriptBinding.php:27
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:38
ILIAS\Repository\button
button(string $caption, string $cmd)
Definition: trait.GlobalDICGUIServices.php:194
ILIAS\UI\Implementation\Component\Input\Field
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Checkbox.php:21