CliMenuBuilder::getTerminal() - Code Metrics - Inspection of "Add border styling" - php-school/cli-menu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#100)

unknown

created 2018-05-04 10:50 UTC

CliMenuBuilder::getTerminal() A

↳ Parent: CliMenuBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?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\StaticItem;
use PhpSchool\CliMenu\Terminal\TerminalFactory;
use Assert\Assertion;
use PhpSchool\Terminal\Terminal;
use RuntimeException;

/**
 * @author Michael Woodward <[email protected]>
 * @author Aydin Hassan <[email protected]>
 */
class CliMenuBuilder
{
    /**
     * @var bool
     */
    private $isBuilt = false;

    /**
     * @var null|self
     */
    private $parent;
    
    /**
     * @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)
    {
        $this->parent   = $parent;
        $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);

        }
        
        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;
    }

    /**
     * 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) : self
    {
        Assertion::inArray($colour, MenuStyle::getAvailableColours());

        $this->style['bg'] = $colour;

        return $this;
    }

    public function setForegroundColour(string $colour) : self
    {
        Assertion::inArray($colour, MenuStyle::getAvailableColours());

        $this->style['fg'] = $colour;

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    public function setMargin(int $margin) : self
    {
        $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 {
        $this->style->setBorder($topWidth, $rightWidth, $bottomWidth, $leftWidth, $colour);


        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
    {
        return (new MenuStyle($this->terminal))
            ->setFg($this->style['fg'])
            ->setBg($this->style['bg'])
            ->setWidth($this->style['width'])
            ->setPadding($this->style['padding'])
            ->setMargin($this->style['margin'])
            ->setSelectedMarker($this->style['selectedMarker'])
            ->setUnselectedMarker($this->style['unselectedMarker'])
            ->setItemExtra($this->style['itemExtra'])
            ->setDisplaysExtra($this->style['displaysExtra'])
            ->setTitleSeparator($this->style['titleSeparator']);
    }

    /**
     * Return to parent builder
     *
     * @throws RuntimeException
     */
    public function end() : CliMenuBuilder
    {
        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;
    }
}


1			<?php
2
3			namespace PhpSchool\CliMenu;
4
5			use PhpSchool\CliMenu\Action\ExitAction;
6			use PhpSchool\CliMenu\Action\GoBackAction;
7			use PhpSchool\CliMenu\MenuItem\AsciiArtItem;
8			use PhpSchool\CliMenu\MenuItem\LineBreakItem;
9			use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
10			use PhpSchool\CliMenu\MenuItem\MenuMenuItem;
11			use PhpSchool\CliMenu\MenuItem\SelectableItem;
12			use PhpSchool\CliMenu\MenuItem\StaticItem;
13			use PhpSchool\CliMenu\Terminal\TerminalFactory;
14			use Assert\Assertion;
15			use PhpSchool\Terminal\Terminal;
16			use RuntimeException;
17
18			/**
19			* @author Michael Woodward <[email protected]>
20			* @author Aydin Hassan <[email protected]>
21			*/
22			class CliMenuBuilder
23			{
24			/**
25			* @var bool
26			*/
27			private $isBuilt = false;
28
29			/**
30			* @var null\|self
31			*/
32			private $parent;
33
34			/**
35			* @var self[]
36			*/
37			private $subMenuBuilders = [];
38
39			/**
40			* @var CliMenu[]
41			*/
42			private $subMenus = [];
43
44			/**
45			* @var string
46			*/
47			private $goBackButtonText = 'Go Back';
48
49			/**
50			* @var string
51			*/
52			private $exitButtonText = 'Exit';
53
54			/**
55			* @var array
56			*/
57			private $menuItems = [];
58
59			/**
60			* @var array
61			*/
62			private $style;
63
64			/**
65			* @var Terminal
66			*/
67			private $terminal;
68
69			/**
70			* @var string
71			*/
72			private $menuTitle = null;
73
74			/**
75			* @var bool
76			*/
77			private $disableDefaultItems = false;
78
79			/**
80			* @var bool
81			*/
82			private $disabled = false;
83
84			public function __construct(CliMenuBuilder $parent = null)
85			{
86			$this->parent = $parent;
87			$this->terminal = $this->parent !== null
88			? $this->parent->getTerminal()
89			: TerminalFactory::fromSystem();
90			$this->style = MenuStyle::getDefaultStyleValues();
91			}
92
93			public function setTitle(string $title) : self
94			{
95			$this->menuTitle = $title;
96
97			return $this;
98			}
99
100			public function addMenuItem(MenuItemInterface $item) : self
101			{
102			$this->menuItems[] = $item;
103
104			return $this;
105			}
106
107			public function addItem(
108			string $text,
109			callable $itemCallable,
110			bool $showItemExtra = false,
111			bool $disabled = false
112			) : self {
113			$this->addMenuItem(new SelectableItem($text, $itemCallable, $showItemExtra, $disabled));
114
115			return $this;
116			}
117
118			public function addItems(array $items) : self
119			{
120			foreach ($items as $item) {
121			$this->addItem(...$item);
			0 ignored issues – show Bug introduced 2015-11-25 21:29 UTC by Report Bug Copy Issue Report The call to `addItem()` misses a required argument `$itemCallable`. This check looks for function calls that miss required arguments. Loading history...
122			}
123
124			return $this;
125			}
126
127			public function addStaticItem(string $text) : self
128			{
129			$this->addMenuItem(new StaticItem($text));
130
131			return $this;
132			}
133
134			public function addLineBreak(string $breakChar = ' ', int $lines = 1) : self
135			{
136			$this->addMenuItem(new LineBreakItem($breakChar, $lines));
137
138			return $this;
139			}
140
141			public function addAsciiArt(string $art, string $position = AsciiArtItem::POSITION_CENTER, string $alt = '') : self
142			{
143			$this->addMenuItem(new AsciiArtItem($art, $position, $alt));
144
145			return $this;
146			}
147
148			/**
149			* Add a submenu with a string identifier
150			*/
151			public function addSubMenu(string $id, CliMenuBuilder $subMenuBuilder = null) : CliMenuBuilder
152			{
153			$this->menuItems[] = $id;
154
155			if (null === $subMenuBuilder) {
156			$this->subMenuBuilders[$id] = new static($this);
157			return $this->subMenuBuilders[$id];
158			}
159
160			$this->subMenuBuilders[$id] = $subMenuBuilder;
161			return $this;
162			}
163
164			/**
165			* Disable a submenu
166			*
167			* @throws \InvalidArgumentException
168			*/
169			public function disableMenu() : self
170			{
171			if (!$this->parent) {
172			throw new \InvalidArgumentException(
173			'You can\'t disable the root menu'
174			);
175			}
176
177			$this->disabled = true;
178
179			return $this;
180			}
181
182			public function isMenuDisabled() : bool
183			{
184			return $this->disabled;
185			}
186
187			public function setGoBackButtonText(string $goBackButtonTest) : self
188			{
189			$this->goBackButtonText = $goBackButtonTest;
190
191			return $this;
192			}
193
194			public function setExitButtonText(string $exitButtonText) : self
195			{
196			$this->exitButtonText = $exitButtonText;
197
198			return $this;
199			}
200
201			public function setBackgroundColour(string $colour) : self
202			{
203			Assertion::inArray($colour, MenuStyle::getAvailableColours());
204
205			$this->style['bg'] = $colour;
206
207			return $this;
208			}
209
210			public function setForegroundColour(string $colour) : self
211			{
212			Assertion::inArray($colour, MenuStyle::getAvailableColours());
213
214			$this->style['fg'] = $colour;
215
216			return $this;
217			}
218
219			public function setWidth(int $width) : self
220			{
221			$this->style['width'] = $width;
222
223			return $this;
224			}
225
226			public function setPadding(int $padding) : self
227			{
228			$this->style['padding'] = $padding;
229
230			return $this;
231			}
232
233			public function setMargin(int $margin) : self
234			{
235			$this->style['margin'] = $margin;
236
237			return $this;
238			}
239
240			public function setUnselectedMarker(string $marker) : self
241			{
242			$this->style['unselectedMarker'] = $marker;
243
244			return $this;
245			}
246
247			public function setSelectedMarker(string $marker) : self
248			{
249			$this->style['selectedMarker'] = $marker;
250
251			return $this;
252			}
253
254			public function setItemExtra(string $extra) : self
255			{
256			$this->style['itemExtra'] = $extra;
257
258			return $this;
259			}
260
261			public function setTitleSeparator(string $separator) : self
262			{
263			$this->style['titleSeparator'] = $separator;
264
265			return $this;
266			}
267
268			public function setBorder(
269			int $topWidth,
270			$rightWidth = null,
271			$bottomWidth = null,
272			$leftWidth = null,
273			string $colour = null
274			) : self {
275			$this->style->setBorder($topWidth, $rightWidth, $bottomWidth, $leftWidth, $colour);
			0 ignored issues – show Bug introduced 2018-05-04 10:53 UTC by Report Bug Copy Issue Report The method `setBorder` cannot be called on `$this->style` (of type `array`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
276
277			return $this;
278			}
279
280			public function setTerminal(Terminal $terminal) : self
281			{
282			$this->terminal = $terminal;
283			return $this;
284			}
285
286			public function getTerminal() : Terminal
287			{
288			return $this->terminal;
289			}
290
291			private function getDefaultItems() : array
292			{
293			$actions = [];
294			if ($this->parent) {
295			$actions[] = new SelectableItem($this->goBackButtonText, new GoBackAction);
296			}
297
298			$actions[] = new SelectableItem($this->exitButtonText, new ExitAction);
299			return $actions;
300			}
301
302			public function disableDefaultItems() : self
303			{
304			$this->disableDefaultItems = true;
305
306			return $this;
307			}
308
309			private function itemsHaveExtra(array $items) : bool
310			{
311			return !empty(array_filter($items, function (MenuItemInterface $item) {
312			return $item->showsItemExtra();
313			}));
314			}
315
316			/**
317			* Recursively drop back to the parents menu style
318			* when the current menu has a parent and has no changes
319			*/
320			private function getMenuStyle() : MenuStyle
321			{
322			if (null === $this->parent) {
323			return $this->buildStyle();
324			}
325
326			if ($this->style !== MenuStyle::getDefaultStyleValues()) {
327			return $this->buildStyle();
328			}
329
330			return $this->parent->getMenuStyle();
331			}
332
333			private function buildStyle() : MenuStyle
334			{
335			return (new MenuStyle($this->terminal))
336			->setFg($this->style['fg'])
337			->setBg($this->style['bg'])
338			->setWidth($this->style['width'])
339			->setPadding($this->style['padding'])
340			->setMargin($this->style['margin'])
341			->setSelectedMarker($this->style['selectedMarker'])
342			->setUnselectedMarker($this->style['unselectedMarker'])
343			->setItemExtra($this->style['itemExtra'])
344			->setDisplaysExtra($this->style['displaysExtra'])
345			->setTitleSeparator($this->style['titleSeparator']);
346			}
347
348			/**
349			* Return to parent builder
350			*
351			* @throws RuntimeException
352			*/
353			public function end() : CliMenuBuilder
354			{
355			if (null === $this->parent) {
356			throw new RuntimeException('No parent builder to return to');
357			}
358
359			return $this->parent;
360			}
361
362			/**
363			* @throws RuntimeException
364			*/
365			public function getSubMenu(string $id) : CliMenu
366			{
367			if (false === $this->isBuilt) {
368			throw new RuntimeException(sprintf('Menu: "%s" cannot be retrieved until menu has been built', $id));
369			}
370
371			return $this->subMenus[$id];
372			}
373
374			private function buildSubMenus(array $items) : array
375			{
376			return array_map(function ($item) {
377			if (!is_string($item)) {
378			return $item;
379			}
380
381			$menuBuilder = $this->subMenuBuilders[$item];
382			$this->subMenus[$item] = $menuBuilder->build();
383
384			return new MenuMenuItem($item, $this->subMenus[$item], $menuBuilder->isMenuDisabled());
385			}, $items);
386			}
387
388			public function build() : CliMenu
389			{
390			$this->isBuilt = true;
391
392			$mergedItems = $this->disableDefaultItems
393			? $this->menuItems
394			: array_merge($this->menuItems, $this->getDefaultItems());
395
396			$menuItems = $this->buildSubMenus($mergedItems);
397
398			$this->style['displaysExtra'] = $this->itemsHaveExtra($menuItems);
399
400			$menu = new CliMenu(
401			$this->menuTitle,
402			$menuItems,
403			$this->terminal,
404			$this->getMenuStyle()
405			);
406
407			foreach ($this->subMenus as $subMenu) {
408			$subMenu->setParent($menu);
409			}
410
411			return $menu;
412			}
413			}
414

php-school / cli-menu

Pull Request — master (#100)

CliMenuBuilder::getTerminal() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like