Skip to content

Propagates styles from bottom up #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 20, 2019
Merged

Propagates styles from bottom up #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
711805c
Propagates styles from bottom up
jtreminio Dec 20, 2019
3f6ae03
Adds test for multi-nested menu
jtreminio Dec 20, 2019
eede6bf
Adds test for multi-nested with custom style
jtreminio Dec 20, 2019
b57065d
Adds test for propagating styles to SplitItem + SubMenu
jtreminio Dec 20, 2019
6253477
CS fix
jtreminio Dec 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 31 additions & 12 deletions src/Builder/CliMenuBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,12 +188,6 @@ public function addSubMenu(string $text, \Closure $callback) : self
$menu = $builder->build();
$menu->setParent($this->menu);

//we apply the parent theme if nothing was changed
//if no styles were changed in this sub-menu
if (!$menu->getStyle()->hasChangedFromDefaults()) {
$menu->setStyle($this->menu->getStyle());
}

$this->menu->addItem($item = new MenuMenuItem(
$text,
$menu,
Expand All @@ -210,12 +204,6 @@ public function addSubMenuFromBuilder(string $text, CliMenuBuilder $builder) : s
$menu = $builder->build();
$menu->setParent($this->menu);

//we apply the parent theme if nothing was changed
//if no styles were changed in this sub-menu
if (!$menu->getStyle()->hasChangedFromDefaults()) {
$menu->setStyle($this->menu->getStyle());
}

$this->menu->addItem($item = new MenuMenuItem(
$text,
$menu,
Expand Down Expand Up @@ -556,6 +544,37 @@ public function build() : CliMenu
$this->style->setDisplaysExtra($this->itemsHaveExtra($this->menu->getItems()));
}

if (!$this->subMenu) {
$this->propagateStyles($this->menu);
}

return $this->menu;
}

/**
* Pass styles from current menu to sub-menu
* only if sub-menu style has not be customized
*/
private function propagateStyles(CliMenu $menu, array $items = [])
{
$currentItems = !empty($items) ? $items : $menu->getItems();

foreach ($currentItems as $item) {
// Apply current style to children, if they are not customized
if ($item instanceof MenuMenuItem) {
$subMenu = $item->getSubMenu();

if (!$subMenu->getStyle()->hasChangedFromDefaults()) {
$subMenu->setStyle(clone $menu->getStyle());
}

$this->propagateStyles($subMenu);
}

// Apply styles to SplitItem children using current $menu
if ($item instanceof SplitItem) {
$this->propagateStyles($menu, $item->getItems());
}
}
}
}
81 changes: 77 additions & 4 deletions test/Builder/CliMenuBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use PhpSchool\CliMenu\MenuItem\MenuMenuItem;
use PhpSchool\CliMenu\MenuItem\RadioItem;
use PhpSchool\CliMenu\MenuItem\SelectableItem;
use PhpSchool\CliMenu\MenuItem\SplitItem;
use PhpSchool\CliMenu\MenuItem\StaticItem;
use PhpSchool\Terminal\Terminal;
use PHPUnit\Framework\TestCase;
Expand Down Expand Up @@ -583,17 +584,89 @@ public function testSubMenuInheritsParentsStyle() : void
->expects($this->any())
->method('getWidth')
->will($this->returnValue(200));

$menu = (new CliMenuBuilder($terminal))
->setBackgroundColour('green')
->addSubMenu('My SubMenu', function (CliMenuBuilder $b) {
$b->addItem('Some Item', function () {
$b->addSubMenu('My SubSubMenu', function (CliMenuBuilder $b) {
$b->addItem('Some Item', function () {
});
});
})
->build();

self::assertSame('green', $menu->getItems()[0]->getSubMenu()->getStyle()->getBg());
self::assertSame($menu->getStyle(), $menu->getItems()[0]->getSubMenu()->getStyle());
/** @var CliMenu $subMenu1 */
$subMenu1 = $menu->getItems()[0]->getSubMenu();
/** @var CliMenu $subMenu2 */
$subMenu2 = $subMenu1->getItems()[0]->getSubMenu();

self::assertSame('green', $subMenu1->getStyle()->getBg());
self::assertEquals($menu->getStyle(), $subMenu1->getStyle());

self::assertSame('green', $subMenu2->getStyle()->getBg());
self::assertEquals($menu->getStyle(), $subMenu2->getStyle());
}

public function testSplitItemSubMenuInheritsParentsStyle() : void
{
$terminal = self::createMock(Terminal::class);
$terminal
->expects($this->any())
->method('getWidth')
->will($this->returnValue(200));

$menu = (new CliMenuBuilder($terminal))
->setBackgroundColour('green')
->addSplitItem(function (SplitItemBuilder $b) {
$b
->addItem('Item 1', function () {
})
->addSubMenu('Submenu 1', function (CliMenuBuilder $b) {
$b->addItem('Item 2', function () {
});
})
;
})
->build();

/** @var SplitItem $splitItem */
$splitItem = $menu->getItems()[0];
/** @var SelectableItem $selectableItem1 */
$selectableItem1 = $splitItem->getItems()[0];
/** @var CliMenu $subMenu */
$subMenu = $splitItem->getItems()[1]->getSubMenu();

self::assertSame('green', $subMenu->getStyle()->getBg());
self::assertEquals($menu->getStyle(), $subMenu->getStyle());
}

public function testSubMenuIgnoresParentsStyleIfCustomAndPassesToChildren() : void
{
$terminal = self::createMock(Terminal::class);
$terminal
->expects($this->any())
->method('getWidth')
->will($this->returnValue(200));

$menu = (new CliMenuBuilder($terminal))
->setBackgroundColour('green')
->addSubMenu('My SubMenu', function (CliMenuBuilder $b) {
$b->setBackgroundColour('yellow')
->addSubMenu('My SubSubMenu', function (CliMenuBuilder $b) {
$b->addItem('Some Item', function () {
});
});
})
->build();

/** @var CliMenu $subMenu1 */
$subMenu1 = $menu->getItems()[0]->getSubMenu();
/** @var CliMenu $subMenu2 */
$subMenu2 = $subMenu1->getItems()[0]->getSubMenu();

self::assertSame('green', $menu->getStyle()->getBg());
self::assertSame('yellow', $subMenu1->getStyle()->getBg());
self::assertSame('yellow', $subMenu2->getStyle()->getBg());
}

public function testSubMenuDoesNotInheritsParentsStyleWhenSubMenuStyleHasAlterations() : void
Expand Down