Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like CliMenuBuilder 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 CliMenuBuilder, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 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) |
||
| 92 | |||
| 93 | public function setTitle(string $title) : self |
||
| 99 | |||
| 100 | public function addMenuItem(MenuItemInterface $item) : self |
||
| 106 | |||
| 107 | public function addItem( |
||
| 117 | |||
| 118 | public function addItems(array $items) : self |
||
| 126 | |||
| 127 | public function addStaticItem(string $text) : self |
||
| 133 | |||
| 134 | public function addLineBreak(string $breakChar = ' ', int $lines = 1) : self |
||
| 140 | |||
| 141 | public function addAsciiArt(string $art, string $position = AsciiArtItem::POSITION_CENTER, string $alt = '') : self |
||
| 147 | |||
| 148 | /** |
||
| 149 | * Add a submenu with a string identifier |
||
| 150 | */ |
||
| 151 | public function addSubMenu(string $id, CliMenuBuilder $subMenuBuilder = null) : CliMenuBuilder |
||
| 163 | |||
| 164 | /** |
||
| 165 | * Disable a submenu |
||
| 166 | * |
||
| 167 | * @throws \InvalidArgumentException |
||
| 168 | */ |
||
| 169 | public function disableMenu() : self |
||
| 181 | |||
| 182 | public function isMenuDisabled() : bool |
||
| 186 | |||
| 187 | public function setGoBackButtonText(string $goBackButtonTest) : self |
||
| 193 | |||
| 194 | public function setExitButtonText(string $exitButtonText) : self |
||
| 200 | |||
| 201 | public function setBackgroundColour(string $colour) : self |
||
| 209 | |||
| 210 | public function setForegroundColour(string $colour) : self |
||
| 218 | |||
| 219 | public function setWidth(int $width) : self |
||
| 225 | |||
| 226 | public function setPadding(int $padding) : self |
||
| 232 | |||
| 233 | public function setMargin(int $margin) : self |
||
| 239 | |||
| 240 | public function setUnselectedMarker(string $marker) : self |
||
| 246 | |||
| 247 | public function setSelectedMarker(string $marker) : self |
||
| 253 | |||
| 254 | public function setItemExtra(string $extra) : self |
||
| 260 | |||
| 261 | public function setTitleSeparator(string $separator) : self |
||
| 267 | |||
| 268 | public function setBorder( |
||
| 298 | |||
| 299 | public function setTerminal(Terminal $terminal) : self |
||
| 304 | |||
| 305 | public function getTerminal() : Terminal |
||
| 309 | |||
| 310 | private function getDefaultItems() : array |
||
| 320 | |||
| 321 | public function disableDefaultItems() : self |
||
| 327 | |||
| 328 | private function itemsHaveExtra(array $items) : bool |
||
| 334 | |||
| 335 | /** |
||
| 336 | * Recursively drop back to the parents menu style |
||
| 337 | * when the current menu has a parent and has no changes |
||
| 338 | */ |
||
| 339 | private function getMenuStyle() : MenuStyle |
||
| 351 | |||
| 352 | private function buildStyle() : MenuStyle |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Return to parent builder |
||
| 374 | * |
||
| 375 | * @throws RuntimeException |
||
| 376 | */ |
||
| 377 | public function end() : CliMenuBuilder |
||
| 385 | |||
| 386 | /** |
||
| 387 | * @throws RuntimeException |
||
| 388 | */ |
||
| 389 | public function getSubMenu(string $id) : CliMenu |
||
| 397 | |||
| 398 | private function buildSubMenus(array $items) : array |
||
| 411 | |||
| 412 | public function build() : CliMenu |
||
| 437 | } |
||
| 438 |
This check looks for function calls that miss required arguments.