PhpSchool\CliMenu\CliMenuBuilder

Complexity

Total Complexity

64

Size/Duplication

Total Lines	517
Duplicated Lines	6.19 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes

0

44 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	setTitle()	0	6	1
A	addMenuItem()	0	6	1
A	addItem()	0	10	1
A	addItems()	0	8	2
A	addStaticItem()	0	6	1
A	addLineBreak()	0	6	1
A	addAsciiArt()	0	6	1
A	addSubMenu()	0	12	2
A	injectSubMenu()	0	6	1
A	addSplitItem()	0	7	1
A	disableMenu()	0	12	2
A	isMenuDisabled()	0	4	1
A	setGoBackButtonText()	0	6	1
A	setExitButtonText()	0	6	1
A	setBackgroundColour()	0	10	1
A	setForegroundColour()	10	10	1
A	setWidth()	0	6	1
A	setPadding()	11	11	2
A	setPaddingTopBottom()	0	6	1
A	setPaddingLeftRight()	0	6	1
A	setMarginAuto()	0	6	1
A	setMargin()	0	7	1
A	setUnselectedMarker()	0	6	1
A	setSelectedMarker()	0	6	1
A	setItemExtra()	0	6	1
A	setTitleSeparator()	0	6	1
B	setBorder()	11	32	6
A	setBorderTopWidth()	0	6	1
A	setBorderRightWidth()	0	6	1
A	setBorderBottomWidth()	0	6	1
A	setBorderLeftWidth()	0	6	1
A	setBorderColour()	0	7	1
A	setTerminal()	0	5	1
A	getTerminal()	0	4	1
A	getDefaultItems()	0	10	2
A	disableDefaultItems()	0	6	1
A	itemsHaveExtra()	0	6	1
A	getMenuStyle()	0	12	3
A	buildStyle()	0	23	2
A	end()	0	12	3
A	getSubMenu()	0	8	2
A	buildSubMenus()	0	13	2
B	build()	0	25	3

<?php

namespace PhpSchool\CliMenu;

use PhpSchool\CliMenu\Action\ExitAction;
use PhpSchool\CliMenu\Action\GoBackAction;
use PhpSchool\CliMenu\MenuItem\AsciiArtItem;
use PhpSchool\CliMenu\MenuItem\LineBreakItem;
use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
use PhpSchool\CliMenu\MenuItem\MenuMenuItem;
use PhpSchool\CliMenu\MenuItem\SelectableItem;
use PhpSchool\CliMenu\MenuItem\SplitItem;
use PhpSchool\CliMenu\MenuItem\StaticItem;
use PhpSchool\CliMenu\Terminal\TerminalFactory;
use PhpSchool\CliMenu\Util\ColourUtil;
use PhpSchool\Terminal\Terminal;
use RuntimeException;

/**
 * @author Michael Woodward <mikeymike.mw@gmail.com>
 * @author Aydin Hassan <aydin@hotmail.com>
 */
class CliMenuBuilder
{
    /**
     * @var bool
     */
    private $isBuilt = false;

    /**
     * @var null|self
     */
    private $parent;

    private $previousBuilder = null;

    /**
     * @var self[]
     */
    private $subMenuBuilders = [];

    /**
     * @var CliMenu[]
     */
    private $subMenus = [];

    /**
     * @var string
     */
    private $goBackButtonText = 'Go Back';

    /**
     * @var string
     */
    private $exitButtonText = 'Exit';

    /**
     * @var array
     */
    private $menuItems = [];

    /**
     * @var array
     */
    private $style;

    /**
     * @var Terminal
     */
    private $terminal;

    /**
     * @var string
     */
    private $menuTitle = null;

    /**
     * @var bool
     */
    private $disableDefaultItems = false;

    /**
     * @var bool
     */
    private $disabled = false;

    public function __construct(CliMenuBuilder $parent = null, $previousBuilder = null)
    {
        $this->parent   = $parent;
        $this->previousBuilder = $previousBuilder;
        $this->terminal = $this->parent !== null
            ? $this->parent->getTerminal()
            : TerminalFactory::fromSystem();
        $this->style    = MenuStyle::getDefaultStyleValues();
    }

    public function setTitle(string $title) : self
    {
        $this->menuTitle = $title;

        return $this;
    }

    public function addMenuItem(MenuItemInterface $item) : self
    {
        $this->menuItems[] = $item;

        return $this;
    }

    public function addItem(
        string $text,
        callable $itemCallable,
        bool $showItemExtra = false,
        bool $disabled = false
    ) : self {
        $this->addMenuItem(new SelectableItem($text, $itemCallable, $showItemExtra, $disabled));

        return $this;
    }

    public function addItems(array $items) : self
    {
        foreach ($items as $item) {
            $this->addItem(...$item);

The call to addItem() misses a required argument $itemCallable.

        }

        return $this;
    }

    public function addStaticItem(string $text) : self
    {
        $this->addMenuItem(new StaticItem($text));

        return $this;
    }

    public function addLineBreak(string $breakChar = ' ', int $lines = 1) : self
    {
        $this->addMenuItem(new LineBreakItem($breakChar, $lines));

        return $this;
    }

    public function addAsciiArt(string $art, string $position = AsciiArtItem::POSITION_CENTER, string $alt = '') : self
    {
        $this->addMenuItem(new AsciiArtItem($art, $position, $alt));

        return $this;
    }

    /**
     * Add a submenu with a string identifier
     */
    public function addSubMenu(string $id, CliMenuBuilder $subMenuBuilder = null) : CliMenuBuilder
    {
        $this->menuItems[]  = $id;

        if (null === $subMenuBuilder) {
            $this->subMenuBuilders[$id] = new static($this);
            return $this->subMenuBuilders[$id];
        }

        $this->subMenuBuilders[$id] = $subMenuBuilder;
        return $this;
    }

    /**
     * Injects a submenu directly (without going through the builder
     */
    public function injectSubMenu(string $id, CliMenu $subMenu) : CliMenuBuilder
    {
        $this->subMenus[$id] = $subMenu;

        return $this;
    }

    /**
     * Add a split item
     */
    public function addSplitItem() : SplitItem
    {
        $splitItem = new SplitItem($this);
        $this->addMenuItem($splitItem);

        return $splitItem;
    }

    /**
     * Disable a submenu
     *
     * @throws \InvalidArgumentException
     */
    public function disableMenu() : self
    {
        if (!$this->parent) {
            throw new \InvalidArgumentException(
                'You can\'t disable the root menu'
            );
        }

        $this->disabled = true;

        return $this;
    }

    public function isMenuDisabled() : bool
    {
        return $this->disabled;
    }

    public function setGoBackButtonText(string $goBackButtonTest) : self
    {
        $this->goBackButtonText = $goBackButtonTest;

        return $this;
    }

    public function setExitButtonText(string $exitButtonText) : self
    {
        $this->exitButtonText = $exitButtonText;

        return $this;
    }

    public function setBackgroundColour(string $colour, string $fallback = null) : self
    {
        $this->style['bg'] = ColourUtil::validateColour(
            $this->terminal,
            $colour,
            $fallback
        );

        return $this;
    }

    public function setForegroundColour(string $colour, string $fallback = null) : self

This method seems to be duplicated in your project.

    {
        $this->style['fg'] = ColourUtil::validateColour(
            $this->terminal,
            $colour,
            $fallback
        );

        return $this;
    }

    public function setWidth(int $width) : self
    {
        $this->style['width'] = $width;

        return $this;
    }

    public function setPadding(int $topBottom, int $leftRight = null) : self

This method seems to be duplicated in your project.

    {
        if ($leftRight === null) {
            $leftRight = $topBottom;
        }

        $this->setPaddingTopBottom($topBottom);
        $this->setPaddingLeftRight($leftRight);

        return $this;
    }

    public function setPaddingTopBottom(int $topBottom) : self
    {
        $this->style['paddingTopBottom'] = $topBottom;

        return $this;
    }

    public function setPaddingLeftRight(int $leftRight) : self
    {
        $this->style['paddingLeftRight'] = $leftRight;

        return $this;
    }

    public function setMarginAuto() : self
    {
        $this->style['marginAuto'] = true;

        return $this;
    }

    public function setMargin(int $margin) : self
    {
        $this->style['marginAuto'] = false;
        $this->style['margin'] = $margin;

        return $this;
    }

    public function setUnselectedMarker(string $marker) : self
    {
        $this->style['unselectedMarker'] = $marker;

        return $this;
    }

    public function setSelectedMarker(string $marker) : self
    {
        $this->style['selectedMarker'] = $marker;

        return $this;
    }

    public function setItemExtra(string $extra) : self
    {
        $this->style['itemExtra'] = $extra;

        return $this;
    }

    public function setTitleSeparator(string $separator) : self
    {
        $this->style['titleSeparator'] = $separator;

        return $this;
    }

    public function setBorder(
        int $topWidth,
        $rightWidth = null,
        $bottomWidth = null,
        $leftWidth = null,
        string $colour = null
    ) : self {
        if (!is_int($rightWidth)) {

This code seems to be duplicated across your project.

            $colour = $rightWidth;
            $rightWidth = $bottomWidth = $leftWidth = $topWidth;
        } elseif (!is_int($bottomWidth)) {
            $colour = $bottomWidth;
            $bottomWidth = $topWidth;
            $leftWidth = $rightWidth;
        } elseif (!is_int($leftWidth)) {
            $colour = $leftWidth;
            $leftWidth = $rightWidth;
        }

        $this->style['borderTopWidth'] = $topWidth;
        $this->style['borderRightWidth'] = $rightWidth;
        $this->style['borderBottomWidth'] = $bottomWidth;
        $this->style['borderLeftWidth'] = $leftWidth;

        if (is_string($colour)) {
            $this->style['borderColour'] = $colour;
        } elseif ($colour !== null) {
            throw new \InvalidArgumentException('Invalid colour');
        }

        return $this;
    }

    public function setBorderTopWidth(int $width) : self
    {
        $this->style['borderTopWidth'] = $width;
        
        return $this;
    }

    public function setBorderRightWidth(int $width) : self
    {
        $this->style['borderRightWidth'] = $width;

        return $this;
    }

    public function setBorderBottomWidth(int $width) : self
    {
        $this->style['borderBottomWidth'] = $width;

        return $this;
    }

    public function setBorderLeftWidth(int $width) : self
    {
        $this->style['borderLeftWidth'] = $width;

        return $this;
    }

    public function setBorderColour(string $colour, $fallback = null) : self
    {
        $this->style['borderColour'] = $colour;
        $this->style['borderColourFallback'] = $fallback;

        return $this;
    }

    public function setTerminal(Terminal $terminal) : self
    {
        $this->terminal = $terminal;
        return $this;
    }

    public function getTerminal() : Terminal
    {
        return $this->terminal;
    }

    private function getDefaultItems() : array
    {
        $actions = [];
        if ($this->parent) {
            $actions[] = new SelectableItem($this->goBackButtonText, new GoBackAction);
        }

        $actions[] = new SelectableItem($this->exitButtonText, new ExitAction);
        return $actions;
    }

    public function disableDefaultItems() : self
    {
        $this->disableDefaultItems = true;

        return $this;
    }

    private function itemsHaveExtra(array $items) : bool
    {
        return !empty(array_filter($items, function (MenuItemInterface $item) {
            return $item->showsItemExtra();
        }));
    }

    /**
     * Recursively drop back to the parents menu style
     * when the current menu has a parent and has no changes
     */
    private function getMenuStyle() : MenuStyle
    {
        if (null === $this->parent) {
            return $this->buildStyle();
        }

        if ($this->style !== MenuStyle::getDefaultStyleValues()) {
            return $this->buildStyle();
        }

        return $this->parent->getMenuStyle();
    }

    private function buildStyle() : MenuStyle
    {
        $style = (new MenuStyle($this->terminal))
            ->setFg($this->style['fg'])
            ->setBg($this->style['bg'])
            ->setWidth($this->style['width'])
            ->setPaddingTopBottom($this->style['paddingTopBottom'])
            ->setPaddingLeftRight($this->style['paddingLeftRight'])
            ->setSelectedMarker($this->style['selectedMarker'])
            ->setUnselectedMarker($this->style['unselectedMarker'])
            ->setItemExtra($this->style['itemExtra'])
            ->setDisplaysExtra($this->style['displaysExtra'])
            ->setTitleSeparator($this->style['titleSeparator'])
            ->setBorderTopWidth($this->style['borderTopWidth'])
            ->setBorderRightWidth($this->style['borderRightWidth'])
            ->setBorderBottomWidth($this->style['borderBottomWidth'])
            ->setBorderLeftWidth($this->style['borderLeftWidth'])
            ->setBorderColour($this->style['borderColour'], $this->style['borderColourFallback']);

        $this->style['marginAuto'] ? $style->setMarginAuto() : $style->setMargin($this->style['margin']);

        return $style;
    }

    /**
     * Return to parent builder
     *
     * @throws RuntimeException
     */
    public function end()
    {
        if (null !== $this->previousBuilder) {
            return $this->previousBuilder;
        }

        if (null === $this->parent) {
            throw new RuntimeException('No parent builder to return to');
        }

        return $this->parent;
    }

    /**
     * @throws RuntimeException
     */
    public function getSubMenu(string $id) : CliMenu
    {
        if (false === $this->isBuilt) {
            throw new RuntimeException(sprintf('Menu: "%s" cannot be retrieved until menu has been built', $id));
        }

        return $this->subMenus[$id];
    }

    private function buildSubMenus(array $items) : array
    {
        return array_map(function ($item) {
            if (!is_string($item)) {
                return $item;
            }

            $menuBuilder           = $this->subMenuBuilders[$item];
            $this->subMenus[$item] = $menuBuilder->build();

            return new MenuMenuItem($item, $this->subMenus[$item], $menuBuilder->isMenuDisabled());
        }, $items);
    }

    public function build() : CliMenu
    {
        $this->isBuilt = true;

        $mergedItems = $this->disableDefaultItems
            ? $this->menuItems
            : array_merge($this->menuItems, $this->getDefaultItems());

        $menuItems = $this->buildSubMenus($mergedItems);

        $this->style['displaysExtra'] = $this->itemsHaveExtra($menuItems);

        $menu = new CliMenu(
            $this->menuTitle,
            $menuItems,
            $this->terminal,
            $this->getMenuStyle()
        );

        foreach ($this->subMenus as $subMenu) {
            $subMenu->setParent($menu);
        }

        return $menu;
    }
}