Refactor split item item selection and CliMenu can select checks.

src/CliMenu.php

@@ -289,7 +289,7 @@ protected function moveSelectionVertically(string $direction) : void
                     ? end($itemKeys)
                     : reset($itemKeys);
             }
-        } while (!$this->getSelectedItem()->canSelect());
+        } while (!$this->canSelect());
     }
 
     /**
@@ -301,6 +301,7 @@ protected function moveSelectionHorizontally(string $direction) : void
             return;
         }
 
+        /** @var SplitItem $item */
         $item = $this->items[$this->selectedItem];
         $itemKeys = array_keys($item->getItems());
         $selectedItemIndex = $item->getSelectedItemIndex();
@@ -309,17 +310,37 @@ protected function moveSelectionHorizontally(string $direction) : void
             $direction === 'LEFT'
                 ? $selectedItemIndex--
                 : $selectedItemIndex++;
-            $item->setSelectedItemIndex($selectedItemIndex);
 
             if (!array_key_exists($selectedItemIndex, $item->getItems())) {
                 $selectedItemIndex = $direction === 'LEFT'
                     ? end($itemKeys)
                     : reset($itemKeys);
-                $item->setSelectedItemIndex($selectedItemIndex);
             }
-        } while (!$item->getSelectedItem()->canSelect());
+        } while (!$item->canSelectIndex($selectedItemIndex));
+
+        $item->setSelectedItemIndex($selectedItemIndex);
     }
 
+    /**
+     * Can the currently selected item actually be selected?
+     *
+     * For example:
+     *  selectable item -> yes
+     *  static item -> no
+     *  split item with only static items -> no
+     *  split item with at least one selectable item -> yes
+     *
+     * @return bool
+     */
+    private function canSelect() : bool
+    {
+        return $this->items[$this->selectedItem]->canSelect();
+    }
+
+    /**
+     * Retrieve the item the user actually selected
+     *
+     */
     public function getSelectedItem() : MenuItemInterface
     {
         $item = $this->items[$this->selectedItem];

src/MenuItem/SplitItem.php

@@ -200,6 +200,19 @@ private function buildCell(
         }, $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])) {
@@ -209,16 +222,26 @@ public function setSelectedItemIndex(int $index) : void
         $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
     {
-        return $this->selectedItemIndex !== null
-            ? $this->items[$this->selectedItemIndex]
-            : $this;
+        if (null === $this->selectedItemIndex) {
+            throw new \RuntimeException('No item is selected');
+        }
+
+        return $this->items[$this->selectedItemIndex];
     }
 
     public function getItems() : array

test/CliMenuTest.php

@@ -6,6 +6,8 @@
 use PhpSchool\CliMenu\Exception\MenuNotOpenException;
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
 use PhpSchool\CliMenu\MenuItem\SelectableItem;
+use PhpSchool\CliMenu\MenuItem\SplitItem;
+use PhpSchool\CliMenu\MenuItem\StaticItem;
 use PhpSchool\CliMenu\MenuStyle;
 use PhpSchool\Terminal\Terminal;
 use PhpSchool\Terminal\UnixTerminal;
@@ -667,6 +669,171 @@ public function testRemoveCustomControlMapping() : void
         self::assertSame([], $this->readAttribute($menu, 'customControlMappings'));
     }
 
+    public function testSplitItemWithNoSelectableItemsScrollingVertically() : void
+    {
+        $this->terminal->expects($this->exactly(3))
+            ->method('read')
+            ->willReturn("\033[B", "\033[B", "\n");
+
+        $action = function (CliMenu $menu) {
+            $menu->close();
+        };
+
+        $menu = new CliMenu('PHP School FTW', [], $this->terminal);
+        $menu->addItem(new SelectableItem('One', $action));
+        $menu->addItem(new SplitItem([new StaticItem('Two'), new StaticItem('Three')]));
+        $menu->addItem(new SelectableItem('Four', $action));
+
+        $menu->open();
+
+        self::assertStringEqualsFile($this->getTestFile(), $this->output->fetch());
+    }
+
+    public function testSplitItemWithSelectableItemsScrollingVertical() : void
+    {
+        $this->terminal->expects($this->exactly(4))
+            ->method('read')
+            ->willReturn("\033[B", "\033[B", "\033[B", "\n");
+
+        $action = function (CliMenu $menu) {
+            $menu->close();
+        };
+
+        $splitAction = function (CliMenu $menu) {
+        };
+
+        $menu = new CliMenu('PHP School FTW', [], $this->terminal);
+        $menu->addItem(new SelectableItem('One', $action));
+        $menu->addItem(
+            new SplitItem(
+                [new SelectableItem('Two', $splitAction), new SelectableItem('Three', $splitAction)]
+            )
+        );
+        $menu->addItem(new SelectableItem('Four', $action));
+
+        $menu->open();
+
+        self::assertStringEqualsFile($this->getTestFile(), $this->output->fetch());
+    }
+
+    public function testSplitItemWithSelectableItemsScrollingRight() : void
+    {
+        $this->terminal->expects($this->exactly(6))
+            ->method('read')
+            ->willReturn("\033[B", "\033[C", "\033[C", "\033[C", "\033[B", "\n");
+
+        $action = function (CliMenu $menu) {
+            $menu->close();
+        };
+
+        $splitAction = function (CliMenu $menu) {
+        };
+
+        $menu = new CliMenu('PHP School FTW', [], $this->terminal);
+        $menu->addItem(new SelectableItem('One', $action));
+        $menu->addItem(
+            new SplitItem(
+                [new SelectableItem('Two', $splitAction), new SelectableItem('Three', $splitAction)]
+            )
+        );
+        $menu->addItem(new SelectableItem('Four', $action));
+
+        $menu->open();
+
+        self::assertStringEqualsFile($this->getTestFile(), $this->output->fetch());
+    }
+
+    public function testSplitItemWithSelectableItemsScrollingLeft() : void
+    {
+        $this->terminal->expects($this->exactly(6))
+            ->method('read')
+            ->willReturn("\033[B", "\033[D", "\033[D", "\033[D", "\033[B", "\n");
+
+        $action = function (CliMenu $menu) {
+            $menu->close();
+        };
+
+        $splitAction = function (CliMenu $menu) {
+        };
+
+        $menu = new CliMenu('PHP School FTW', [], $this->terminal);
+        $menu->addItem(new SelectableItem('One', $action));
+        $menu->addItem(
+            new SplitItem(
+                [
+                    new SelectableItem('Two', $splitAction),
+                    new SelectableItem('Three', $splitAction),
+                    new SelectableItem('Four', $splitAction),
+                ]
+            )
+        );
+        $menu->addItem(new SelectableItem('Five', $action));
+
+        $menu->open();
+
+        self::assertStringEqualsFile($this->getTestFile(), $this->output->fetch());
+    }
+
+    public function testSplitItemWithSelectableAndStaticItemsScrollingHorizontally() : void
+    {
+        $this->terminal->expects($this->exactly(6))
+            ->method('read')
+            ->willReturn("\033[B", "\033[D", "\033[D", "\033[D", "\033[B", "\n");
+
+        $action = function (CliMenu $menu) {
+            $menu->close();
+        };
+
+        $splitAction = function (CliMenu $menu) {
+        };
+
+        $menu = new CliMenu('PHP School FTW', [], $this->terminal);
+        $menu->addItem(new SelectableItem('One', $action));
+        $menu->addItem(
+            new SplitItem(
+                [
+                    new SelectableItem('Two', $splitAction),
+                    new StaticItem('Three'),
+                    new SelectableItem('Four', $splitAction),
+                ]
+            )
+        );
+        $menu->addItem(new SelectableItem('Five', $action));
+
+        $menu->open();
+
+        self::assertStringEqualsFile($this->getTestFile(), $this->output->fetch());
+    }
+
+
+    public function testSelectableCallableReceivesSelectableAndNotSplitItem() : void
+    {
+        $this->terminal->expects($this->exactly(1))
+            ->method('read')
+            ->willReturn("\n");
+
+        $actualSelectedItem = null;
+        $action = function (CliMenu $menu) use (&$actualSelectedItem) {
+            $actualSelectedItem = $menu->getSelectedItem();
+            $menu->close();
+        };
+
+        $expectedSelectedItem  = new SelectableItem('Two', $action);
+        $menu = new CliMenu('PHP School FTW', [], $this->terminal);
+        $menu->addItem(
+            new SplitItem(
+                [
+                    $expectedSelectedItem,
+                    new StaticItem('Three'),
+                    new SelectableItem('Four', $action),
+                ]
+            )
+        );
+        $menu->open();
+
+        self::assertSame($expectedSelectedItem, $actualSelectedItem);
+    }
+
     private function getTestFile() : string
     {
         return sprintf('%s/res/%s.txt', __DIR__, $this->getName());

test/MenuItem/SplitItemTest.php

@@ -431,11 +431,27 @@ public function testGetSelectedItemReturnsItem() : void
         self::assertSame($item2, $splitItem->getSelectedItem());
     }
 
-    public function testGetSelectedItemReturnsSplitItemWhenNoSelectableItemExists() : void
+    public function testGetSelectedItemThrowsExceptionWhenNoSelectableItemExists() : void
     {
+        self::expectException(\RuntimeException::class);
+        self::expectExceptionMessage('No item is selected');
+
         $item1 = new StaticItem('One');
 
         $splitItem = new SplitItem([$item1]);
         self::assertSame($splitItem, $splitItem->getSelectedItem());
     }
+
+    public function testCanSelectIndex() : void
+    {
+        $item1 = new StaticItem('One');
+        $item2 = new SelectableItem('Two', function () {
+        });
+
+        $splitItem = new SplitItem([$item1, $item2]);
+
+        self::assertFalse($splitItem->canSelectIndex(0));
+        self::assertFalse($splitItem->canSelectIndex(5));
+        self::assertTrue($splitItem->canSelectIndex(1));
+    }
 }

test/res/testSplitItemWithNoSelectableItemsScrollingVertically.txt

@@ -0,0 +1,33 @@
+
+
+                                                
+    PHP School FTW                              
+    ==========================================  
+    ● One                                       
+    Two                  Three                  
+    ○ Four                                      
+                                                
+
+
+
+
+                                                
+    PHP School FTW                              
+    ==========================================  
+    ○ One                                       
+    Two                  Three                  
+    ● Four                                      
+                                                
+
+
+
+
+                                                
+    PHP School FTW                              
+    ==========================================  
+    ● One                                       
+    Two                  Three                  
+    ○ Four                                      
+                                                
+
+