Merge pull request #40 from php-school/feature/disable-items

Add disabled item functionality

Author: mikeymike

README.md

@@ -85,6 +85,8 @@ Check out the [examples](examples) directory and run them to check out what is p
 <img width="600" alt="submenu" src="https://cloud.githubusercontent.com/assets/2817002/11442401/e6f03ef2-950c-11e5-897a-6d55496a4105.png">
 <img width="600" alt="submenu-options" src="https://cloud.githubusercontent.com/assets/2817002/11442403/eaf4782e-950c-11e5-82c5-ab57f84cd6bc.png">
 
+##### Disabled Items & Submenus
+<img width="600" alt="submenu" src="https://cloud.githubusercontent.com/assets/2174476/19047849/868fa8c0-899b-11e6-9004-811c8da6d435.png">
 
 ### API
 
@@ -329,7 +331,38 @@ $subMenu = $mainMenuBuilder->getSubMenu('Super Sub Menu');
 
 You can only do this after the main menu has been built, this is because the main menu builder takes care of building all sub menus.
 
+#### Disabling Items & Sub Menus
 
+In this example we are disabling certain items and a submenu but still having them shown in the output. 
+
+```php
+$itemCallable = function (CliMenu $menu) {
+    echo $menu->getSelectedItem()->getText();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu Disabled Items')
+    ->addItem('First Item', $itemCallable)
+    ->addItem('Second Item', $itemCallable, false, true)
+    ->addItem('Third Item', $itemCallable, false, true)
+    ->addSubMenu('Submenu')
+        ->setTitle('Basic CLI Menu Disabled Items > Submenu')
+        ->addItem('You can go in here!', $itemCallable)
+        ->end()
+    ->addSubMenu('Disabled Submenu')
+        ->setTitle('Basic CLI Menu Disabled Items > Disabled Submenu')
+        ->addItem('Nope can\'t see this!', $itemCallable)
+        ->disableMenu()
+        ->end()
+    ->addLineBreak('-')
+    ->build();
+```
+
+The third param on the `->addItem` call is what disables an item while the `->disableMenu()` call disables the relevent menu. 
+
+The outcome is a full menu with dimmed rows to denote them being disabled. When a user navigates these items are jumped over to the next available selectable item.
+
+---
 
 Once you get going you might just end up with something that looks a little like this... 
 

examples/disabled-items.php

@@ -0,0 +1,29 @@
+<?php
+
+use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\CliMenuBuilder;
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+$itemCallable = function (CliMenu $menu) {
+    echo $menu->getSelectedItem()->getText();
+};
+
+$menu = (new CliMenuBuilder)
+    ->setTitle('Basic CLI Menu Disabled Items')
+    ->addItem('First Item', $itemCallable)
+    ->addItem('Second Item', $itemCallable, false, true)
+    ->addItem('Third Item', $itemCallable, false, true)
+    ->addSubMenu('Submenu')
+        ->setTitle('Basic CLI Menu Disabled Items > Submenu')
+        ->addItem('You can go in here!', $itemCallable)
+        ->end()
+    ->addSubMenu('Disabled Submenu')
+        ->setTitle('Basic CLI Menu Disabled Items > Disabled Submenu')
+        ->addItem('Nope can\'t see this!', $itemCallable)
+        ->disableMenu()
+        ->end()
+    ->addLineBreak('-')
+    ->build();
+
+$menu->open();

src/CliMenu.php

@@ -5,11 +5,11 @@
 use PhpSchool\CliMenu\Exception\InvalidInstantiationException;
 use PhpSchool\CliMenu\Exception\InvalidTerminalException;
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
-use PhpSchool\CliMenu\MenuItem\MenuItem;
 use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
 use PhpSchool\CliMenu\MenuItem\StaticItem;
 use PhpSchool\CliMenu\Terminal\TerminalFactory;
-use \PhpSchool\CliMenu\Terminal\TerminalInterface;
+use PhpSchool\CliMenu\Terminal\TerminalInterface;
+use PhpSchool\CliMenu\Util\StringUtil as s;
 
 /**
  * Class CliMenu
@@ -295,7 +295,7 @@ protected function drawMenuItem(MenuItemInterface $item, $selected = false)
                 $setColour,
                 str_repeat(' ', $this->style->getPadding()),
                 $row,
-                str_repeat(' ', $this->style->getRightHandPadding(mb_strlen($row))),
+                str_repeat(' ', $this->style->getRightHandPadding(mb_strlen(s::stripAnsiEscapeSequence($row)))),
                 $unsetColour,
                 str_repeat(' ', $this->style->getMargin())
             );

src/CliMenuBuilder.php

@@ -74,6 +74,11 @@ class CliMenuBuilder
      */
     private $disableDefaultItems = false;
 
+    /**
+     * @var bool
+     */
+    private $disabled = false;
+
     /**
      * @param CliMenuBuilder|null $parent
      */
@@ -130,13 +135,14 @@ public function addMenuItem(MenuItemInterface $item)
      * @param string $text
      * @param callable $itemCallable
      * @param bool $showItemExtra
+     * @param bool $disabled
      * @return $this
      */
-    public function addItem($text, callable $itemCallable, $showItemExtra = false)
+    public function addItem($text, callable $itemCallable, $showItemExtra = false, $disabled = false)
     {
         Assertion::string($text);
 
-        $this->addMenuItem(new SelectableItem($text, $itemCallable, $showItemExtra));
+        $this->addMenuItem(new SelectableItem($text, $itemCallable, $showItemExtra, $disabled));
 
         return $this;
     }
@@ -211,6 +217,32 @@ public function addSubMenu($id)
         return $this->subMenus[$id];
     }
 
+    /**
+     * Disable a submenu
+     * @throws \InvalidArgumentException
+     * @return $this
+     */
+    public function disableMenu()
+    {
+        if (!$this->parent) {
+            throw new \InvalidArgumentException(
+                'You can\'t disable the root menu'
+            );
+        }
+
+        $this->disabled = true;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isMenuDisabled()
+    {
+        return $this->disabled;
+    }
+
     /**
      * @param string $goBackButtonTest
      * @return $this
@@ -462,7 +494,7 @@ private function buildSubMenus(array $items)
             $menuBuilder           = $this->subMenus[$item];
             $this->subMenus[$item] = $menuBuilder->build();
 
-            return new MenuMenuItem($item, $this->subMenus[$item]);
+            return new MenuMenuItem($item, $this->subMenus[$item], $menuBuilder->isMenuDisabled());
         }, $items);
     }
 

src/MenuItem/MenuMenuItem.php

@@ -23,13 +23,15 @@ class MenuMenuItem implements MenuItemInterface
     /**
      * @param string $text
      * @param CliMenu $subMenu
+     * @param bool $disabled
      */
-    public function __construct($text, CliMenu $subMenu)
+    public function __construct($text, CliMenu $subMenu, $disabled = false)
     {
         Assertion::string($text);
 
-        $this->text    = $text;
-        $this->subMenu = $subMenu;
+        $this->text     = $text;
+        $this->subMenu  = $subMenu;
+        $this->disabled = $disabled;
     }
 
     /**

src/MenuItem/SelectableItem.php

@@ -23,14 +23,16 @@ class SelectableItem implements MenuItemInterface
      * @param string $text
      * @param callable $selectAction
      * @param bool $showItemExtra
+     * @param bool $disabled
      */
-    public function __construct($text, callable $selectAction, $showItemExtra = false)
+    public function __construct($text, callable $selectAction, $showItemExtra = false, $disabled = false)
     {
         Assertion::string($text);
 
         $this->text          = $text;
         $this->selectAction  = $selectAction;
         $this->showItemExtra = (bool) $showItemExtra;
+        $this->disabled      = $disabled;
     }
 
     /**

src/MenuItem/SelectableTrait.php

@@ -16,13 +16,18 @@ trait SelectableTrait
     /**
      * @var string
      */
-    private $text;
+    private $text = '';
 
     /**
      * @var bool
      */
     private $showItemExtra = false;
 
+    /**
+     * @var bool
+     */
+    private $disabled = false;
+
     /**
      * The output text for the item
      *
@@ -48,13 +53,15 @@ public function getRows(MenuStyle $style, $selected = false)
         );
 
         return array_map(function ($row, $key) use ($style, $marker, $length) {
+            $text = $this->disabled ? $style->getDisabledItemText($row) : $row;
+
             if ($key === 0) {
                 return $this->showItemExtra
-                    ? sprintf('%s%s  %s', $row, str_repeat(' ', $length - mb_strlen($row)), $style->getItemExtra())
-                    : $row;
+                    ? sprintf('%s%s  %s', $text, str_repeat(' ', $length - mb_strlen($row)), $style->getItemExtra())
+                    : $text;
             }
 
-            return $row;
+            return $text;
         }, $rows, array_keys($rows));
     }
 
@@ -65,7 +72,7 @@ public function getRows(MenuStyle $style, $selected = false)
      */
     public function canSelect()
     {
-        return true;
+        return !$this->disabled;
     }
 
     /**

src/MenuStyle.php

@@ -116,10 +116,11 @@ class MenuStyle
      */
     private static $availableOptions = array(
         'bold'       => array('set' => 1, 'unset' => 22),
+        'dim'        => array('set' => 2, 'unset' => 22),
         'underscore' => array('set' => 4, 'unset' => 24),
         'blink'      => array('set' => 5, 'unset' => 25),
         'reverse'    => array('set' => 7, 'unset' => 27),
-        'conceal'    => array('set' => 8, 'unset' => 28),
+        'conceal'    => array('set' => 8, 'unset' => 28)
     );
 
     /**
@@ -180,6 +181,20 @@ public static function getAvailableColours()
     {
         return array_keys(self::$availableBackgroundColors);
     }
+
+    /**
+     * @param string $text
+     * @return string
+     */
+    public function getDisabledItemText($text)
+    {
+        return sprintf(
+            "\033[%sm%s\033[%sm",
+            self::$availableOptions['dim']['set'],
+            $text,
+            self::$availableOptions['dim']['unset']
+        );
+    }
 
     /**
      * Get the colour code set for Bg and Fg

src/Util/StringUtil.php

@@ -33,4 +33,13 @@ public static function wordwrap($str, $width, $break = "\n")
             return $word;
         }, explode(" ", $str)));
     }
+
+    /**
+     * @param string $str
+     * @return string
+     */
+    public static function stripAnsiEscapeSequence($str)
+    {
+        return preg_replace('/\x1b[^m]*m/', '', $str);
+    }
 }

test/CliMenuBuilderTest.php

@@ -371,6 +371,14 @@ public function testDisableDefaultItemsDisablesExitAndGoBackOnSubMenu()
 
         $this->checkVariable($subMenu, 'items', []);
     }
+
+    public function testThrowsExceptionWhenDisablingRootMenu()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('You can\'t disable the root menu');
+
+        (new CliMenuBuilder)->disableMenu();
+    }
 
     /**
      * @param CliMenu $menu