SplitItem::getGutter() - Code Metrics - Inspection of "Refactors for ItemStyles" - php-school/cli-menu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#230)

by Aydin

created 2020-02-15 18:47 UTC

SplitItem::getGutter() A

↳ Parent: SplitItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace PhpSchool\CliMenu\MenuItem;

use Assert\Assertion;
use PhpSchool\CliMenu\CliMenu;
use PhpSchool\CliMenu\MenuStyle;
use PhpSchool\CliMenu\Style\DefaultStyle;
use PhpSchool\CliMenu\Style\ItemStyle;
use PhpSchool\CliMenu\Style\Selectable;
use PhpSchool\CliMenu\Util\StringUtil;
use function PhpSchool\CliMenu\Util\each;
use function PhpSchool\CliMenu\Util\mapWithKeys;
use function PhpSchool\CliMenu\Util\max;

/**
 * @author Michael Woodward <[email protected]>
 */
class SplitItem implements MenuItemInterface, PropagatesStyles
{
    /**
     * @var array
     */
    private $items = [];

    /**
     * @var int|null
     */
    private $selectedItemIndex;

    /**
     * @var bool
     */
    private $canBeSelected = true;

    /**
     * @var int
     */
    private $gutter = 2;

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

    /**
     * @var array
     */
    private static $blacklistedItems = [
        \PhpSchool\CliMenu\MenuItem\AsciiArtItem::class,
        \PhpSchool\CliMenu\MenuItem\LineBreakItem::class,
        \PhpSchool\CliMenu\MenuItem\SplitItem::class,
    ];

    public function __construct(array $items = [])
    {
        $this->addItems($items);
        $this->setDefaultSelectedItem();

        $this->style = new DefaultStyle();
    }

    public function getGutter() : int
    {
        return $this->gutter;
    }

    public function setGutter(int $gutter) : void
    {
        Assertion::greaterOrEqualThan($gutter, 0);
        $this->gutter = $gutter;
    }

    public function addItem(MenuItemInterface $item) : self
    {
        foreach (self::$blacklistedItems as $bl) {
            if ($item instanceof $bl) {
                throw new \InvalidArgumentException("Cannot add a $bl to a SplitItem");
            }
        }
        $this->items[] = $item;
        $this->setDefaultSelectedItem();
        return $this;
    }

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

    public function setItems(array $items) : self
    {
        $this->items = [];
        $this->addItems($items);
        return $this;
    }

    /**
     * Select default item
     */
    private function setDefaultSelectedItem() : void
    {
        foreach ($this->items as $index => $item) {
            if ($item->canSelect()) {
                $this->canBeSelected = true;
                $this->selectedItemIndex = $index;
                return;
            }
        }

        $this->canBeSelected = false;
        $this->selectedItemIndex = null;
    }

    /**
     * The output text for the item
     */
    public function getRows(MenuStyle $style, bool $selected = false) : array
    {
        $numberOfItems = count($this->items);

        if ($numberOfItems === 0) {
            throw new \RuntimeException(sprintf('There should be at least one item added to: %s', __CLASS__));
        }
        
        if (!$selected) {
            $this->setDefaultSelectedItem();
        }

        $largestItemExtra = $this->calculateItemExtra();

        $length = $largestItemExtra > 0
            ? floor($style->getContentWidth() / $numberOfItems) - ($largestItemExtra + 2)
            : floor($style->getContentWidth() / $numberOfItems);

        $length -= $this->gutter;
        $length = (int) $length;

        $missingLength = $style->getContentWidth() % $numberOfItems;
        
        return $this->buildRows(
            mapWithKeys($this->items, function (int $index, MenuItemInterface $item) use ($selected, $length, $style) {
                $isSelected = $selected && $index === $this->selectedItemIndex;

                $marker = '';
                if ($item->canSelect()) {
                    $marker = $item->getStyle()->getMarker($item, $isSelected);
                }

                $itemExtra = '';
                if ($item->getStyle()->getDisplaysExtra()) {
                    $itemExtraVal = $item->getStyle()->getItemExtra();
                    $itemExtra = $item->showsItemExtra()
                        ? sprintf('  %s', $itemExtraVal)
                        : sprintf('  %s', str_repeat(' ', mb_strlen($itemExtraVal)));
                }

                return $this->buildCell(
                    explode(
                        "\n",
                        StringUtil::wordwrap(
                            sprintf('%s%s', $marker, $item->getText()),
                            $length,
                            sprintf("\n%s", str_repeat(' ', mb_strlen($marker)))
                        )
                    ),
                    $length,
                    $style,
                    $isSelected,
                    $itemExtra
                );
            }),
            $missingLength,
            $length,
            $largestItemExtra
        );
    }

    private function buildRows(array $cells, int $missingLength, int $length, int $largestItemExtra) : array
    {
        $extraPadLength = $largestItemExtra > 0 ? 2 + $largestItemExtra : 0;
        
        return array_map(
            function ($i) use ($cells, $length, $missingLength, $extraPadLength) {
                return $this->buildRow($cells, $i, $length, $missingLength, $extraPadLength);
            },
            range(0, max(array_map('count', $cells)) - 1)
        );
    }

    private function buildRow(array $cells, int $index, int $length, int $missingLength, int $extraPadLength) : string
    {
        return sprintf(
            '%s%s',
            implode(
                '',
                array_map(
                    function ($cell) use ($index, $length, $extraPadLength) {
                        return $cell[$index] ?? str_repeat(' ', $length + $this->gutter + $extraPadLength);
                    },
                    $cells
                )
            ),
            str_repeat(' ', $missingLength)
        );
    }

    private function buildCell(
        array $content,
        int $length,
        MenuStyle $style,
        bool $isSelected,
        string $itemExtra
    ) : array {
        return array_map(function ($row, $index) use ($length, $style, $isSelected, $itemExtra) {
            $invertedColoursSetCode = $isSelected
                ? $style->getInvertedColoursSetCode()
                : '';
            $invertedColoursUnsetCode = $isSelected
                ? $style->getInvertedColoursUnsetCode()
                : '';

            return sprintf(
                '%s%s%s%s%s%s',
                $invertedColoursSetCode,
                $row,
                str_repeat(' ', $length - mb_strlen($row)),
                $index === 0 ? $itemExtra : str_repeat(' ', mb_strlen($itemExtra)),
                $invertedColoursUnsetCode,
                str_repeat(' ', $this->gutter)
            );
        }, $content, array_keys($content));
    }

    /**
     * Is there an item with this index and can it be
     * selected?
     */
    public function canSelectIndex(int $index) : bool
    {
        return isset($this->items[$index]) && $this->items[$index]->canSelect();
    }

    /**
     * Set the item index which should be selected. If the item does
     * not exist then throw an exception.
     */
    public function setSelectedItemIndex(int $index) : void
    {
        if (!isset($this->items[$index])) {
            throw new \InvalidArgumentException(sprintf('Index: "%s" does not exist', $index));
        }
        
        $this->selectedItemIndex = $index;
    }

    /**
     * Get the currently select item index.
     * May be null in case of no selectable item.
     */
    public function getSelectedItemIndex() : ?int
    {
        return $this->selectedItemIndex;
    }

    /**
     * Get the currently selected item - if no items are selectable
     * then throw an exception.
     */
    public function getSelectedItem() : MenuItemInterface
    {
        if (null === $this->selectedItemIndex) {
            throw new \RuntimeException('No item is selected');
        }
        
        return $this->items[$this->selectedItemIndex];
    }

    public function getItems() : array
    {
        return $this->items;
    }

    /**
     * Can the item be selected
     * In this case, it indicates if at least 1 item inside the SplitItem can be selected
     */
    public function canSelect() : bool
    {
        return $this->canBeSelected;
    }

    /**
     * Execute the items callable if required
     */
    public function getSelectAction() : ?callable
    {
        return null;
    }

    /**
     * Whether or not the menu item is showing the menustyle extra value
     */
    public function showsItemExtra() : bool
    {
        return false;
    }

    /**
     * Enable showing item extra
     */
    public function showItemExtra() : void
    {
        //noop
    }

    /**
     * Disable showing item extra
     */
    public function hideItemExtra() : void
    {
        //noop
    }

    /**
     * Nothing to return with SplitItem
     */
    public function getText() : string
    {
        throw new \BadMethodCallException(sprintf('Not supported on: %s', __CLASS__));
    }

    /**
     * Finds largest itemExtra value in items
     */
    private function calculateItemExtra() : int
    {
        return max(array_map(
            function (MenuItemInterface $item) {
                return mb_strlen($item->getStyle()->getItemExtra());
            },
            array_filter($this->items, function (MenuItemInterface $item) {
                return $item->getStyle()->getDisplaysExtra();
            })
        ));
    }

    /**
     * @return DefaultStyle
     */
    public function getStyle(): ItemStyle
    {
        return $this->style;
    }

    public function setStyle(DefaultStyle $style): void
    {
        $this->style = $style;
    }

    /**
     * @inheritDoc
     */
    public function propagateStyles(CliMenu $parent): void
    {
        each(
            array_filter($this->getItems(), function (MenuItemInterface $item) {
                return !$item->getStyle()->hasChangedFromDefaults();
            }),
            function ($index, $item) use ($parent) {
                $item->setStyle(clone $parent->getItemStyleForItem($item));
            }
        );

        each(
            array_filter($this->getItems(), function (MenuItemInterface $item) {
                return $item instanceof PropagatesStyles;
            }),
            function ($index, PropagatesStyles $item) use ($parent) {
                $item->propagateStyles($parent);
            }
        );
    }
}


1			<?php
2
3			namespace PhpSchool\CliMenu\MenuItem;
4
5			use Assert\Assertion;
6			use PhpSchool\CliMenu\CliMenu;
7			use PhpSchool\CliMenu\MenuStyle;
8			use PhpSchool\CliMenu\Style\DefaultStyle;
9			use PhpSchool\CliMenu\Style\ItemStyle;
10			use PhpSchool\CliMenu\Style\Selectable;
11			use PhpSchool\CliMenu\Util\StringUtil;
12			use function PhpSchool\CliMenu\Util\each;
13			use function PhpSchool\CliMenu\Util\mapWithKeys;
14			use function PhpSchool\CliMenu\Util\max;
15
16			/**
17			* @author Michael Woodward <[email protected]>
18			*/
19			class SplitItem implements MenuItemInterface, PropagatesStyles
20			{
21			/**
22			* @var array
23			*/
24			private $items = [];
25
26			/**
27			* @var int\|null
28			*/
29			private $selectedItemIndex;
30
31			/**
32			* @var bool
33			*/
34			private $canBeSelected = true;
35
36			/**
37			* @var int
38			*/
39			private $gutter = 2;
40
41			/**
42			* @var DefaultStyle
43			*/
44			private $style;
45
46			/**
47			* @var array
48			*/
49			private static $blacklistedItems = [
50			\PhpSchool\CliMenu\MenuItem\AsciiArtItem::class,
51			\PhpSchool\CliMenu\MenuItem\LineBreakItem::class,
52			\PhpSchool\CliMenu\MenuItem\SplitItem::class,
53			];
54
55			public function __construct(array $items = [])
56			{
57			$this->addItems($items);
58			$this->setDefaultSelectedItem();
59
60			$this->style = new DefaultStyle();
61			}
62
63			public function getGutter() : int
64			{
65			return $this->gutter;
66			}
67
68			public function setGutter(int $gutter) : void
69			{
70			Assertion::greaterOrEqualThan($gutter, 0);
71			$this->gutter = $gutter;
72			}
73
74			public function addItem(MenuItemInterface $item) : self
75			{
76			foreach (self::$blacklistedItems as $bl) {
77			if ($item instanceof $bl) {
78			throw new \InvalidArgumentException("Cannot add a $bl to a SplitItem");
79			}
80			}
81			$this->items[] = $item;
82			$this->setDefaultSelectedItem();
83			return $this;
84			}
85
86			public function addItems(array $items) : self
87			{
88			foreach ($items as $item) {
89			$this->addItem($item);
90			}
91
92			return $this;
93			}
94
95			public function setItems(array $items) : self
96			{
97			$this->items = [];
98			$this->addItems($items);
99			return $this;
100			}
101
102			/**
103			* Select default item
104			*/
105			private function setDefaultSelectedItem() : void
106			{
107			foreach ($this->items as $index => $item) {
108			if ($item->canSelect()) {
109			$this->canBeSelected = true;
110			$this->selectedItemIndex = $index;
111			return;
112			}
113			}
114
115			$this->canBeSelected = false;
116			$this->selectedItemIndex = null;
117			}
118
119			/**
120			* The output text for the item
121			*/
122			public function getRows(MenuStyle $style, bool $selected = false) : array
123			{
124			$numberOfItems = count($this->items);
125
126			if ($numberOfItems === 0) {
127			throw new \RuntimeException(sprintf('There should be at least one item added to: %s', __CLASS__));
128			}
129
130			if (!$selected) {
131			$this->setDefaultSelectedItem();
132			}
133
134			$largestItemExtra = $this->calculateItemExtra();
135
136			$length = $largestItemExtra > 0
137			? floor($style->getContentWidth() / $numberOfItems) - ($largestItemExtra + 2)
138			: floor($style->getContentWidth() / $numberOfItems);
139
140			$length -= $this->gutter;
141			$length = (int) $length;
142
143			$missingLength = $style->getContentWidth() % $numberOfItems;
144
145			return $this->buildRows(
146			mapWithKeys($this->items, function (int $index, MenuItemInterface $item) use ($selected, $length, $style) {
147			$isSelected = $selected && $index === $this->selectedItemIndex;
148
149			$marker = '';
150			if ($item->canSelect()) {
151			$marker = $item->getStyle()->getMarker($item, $isSelected);
152			}
153
154			$itemExtra = '';
155			if ($item->getStyle()->getDisplaysExtra()) {
156			$itemExtraVal = $item->getStyle()->getItemExtra();
157			$itemExtra = $item->showsItemExtra()
158			? sprintf(' %s', $itemExtraVal)
159			: sprintf(' %s', str_repeat(' ', mb_strlen($itemExtraVal)));
160			}
161
162			return $this->buildCell(
163			explode(
164			"\n",
165			StringUtil::wordwrap(
166			sprintf('%s%s', $marker, $item->getText()),
167			$length,
168			sprintf("\n%s", str_repeat(' ', mb_strlen($marker)))
169			)
170			),
171			$length,
172			$style,
173			$isSelected,
174			$itemExtra
175			);
176			}),
177			$missingLength,
178			$length,
179			$largestItemExtra
180			);
181			}
182
183			private function buildRows(array $cells, int $missingLength, int $length, int $largestItemExtra) : array
184			{
185			$extraPadLength = $largestItemExtra > 0 ? 2 + $largestItemExtra : 0;
186
187			return array_map(
188			function ($i) use ($cells, $length, $missingLength, $extraPadLength) {
189			return $this->buildRow($cells, $i, $length, $missingLength, $extraPadLength);
190			},
191			range(0, max(array_map('count', $cells)) - 1)
192			);
193			}
194
195			private function buildRow(array $cells, int $index, int $length, int $missingLength, int $extraPadLength) : string
196			{
197			return sprintf(
198			'%s%s',
199			implode(
200			'',
201			array_map(
202			function ($cell) use ($index, $length, $extraPadLength) {
203			return $cell[$index] ?? str_repeat(' ', $length + $this->gutter + $extraPadLength);
204			},
205			$cells
206			)
207			),
208			str_repeat(' ', $missingLength)
209			);
210			}
211
212			private function buildCell(
213			array $content,
214			int $length,
215			MenuStyle $style,
216			bool $isSelected,
217			string $itemExtra
218			) : array {
219			return array_map(function ($row, $index) use ($length, $style, $isSelected, $itemExtra) {
220			$invertedColoursSetCode = $isSelected
221			? $style->getInvertedColoursSetCode()
222			: '';
223			$invertedColoursUnsetCode = $isSelected
224			? $style->getInvertedColoursUnsetCode()
225			: '';
226
227			return sprintf(
228			'%s%s%s%s%s%s',
229			$invertedColoursSetCode,
230			$row,
231			str_repeat(' ', $length - mb_strlen($row)),
232			$index === 0 ? $itemExtra : str_repeat(' ', mb_strlen($itemExtra)),
233			$invertedColoursUnsetCode,
234			str_repeat(' ', $this->gutter)
235			);
236			}, $content, array_keys($content));
237			}
238
239			/**
240			* Is there an item with this index and can it be
241			* selected?
242			*/
243			public function canSelectIndex(int $index) : bool
244			{
245			return isset($this->items[$index]) && $this->items[$index]->canSelect();
246			}
247
248			/**
249			* Set the item index which should be selected. If the item does
250			* not exist then throw an exception.
251			*/
252			public function setSelectedItemIndex(int $index) : void
253			{
254			if (!isset($this->items[$index])) {
255			throw new \InvalidArgumentException(sprintf('Index: "%s" does not exist', $index));
256			}
257
258			$this->selectedItemIndex = $index;
259			}
260
261			/**
262			* Get the currently select item index.
263			* May be null in case of no selectable item.
264			*/
265			public function getSelectedItemIndex() : ?int
266			{
267			return $this->selectedItemIndex;
268			}
269
270			/**
271			* Get the currently selected item - if no items are selectable
272			* then throw an exception.
273			*/
274			public function getSelectedItem() : MenuItemInterface
275			{
276			if (null === $this->selectedItemIndex) {
277			throw new \RuntimeException('No item is selected');
278			}
279
280			return $this->items[$this->selectedItemIndex];
281			}
282
283			public function getItems() : array
284			{
285			return $this->items;
286			}
287
288			/**
289			* Can the item be selected
290			* In this case, it indicates if at least 1 item inside the SplitItem can be selected
291			*/
292			public function canSelect() : bool
293			{
294			return $this->canBeSelected;
295			}
296
297			/**
298			* Execute the items callable if required
299			*/
300			public function getSelectAction() : ?callable
301			{
302			return null;
303			}
304
305			/**
306			* Whether or not the menu item is showing the menustyle extra value
307			*/
308			public function showsItemExtra() : bool
309			{
310			return false;
311			}
312
313			/**
314			* Enable showing item extra
315			*/
316			public function showItemExtra() : void
317			{
318			//noop
319			}
320
321			/**
322			* Disable showing item extra
323			*/
324			public function hideItemExtra() : void
325			{
326			//noop
327			}
328
329			/**
330			* Nothing to return with SplitItem
331			*/
332			public function getText() : string
333			{
334			throw new \BadMethodCallException(sprintf('Not supported on: %s', __CLASS__));
335			}
336
337			/**
338			* Finds largest itemExtra value in items
339			*/
340			private function calculateItemExtra() : int
341			{
342			return max(array_map(
343			function (MenuItemInterface $item) {
344			return mb_strlen($item->getStyle()->getItemExtra());
345			},
346			array_filter($this->items, function (MenuItemInterface $item) {
347			return $item->getStyle()->getDisplaysExtra();
348			})
349			));
350			}
351
352			/**
353			* @return DefaultStyle
354			*/
355			public function getStyle(): ItemStyle
356			{
357			return $this->style;
358			}
359
360			public function setStyle(DefaultStyle $style): void
361			{
362			$this->style = $style;
363			}
364
365			/**
366			* @inheritDoc
367			*/
368			public function propagateStyles(CliMenu $parent): void
369			{
370			each(
371			array_filter($this->getItems(), function (MenuItemInterface $item) {
372			return !$item->getStyle()->hasChangedFromDefaults();
373			}),
374			function ($index, $item) use ($parent) {
375			$item->setStyle(clone $parent->getItemStyleForItem($item));
376			}
377			);
378
379			each(
380			array_filter($this->getItems(), function (MenuItemInterface $item) {
381			return $item instanceof PropagatesStyles;
382			}),
383			function ($index, PropagatesStyles $item) use ($parent) {
384			$item->propagateStyles($parent);
385			}
386			);
387			}
388			}
389

php-school / cli-menu

Pull Request — master (#230)

SplitItem::getGutter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like