php-school /
cli-menu
| Total Complexity | 44 |
| Total Lines | 337 |
| Duplicated Lines | 0 % |
| Changes | 17 | ||
| Bugs | 0 | Features | 1 |
Complex classes like SplitItem often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use SplitItem, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class SplitItem implements MenuItemInterface |
||
| 14 | { |
||
| 15 | /** |
||
| 16 | * @var array |
||
| 17 | */ |
||
| 18 | private $items = []; |
||
| 19 | |||
| 20 | /** |
||
| 21 | * @var int|null |
||
| 22 | */ |
||
| 23 | private $selectedItemIndex; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * @var bool |
||
| 27 | */ |
||
| 28 | private $canBeSelected = true; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * @var int |
||
| 32 | */ |
||
| 33 | private $gutter = 2; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * @var SplitStyle |
||
| 37 | */ |
||
| 38 | private $style; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * @var \Callable |
||
|
|
|||
| 42 | */ |
||
| 43 | private $styleCallback = null; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * @var array |
||
| 47 | */ |
||
| 48 | private static $blacklistedItems = [ |
||
| 49 | \PhpSchool\CliMenu\MenuItem\AsciiArtItem::class, |
||
| 50 | \PhpSchool\CliMenu\MenuItem\LineBreakItem::class, |
||
| 51 | \PhpSchool\CliMenu\MenuItem\SplitItem::class, |
||
| 52 | ]; |
||
| 53 | |||
| 54 | public function __construct(array $items = []) |
||
| 55 | { |
||
| 56 | $this->addItems($items); |
||
| 57 | $this->setDefaultSelectedItem(); |
||
| 58 | |||
| 59 | $this->style = new SplitStyle(); |
||
| 60 | } |
||
| 61 | |||
| 62 | public function setStyleCallback(Callable $callable) |
||
| 63 | { |
||
| 64 | $this->styleCallback = $callable; |
||
| 65 | } |
||
| 66 | |||
| 67 | public function setGutter(int $gutter) : void |
||
| 71 | } |
||
| 72 | |||
| 73 | public function getGutter() : int |
||
| 76 | } |
||
| 77 | |||
| 78 | public function addItem(MenuItemInterface $item) : self |
||
| 79 | { |
||
| 80 | foreach (self::$blacklistedItems as $bl) { |
||
| 81 | if ($item instanceof $bl) { |
||
| 82 | throw new \InvalidArgumentException("Cannot add a $bl to a SplitItem"); |
||
| 83 | } |
||
| 84 | } |
||
| 85 | $this->items[] = $item; |
||
| 86 | $this->setDefaultSelectedItem(); |
||
| 87 | return $this; |
||
| 88 | } |
||
| 89 | |||
| 90 | public function addItems(array $items) : self |
||
| 91 | { |
||
| 92 | foreach ($items as $item) { |
||
| 93 | $this->addItem($item); |
||
| 94 | } |
||
| 95 | |||
| 96 | return $this; |
||
| 97 | } |
||
| 98 | |||
| 99 | public function setItems(array $items) : self |
||
| 100 | { |
||
| 101 | $this->items = []; |
||
| 102 | $this->addItems($items); |
||
| 103 | return $this; |
||
| 104 | } |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Select default item |
||
| 108 | */ |
||
| 109 | private function setDefaultSelectedItem() : void |
||
| 110 | { |
||
| 111 | foreach ($this->items as $index => $item) { |
||
| 112 | if ($item->canSelect()) { |
||
| 113 | $this->canBeSelected = true; |
||
| 114 | $this->selectedItemIndex = $index; |
||
| 115 | return; |
||
| 116 | } |
||
| 117 | } |
||
| 118 | |||
| 119 | $this->canBeSelected = false; |
||
| 120 | $this->selectedItemIndex = null; |
||
| 121 | } |
||
| 122 | |||
| 123 | /** |
||
| 124 | * The output text for the item |
||
| 125 | */ |
||
| 126 | public function getRows(MenuStyle $style, bool $selected = false) : array |
||
| 127 | { |
||
| 128 | // Set local style with parent style |
||
| 129 | if ($this->styleCallback) { |
||
| 130 | ($this->styleCallback)($this->style); |
||
| 131 | |||
| 132 | $this->styleCallback = null; |
||
| 133 | } |
||
| 134 | |||
| 135 | $numberOfItems = count($this->items); |
||
| 136 | |||
| 137 | if ($numberOfItems === 0) { |
||
| 138 | throw new \RuntimeException(sprintf('There should be at least one item added to: %s', __CLASS__)); |
||
| 139 | } |
||
| 140 | |||
| 141 | if (!$selected) { |
||
| 142 | $this->setDefaultSelectedItem(); |
||
| 143 | } |
||
| 144 | |||
| 145 | $length = $this->style->getDisplaysExtra() |
||
| 146 | ? floor($style->getContentWidth() / $numberOfItems) - (mb_strlen($this->style->getItemExtra()) + 2) |
||
| 147 | : floor($style->getContentWidth() / $numberOfItems); |
||
| 148 | |||
| 149 | $length -= $this->gutter; |
||
| 150 | $length = (int) $length; |
||
| 151 | |||
| 152 | $missingLength = $style->getContentWidth() % $numberOfItems; |
||
| 153 | |||
| 154 | return $this->buildRows( |
||
| 155 | array_map(function ($index, $item) use ($selected, $length, $style) { |
||
| 156 | /** @var ItemStyleInterface|MenuItemInterface $item */ |
||
| 157 | $isSelected = $selected && $index === $this->selectedItemIndex; |
||
| 158 | |||
| 159 | $itemStyle = $item->getStyle(); |
||
| 160 | |||
| 161 | $getMarkerType = $item instanceof ToggableItemInterface |
||
| 162 | ? $item->getChecked() |
||
| 163 | : $isSelected; |
||
| 164 | |||
| 165 | $marker = $item->canSelect() |
||
| 166 | ? sprintf('%s', $itemStyle->getMarker($getMarkerType)) |
||
| 167 | : ''; |
||
| 168 | |||
| 169 | $itemExtra = ''; |
||
| 170 | if ($itemStyle->getDisplaysExtra()) { |
||
| 171 | $itemExtraString = $itemStyle->getItemExtra(); |
||
| 172 | $itemExtra = $item->showsItemExtra() |
||
| 173 | ? sprintf(' %s', $itemExtraString) |
||
| 174 | : sprintf(' %s', str_repeat(' ', mb_strlen($itemExtraString))); |
||
| 175 | } |
||
| 176 | |||
| 177 | return $this->buildCell( |
||
| 178 | explode( |
||
| 179 | "\n", |
||
| 180 | StringUtil::wordwrap( |
||
| 181 | sprintf('%s%s', $marker, $item->getText()), |
||
| 182 | $length, |
||
| 183 | sprintf("\n%s", str_repeat(' ', mb_strlen($marker))) |
||
| 184 | ) |
||
| 185 | ), |
||
| 186 | $length, |
||
| 187 | $style, |
||
| 188 | $isSelected, |
||
| 189 | $itemExtra |
||
| 190 | ); |
||
| 191 | }, array_keys($this->items), $this->items), |
||
| 192 | $style, |
||
| 193 | $missingLength, |
||
| 194 | $length |
||
| 195 | ); |
||
| 196 | } |
||
| 197 | |||
| 198 | private function buildRows(array $cells, MenuStyle $style, int $missingLength, int $length) : array |
||
| 199 | { |
||
| 200 | $extraPadLength = $this->style->getDisplaysExtra() ? 2 + mb_strlen($this->style->getItemExtra()) : 0; |
||
| 201 | |||
| 202 | return array_map( |
||
| 203 | function ($i) use ($cells, $length, $missingLength, $extraPadLength) { |
||
| 204 | return $this->buildRow($cells, $i, $length, $missingLength, $extraPadLength); |
||
| 205 | }, |
||
| 206 | range(0, max(array_map('count', $cells)) - 1) |
||
| 207 | ); |
||
| 208 | } |
||
| 209 | |||
| 210 | private function buildRow(array $cells, int $index, int $length, int $missingLength, int $extraPadLength) : string |
||
| 211 | { |
||
| 212 | return sprintf( |
||
| 213 | '%s%s', |
||
| 214 | implode( |
||
| 215 | '', |
||
| 216 | array_map( |
||
| 217 | function ($cell) use ($index, $length, $extraPadLength) { |
||
| 218 | return $cell[$index] ?? str_repeat(' ', $length + $this->gutter + $extraPadLength); |
||
| 219 | }, |
||
| 220 | $cells |
||
| 221 | ) |
||
| 222 | ), |
||
| 223 | str_repeat(' ', $missingLength) |
||
| 224 | ); |
||
| 225 | } |
||
| 226 | |||
| 227 | private function buildCell( |
||
| 228 | array $content, |
||
| 229 | int $length, |
||
| 230 | MenuStyle $style, |
||
| 231 | bool $isSelected, |
||
| 232 | string $itemExtra |
||
| 233 | ) : array { |
||
| 234 | return array_map(function ($row, $index) use ($length, $style, $isSelected, $itemExtra) { |
||
| 235 | $invertedColoursSetCode = $isSelected |
||
| 236 | ? $style->getInvertedColoursSetCode() |
||
| 237 | : ''; |
||
| 238 | $invertedColoursUnsetCode = $isSelected |
||
| 239 | ? $style->getInvertedColoursUnsetCode() |
||
| 240 | : ''; |
||
| 241 | |||
| 242 | return sprintf( |
||
| 243 | '%s%s%s%s%s%s', |
||
| 244 | $invertedColoursSetCode, |
||
| 245 | $row, |
||
| 246 | str_repeat(' ', $length - mb_strlen($row)), |
||
| 247 | $index === 0 ? $itemExtra : str_repeat(' ', mb_strlen($itemExtra)), |
||
| 248 | $invertedColoursUnsetCode, |
||
| 249 | str_repeat(' ', $this->gutter) |
||
| 250 | ); |
||
| 251 | }, $content, array_keys($content)); |
||
| 252 | } |
||
| 253 | |||
| 254 | /** |
||
| 255 | * Is there an item with this index and can it be |
||
| 256 | * selected? |
||
| 257 | */ |
||
| 258 | public function canSelectIndex(int $index) : bool |
||
| 259 | { |
||
| 260 | return isset($this->items[$index]) && $this->items[$index]->canSelect(); |
||
| 261 | } |
||
| 262 | |||
| 263 | /** |
||
| 264 | * Set the item index which should be selected. If the item does |
||
| 265 | * not exist then throw an exception. |
||
| 266 | */ |
||
| 267 | public function setSelectedItemIndex(int $index) : void |
||
| 268 | { |
||
| 269 | if (!isset($this->items[$index])) { |
||
| 270 | throw new \InvalidArgumentException(sprintf('Index: "%s" does not exist', $index)); |
||
| 271 | } |
||
| 272 | |||
| 273 | $this->selectedItemIndex = $index; |
||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Get the currently select item index. |
||
| 278 | * May be null in case of no selectable item. |
||
| 279 | */ |
||
| 280 | public function getSelectedItemIndex() : ?int |
||
| 281 | { |
||
| 282 | return $this->selectedItemIndex; |
||
| 283 | } |
||
| 284 | |||
| 285 | /** |
||
| 286 | * Get the currently selected item - if no items are selectable |
||
| 287 | * then throw an exception. |
||
| 288 | */ |
||
| 289 | public function getSelectedItem() : MenuItemInterface |
||
| 290 | { |
||
| 291 | if (null === $this->selectedItemIndex) { |
||
| 292 | throw new \RuntimeException('No item is selected'); |
||
| 293 | } |
||
| 294 | |||
| 295 | return $this->items[$this->selectedItemIndex]; |
||
| 296 | } |
||
| 297 | |||
| 298 | public function getItems() : array |
||
| 299 | { |
||
| 300 | return $this->items; |
||
| 301 | } |
||
| 302 | |||
| 303 | /** |
||
| 304 | * Can the item be selected |
||
| 305 | * In this case, it indicates if at least 1 item inside the SplitItem can be selected |
||
| 306 | */ |
||
| 307 | public function canSelect() : bool |
||
| 308 | { |
||
| 309 | return $this->canBeSelected; |
||
| 310 | } |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Execute the items callable if required |
||
| 314 | */ |
||
| 315 | public function getSelectAction() : ?callable |
||
| 318 | } |
||
| 319 | |||
| 320 | /** |
||
| 321 | * Whether or not the menu item is showing the menustyle extra value |
||
| 322 | */ |
||
| 323 | public function showsItemExtra() : bool |
||
| 324 | { |
||
| 325 | return false; |
||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Enable showing item extra |
||
| 330 | */ |
||
| 331 | public function showItemExtra() : void |
||
| 332 | { |
||
| 333 | //noop |
||
| 334 | } |
||
| 335 | |||
| 336 | /** |
||
| 337 | * Disable showing item extra |
||
| 338 | */ |
||
| 339 | public function hideItemExtra() : void |
||
| 340 | { |
||
| 341 | //noop |
||
| 342 | } |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Nothing to return with SplitItem |
||
| 346 | */ |
||
| 347 | public function getText() : string |
||
| 350 | } |
||
| 351 | } |
||
| 352 |
Loading history...
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths