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

Passed

Pull Request — master (#230)

by Aydin

created 2020-02-15 12:17 UTC

SplitItem::calculateItemExtra() A

↳ Parent: SplitItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace PhpSchool\CliMenu\MenuItem;

use Assert\Assertion;
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\mapWithKeys;
use function PhpSchool\CliMenu\Util\max;

/**
 * @author Michael Woodward <[email protected]>
 */
class SplitItem implements MenuItemInterface
{
    /**
     * @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;
    }
}


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

php-school / cli-menu

Pull Request — master (#230)

SplitItem::calculateItemExtra() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like