Disable auto shortcuts by default

Author: AydinHassan

README.md

@@ -936,15 +936,15 @@ $menu->open();
 
 ## Item Keyboard Shortcuts
 
-By default `CliMenuBuilder` will parse the items text and check for shortcuts. Any single character inside square brackets
+If you enable auto shortcuts `CliMenuBuilder` will parse the items text and check for shortcuts. Any single character inside square brackets
 will be treated as a shortcut. Pressing that character when the menu is open will trigger that items callable.
 
 This functionality works for split items as well as sub menus. The same characters can be used inside sub menus and the
 callable which is invoked will depend on which menu is currently open. 
 
 Note: all shortcuts are lower cased.
 
-You can disable this automatic keyboard shortcut mapping if you would like:
+To enable this automatic keyboard shortcut mapping simply call `->enableAutoShortcuts()`:
 
 ```php
 <?php
@@ -957,15 +957,18 @@ $myCallback = function(CliMenu $menu) {
 };
 
 $menu = (new CliMenuBuilder)
-    ->disableAutoShortcuts()
+    ->enableAutoShortcuts()
     ->addItem('List of [C]lients', $myCallback)
     ->build();
 
 $menu->open();
 
-//Pressing c will do nothing.
+//Pressing c will execute $myCallback.
 ```
 
+You can customise the shortcut matching by passing your own regex to `enableAutoShortcuts`. Be careful to only match 
+one character in the first capture group or an exception will be thrown.
+
 ### Dialogues
 
 #### Flash

examples/shortcuts.php

@@ -11,7 +11,7 @@
 };
 
 $menu = (new CliMenuBuilder)
-    ->disableAutoShortcuts()
+    ->enableAutoShortcuts()
     ->setTitle('Basic CLI Menu')
     ->addItem('[F]irst Item', $itemCallable)
     ->addItem('Se[c]ond Item', $itemCallable)
@@ -32,3 +32,4 @@
     ->build();
 
 $menu->open();
+

src/Builder/CliMenuBuilder.php

@@ -4,6 +4,7 @@
 
 use PhpSchool\CliMenu\Action\ExitAction;
 use PhpSchool\CliMenu\Action\GoBackAction;
+use PhpSchool\CliMenu\Exception\InvalidShortcutException;
 use PhpSchool\CliMenu\MenuItem\AsciiArtItem;
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
 use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
@@ -63,7 +64,15 @@ class CliMenuBuilder
      *
      * @var bool
      */
-    private $autoShortcuts = true;
+    private $autoShortcuts = false;
+
+    /**
+     * Regex to auto match for shortcuts defaults to looking
+     * for a single character encased in square brackets
+     *
+     * @var string
+     */
+    private $autoShortcutsRegex = '/\[(.)\]/';
 
     /**
      * @var bool
@@ -191,16 +200,29 @@ public function addSubMenuFromBuilder(string $text, CliMenuBuilder $builder) : s
         return $this;
     }
 
-    public function disableAutoShortcuts() : self
+    public function enableAutoShortcuts(string $regex = null) : self
     {
-        $this->autoShortcuts = false;
+        $this->autoShortcuts = true;
+
+        if (null !== $regex) {
+            $this->autoShortcutsRegex = $regex;
+        }
 
         return $this;
     }
 
     private function extractShortcut(string $title) : ?string
     {
-        preg_match('/\[(.)\]/', $title, $match);
+        preg_match($this->autoShortcutsRegex, $title, $match);
+
+        if (!isset($match[1])) {
+            return null;
+        }
+
+        if (mb_strlen($match[1]) > 1) {
+            throw InvalidShortcutException::fromShortcut($match[1]);
+        }
+
         return isset($match[1]) ? strtolower($match[1]) : null;
     }
 

src/Exception/InvalidShortcutException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace PhpSchool\CliMenu\Exception;
+
+/**
+ * @author Aydin Hassan <aydin@hotmail.co.uk>
+ */
+class InvalidShortcutException extends \RuntimeException
+{
+    public static function fromShortcut(string $shortcut) : self
+    {
+        return new static(sprintf('Shortcut key must be only one character. Got: "%s"', $shortcut));
+    }
+}