Merge pull request #43 from php-school/redraw

Add ability to redraw immediately

Author: mikeymike

src/CliMenu.php

@@ -4,6 +4,7 @@
 
 use PhpSchool\CliMenu\Exception\InvalidInstantiationException;
 use PhpSchool\CliMenu\Exception\InvalidTerminalException;
+use PhpSchool\CliMenu\Exception\MenuNotOpenException;
 use PhpSchool\CliMenu\MenuItem\LineBreakItem;
 use PhpSchool\CliMenu\MenuItem\MenuItemInterface;
 use PhpSchool\CliMenu\MenuItem\StaticItem;
@@ -59,7 +60,7 @@ class CliMenu
      * @param array $items
      * @param TerminalInterface|null $terminal
      * @param MenuStyle|null $style
-     * @throws InvalidInstantiationException
+     *
      * @throws InvalidTerminalException
      */
     public function __construct(
@@ -68,7 +69,6 @@ public function __construct(
         TerminalInterface $terminal = null,
         MenuStyle $style = null
     ) {
-
         $this->title      = $title;
         $this->items      = $items;
         $this->terminal   = $terminal ?: TerminalFactory::fromSystem();
@@ -234,6 +234,18 @@ protected function executeCurrentItem()
         }
     }
 
+    /**
+     * Redraw the menu
+     */
+    public function redraw()
+    {
+        if (!$this->isOpen()) {
+            throw new MenuNotOpenException;
+        }
+
+        $this->draw();
+    }
+
     /**
      * Draw the menu to STDOUT
      */

src/Exception/MenuNotOpenException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace PhpSchool\CliMenu\Exception;
+
+/**
+ * @author Aydin Hassan <[email protected]>
+ */
+class MenuNotOpenException extends \RuntimeException
+{
+
+}

test/CliMenuTest.php

@@ -3,7 +3,10 @@
 namespace PhpSchool\CliMenuTest;
 
 use PhpSchool\CliMenu\CliMenu;
+use PhpSchool\CliMenu\Exception\MenuNotOpenException;
+use PhpSchool\CliMenu\MenuItem\SelectableItem;
 use PhpSchool\CliMenu\MenuStyle;
+use PhpSchool\CliMenu\Terminal\TerminalInterface;
 use PHPUnit_Framework_TestCase;
 
 /**
@@ -20,4 +23,100 @@ public function testGetMenuStyle()
         $menu = new CliMenu('PHP School FTW', [], null, $style);
         static::assertSame($style, $menu->getStyle());
     }
+
+    public function testReDrawThrowsExceptionIfMenuNotOpen()
+    {
+        $menu = new CliMenu('PHP School FTW', []);
+
+        $this->expectException(MenuNotOpenException::class);
+
+        $menu->reDraw();
+    }
+
+    public function testSimpleOpenClose()
+    {
+        $terminal = $this->createMock(TerminalInterface::class);
+
+        $terminal->expects($this->any())
+            ->method('isTTY')
+            ->willReturn(true);
+
+        $terminal->expects($this->once())
+            ->method('getKeyedInput')
+            ->willReturn('enter');
+
+        $terminal->expects($this->any())
+            ->method('getWidth')
+            ->willReturn(50);
+
+        $style = $this->getStyle($terminal);
+
+        $item = new SelectableItem('Item 1', function (CliMenu $menu) {
+            $menu->close();
+        });
+
+        $this->expectOutputString(file_get_contents($this->getTestFile()));
+
+        $menu = new CliMenu('PHP School FTW', [$item], $terminal, $style);
+        $menu->open();
+    }
+
+    public function testReDrawReDrawsImmediately()
+    {
+        $terminal = $this->createMock(TerminalInterface::class);
+
+        $terminal->expects($this->any())
+            ->method('isTTY')
+            ->willReturn(true);
+
+        $terminal->expects($this->once())
+            ->method('getKeyedInput')
+            ->willReturn('enter');
+
+        $terminal->expects($this->any())
+            ->method('getWidth')
+            ->willReturn(50);
+
+        $style = $this->getStyle($terminal);
+
+        $item = new SelectableItem('Item 1', function (CliMenu $menu) {
+            $menu->getStyle()->setBg('red');
+            $menu->redraw();
+            $menu->close();
+        });
+
+        $this->expectOutputString(file_get_contents($this->getTestFile()));
+
+        $menu = new CliMenu('PHP School FTW', [$item], $terminal, $style);
+        $menu->open();
+    }
+
+    /**
+     * @return string
+     */
+    private function getTestFile()
+    {
+        return sprintf('%s/res/%s.txt', __DIR__, $this->getName());
+    }
+
+    /**
+     * @param TerminalInterface $terminal
+     * @return MenuStyle
+     */
+    private function getStyle(TerminalInterface $terminal)
+    {
+        return new MenuStyle(
+            'blue',
+            'white',
+            100,
+            2,
+            2,
+            '○',
+            '●',
+            '✔',
+            false,
+            '=',
+            $terminal
+        );
+    }
 }

test/Exception/MenuNotOpenExceptionTest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace PhpSchool\CliMenuTest\Exception;
+
+use PhpSchool\CliMenu\Exception\MenuNotOpenException;
+use PHPUnit_Framework_TestCase;
+
+/**
+ * @author Aydin Hassan <[email protected]>
+ */
+class MenuNotOpenExceptionTest extends PHPUnit_Framework_TestCase
+{
+    public function testException()
+    {
+        $e = new MenuNotOpenException('error');
+        $this->assertEquals('error', $e->getMessage());
+    }
+}

test/res/testReDrawReDrawsImmediately.txt

@@ -0,0 +1,18 @@
+
+
+                                          
+    PHP School FTW                        
+    ==================================    
+    ● Item 1                              
+                                          
+
+
+
+
+                                          
+    PHP School FTW                        
+    ==================================    
+    ● Item 1                              
+                                          
+
+

test/res/testSimpleOpenClose.txt

@@ -0,0 +1,9 @@
+
+
+                                          
+    PHP School FTW                        
+    ==================================    
+    ● Item 1                              
+                                          
+
+