Merge pull request #39 from php-school/tests

Fix and add tests
php-school · Sep 30, 2016 · a6989b8 · a6989b8
2 parents 69d34ce + cfc7b8f
commit a6989b8
Show file tree

Hide file tree

Showing 3 changed files with 199 additions and 3 deletions.
diff --git a/src/MenuStyle.php b/src/MenuStyle.php
@@ -154,7 +154,7 @@ public function __construct(
         $builder = debug_backtrace();
         if (count($builder) < 2 || !isset($builder[1]['class']) || $builder[1]['class'] !== $this->allowedConsumer) {
             throw new InvalidInstantiationException(
-                sprintf('The CliMenu must be instantiated by "%s"', $this->allowedConsumer)
+                sprintf('The MenuStyle must be instantiated by "%s"', $this->allowedConsumer)
             );
         }
 
@@ -427,6 +427,14 @@ public function getMarker($selected)
         return $selected ? $this->selectedMarker : $this->unselectedMarker;
     }
 
+    /**
+     * @param string $itemExtra
+     */
+    public function setItemExtra($itemExtra)
+    {
+        $this->itemExtra = $itemExtra;
+    }
+
     /**
      * @return string
      */

diff --git a/test/CliMenuBuilderTest.php b/test/CliMenuBuilderTest.php
@@ -63,8 +63,8 @@ public function testModifyStyles()
         $builder->setSelectedMarker('x');
         $builder->setItemExtra('*');
         $builder->setTitleSeparator('-');
-        
-        $terminal = $this->createMock(TerminalInterface::class);
+
+        $terminal = static::createMock(TerminalInterface::class);
         $terminal
             ->expects($this->once())
             ->method('getWidth')

diff --git a/test/MenuStyleTest.php b/test/MenuStyleTest.php
@@ -0,0 +1,188 @@
+<?php
+
+namespace PhpSchool\CliMenuTest;
+
+use PhpSchool\CliMenu\CliMenuBuilder;
+use PhpSchool\CliMenu\Exception\InvalidInstantiationException;
+use PhpSchool\CliMenu\MenuStyle;
+use PhpSchool\CliMenu\Terminal\UnixTerminal;
+use PHPUnit_Framework_TestCase;
+
+/**
+ * Class MenuStyleTest
+ * @author Michael Woodward <mikeymike.mw@gmail.com>
+ */
+class MenuStyleTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @return MenuStyle
+     */
+    private function getMenuStyle()
+    {
+        // Use the CliMenuBuilder & reflection to get the style Obj
+        $builder = new CliMenuBuilder();
+        $menu    = $builder->build();
+
+        $reflectionMenu = new \ReflectionObject($menu);
+        $styleProperty  = $reflectionMenu->getProperty('style');
+        $styleProperty->setAccessible(true);
+        $style = $styleProperty->getValue($menu);
+
+        $reflectionStyle  = new \ReflectionObject($style);
+        $terminalProperty = $reflectionStyle->getProperty('terminal');
+        $terminalProperty->setAccessible(true);
+        $terminalProperty->setValue($style, $this->getMockTerminal());
+
+        // Force recalculate terminal widths now terminal is set
+        $style->setWidth(100);
+
+        return $style;
+    }
+
+    private function getMockTerminal()
+    {
+        $terminal = $this
+            ->getMockBuilder(UnixTerminal::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getWidth'])
+            ->getMock();
+
+        $terminal
+            ->expects(static::any())
+            ->method('getWidth')
+            ->will(static::returnValue(500));
+
+        return $terminal;
+    }
+
+    public function testMenuStyleCannotBeInstantiatedByDisallowedConsumers()
+    {
+        $this->setExpectedException(
+            InvalidInstantiationException::class,
+            'The MenuStyle must be instantiated by "PhpSchool\CliMenu\CliMenuBuilder"'
+        );
+
+        new MenuStyle();
+    }
+
+    public function testMenuStyleCanBeInstantiatedByCliMenuBuilder()
+    {
+        $builder = new CliMenuBuilder();
+        $menu    = $builder->build();
+
+        $reflectionMenu = new \ReflectionObject($menu);
+        static::assertTrue($reflectionMenu->hasProperty('style'));
+
+        $styleProperty = $reflectionMenu->getProperty('style');
+        $styleProperty->setAccessible(true);
+        $style = $styleProperty->getValue($menu);
+
+        static::assertSame(MenuStyle::class, get_class($style));
+    }
+
+    public function testAvailableColours()
+    {
+        static::assertSame([
+            'black',
+            'red',
+            'green',
+            'yellow',
+            'blue',
+            'magenta',
+            'cyan',
+            'white',
+            'default'
+        ], MenuStyle::getAvailableColours());
+    }
+
+    public function testGetSelectedSetCode()
+    {
+        static::assertSame("\e[47;34m", $this->getMenuStyle()->getSelectedSetCode());
+    }
+
+    public function testGetSelectedUnsetCode()
+    {
+        static::assertSame("\e[49;39m", $this->getMenuStyle()->getSelectedUnsetCode());
+    }
+
+    public function testGetUnselectedSetCode()
+    {
+        static::assertSame("\e[44;37m", $this->getMenuStyle()->getUnselectedSetCode());
+    }
+
+    public function testGetUnselectedUnsetCode()
+    {
+        static::assertSame("\e[49;39m", $this->getMenuStyle()->getUnselectedUnsetCode());
+    }
+
+    public function testGetterAndSetters()
+    {
+        $style = $this->getMenuStyle();
+
+        static::assertSame('blue', $style->getBg());
+        static::assertSame('white', $style->getFg());
+        static::assertSame('○', $style->getUnselectedMarker());
+        static::assertSame('●', $style->getSelectedMarker());
+        static::assertSame('✔', $style->getItemExtra());
+        static::assertFalse($style->getDisplaysExtra());
+        static::assertSame('=', $style->getTitleSeparator());
+        static::assertSame(100, $style->getWidth());
+        static::assertSame(2, $style->getMargin());
+        static::assertSame(2, $style->getPadding());
+
+        $style->setBg('red');
+        $style->setFg('yellow');
+        $style->setUnselectedMarker('-');
+        $style->setSelectedMarker('>');
+        $style->setItemExtra('EXTRA!');
+        $style->setDisplaysExtra(true);
+        $style->setTitleSeparator('+');
+        $style->setWidth(200);
+        $style->setMargin(10);
+        $style->setPadding(10);
+
+        static::assertSame('red', $style->getBg());
+        static::assertSame('yellow', $style->getFg());
+        static::assertSame('-', $style->getUnselectedMarker());
+        static::assertSame('>', $style->getSelectedMarker());
+        static::assertSame('EXTRA!', $style->getItemExtra());
+        static::assertTrue($style->getDisplaysExtra());
+        static::assertSame('+', $style->getTitleSeparator());
+        static::assertSame(200, $style->getWidth());
+        static::assertSame(10, $style->getMargin());
+        static::assertSame(10, $style->getPadding());
+    }
+
+    public function testGetMarkerReturnsTheCorrectMarkers()
+    {
+        $style = $this->getMenuStyle();
+
+        $style->setSelectedMarker('>');
+        $style->setUnselectedMarker('x');
+
+        static::assertSame('>', $style->getMarker(true));
+        static::assertSame('x', $style->getMarker(false));
+    }
+
+    public function testWidthCalculation()
+    {
+        $style = $this->getMenuStyle();
+
+        $style->setWidth(300);
+        $style->setPadding(5);
+        $style->setMargin(5);
+
+        static::assertSame(280, $style->getContentWidth());
+    }
+
+    public function testRightHandPaddingCalculation()
+    {
+        $style = $this->getMenuStyle();
+
+        $style->setWidth(300);
+        $style->setPadding(5);
+        $style->setMargin(5);
+
+        static::assertSame(235, $style->getRightHandPadding(50));
+    }
+}