Fix margin auto when updating width

Author: AydinHassan

examples/basic-centered.php

@@ -12,11 +12,14 @@
 $menu = (new CliMenuBuilder)
     ->setTitle('Basic CLI Menu')
     ->addItem('First Item', $itemCallable)
-    ->addItem('Second Item', $itemCallable)
+    ->addItem('Make menu wider', function (CliMenu $menu) {
+        $menu->getStyle()->setWidth($menu->getStyle()->getWidth() + 10);
+        $menu->redraw();
+    })
     ->addItem('Third Item', $itemCallable)
     ->addLineBreak('-')
     ->setWidth(70)
-    ->setMargin(-1)
+    ->setMarginAuto()
     ->build();
 
 $menu->open();

src/CliMenuBuilder.php

@@ -230,8 +230,18 @@ public function setPadding(int $padding) : self
         return $this;
     }
 
-    public function setMargin(int $margin) : self
+    public function setMarginAuto() : self
     {
+        $this->style['marginAuto'] = true;
+        
+        return $this;
+    }
+
+    public function setMargin(int $margin) : self
+    {   
+        Assertion::greaterOrEqualThan($margin, 0);
+        
+        $this->style['marginAuto'] = false;    
         $this->style['margin'] = $margin;
 
         return $this;
@@ -320,7 +330,7 @@ private function getMenuStyle() : MenuStyle
 
     private function buildStyle() : MenuStyle
     {
-        return (new MenuStyle($this->terminal))
+        $style = (new MenuStyle($this->terminal))
             ->setFg($this->style['fg'])
             ->setBg($this->style['bg'])
             ->setWidth($this->style['width'])
@@ -331,6 +341,10 @@ private function buildStyle() : MenuStyle
             ->setItemExtra($this->style['itemExtra'])
             ->setDisplaysExtra($this->style['displaysExtra'])
             ->setTitleSeparator($this->style['titleSeparator']);
+
+        $this->style['marginAuto'] ? $style->setMarginAuto() : $style->setMargin($this->style['margin']);
+        
+        return $style;
     }
 
     /**

src/MenuStyle.php

@@ -73,6 +73,11 @@ class MenuStyle
      */
     private $titleSeparator;
 
+    /**
+     * @var bool
+     */
+    private $marginAuto = false;
+
     /**
      * Default Values
      *
@@ -89,6 +94,7 @@ class MenuStyle
         'itemExtra' => '✔',
         'displaysExtra' => false,
         'titleSeparator' => '=',
+        'marginAuto' => false,
     ];
 
     public static function getDefaultStyleValues() : array
@@ -272,8 +278,8 @@ public function setWidth(int $width) : self
         }
 
         $this->width = $width;
-        if ($this->margin === -1) {
-            $this->setMargin(-1);
+        if ($this->marginAuto) {
+            $this->setMarginAuto();
         }
         $this->calculateContentWidth();
 
@@ -299,13 +305,18 @@ public function getMargin() : int
         return $this->margin;
     }
 
+    public function setMarginAuto() : self
+    {
+        $this->marginAuto = true;
+        $this->margin = floor(($this->terminal->getWidth() - $this->width) / 2);
+        
+        return $this;
+    }
+
     public function setMargin(int $margin) : self
     {
-        if ($margin === -1) {
-            $this->margin = floor(($this->terminal->getWidth() - $this->width) / 2);
-        } else {
-            $this->margin = $margin;
-        }
+        $this->marginAuto = false;
+        $this->margin = $margin;
 
         return $this;
     }

test/CliMenuBuilderTest.php

@@ -437,6 +437,93 @@ public function testThrowsExceptionWhenDisablingRootMenu() : void
 
         (new CliMenuBuilder)->disableMenu();
     }
+
+    /**
+     * @dataProvider marginBelowZeroProvider
+     */
+    public function testSetMarginThrowsExceptionIfValueIsNotZeroOrAbove(int $value) : void
+    {
+        self::expectException(\Assert\InvalidArgumentException::class);
+        
+        
+        (new CliMenuBuilder)->setMargin($value);
+    }
+
+    public function marginBelowZeroProvider() : array
+    {
+        return [[-1], [-2], [-10]];
+    }
+
+    /**
+     * @dataProvider marginAboveZeroProvider
+     */
+    public function testSetMarginAcceptsZeroAndPositiveIntegers(int $value) : void
+    {
+        $menu = (new CliMenuBuilder)->setMargin($value)->build();
+        
+        self::assertSame($value, $menu->getStyle()->getMargin());
+    }
+
+    public function marginAboveZeroProvider() : array
+    {
+        return [[0], [1], [10], [50]];
+    }
+
+    public function testSetMarginAutoAutomaticallyCalculatesMarginToCenter() : void
+    {
+        $terminal = self::createMock(Terminal::class);
+        $terminal
+            ->expects($this->any())
+            ->method('getWidth')
+            ->will($this->returnValue(200));
+
+        $builder = new CliMenuBuilder;
+        $menu = $builder
+            ->setTerminal($terminal)
+            ->setMarginAuto()
+            ->setWidth(100)
+            ->build();
+        
+        self::assertSame(50, $menu->getStyle()->getMargin());
+    }
+
+    public function testSetMarginAutoOverwritesSetMargin() : void
+    {
+        $terminal = self::createMock(Terminal::class);
+        $terminal
+            ->expects($this->any())
+            ->method('getWidth')
+            ->will($this->returnValue(200));
+
+        $builder = new CliMenuBuilder;
+        $menu = $builder
+            ->setTerminal($terminal)
+            ->setMargin(10)
+            ->setMarginAuto()
+            ->setWidth(100)
+            ->build();
+
+        self::assertSame(50, $menu->getStyle()->getMargin());
+    }
+
+    public function testSetMarginManuallyOverwritesSetMarginAuto() : void
+    {
+        $terminal = self::createMock(Terminal::class);
+        $terminal
+            ->expects($this->any())
+            ->method('getWidth')
+            ->will($this->returnValue(200));
+
+        $builder = new CliMenuBuilder;
+        $menu = $builder
+            ->setTerminal($terminal)
+            ->setMarginAuto()
+            ->setMargin(10)
+            ->setWidth(100)
+            ->build();
+
+        self::assertSame(10, $menu->getStyle()->getMargin());
+    }
 
     private function checkItems(CliMenu $menu, array $expected) : void
     {

test/MenuStyleTest.php

@@ -191,9 +191,26 @@ public function testMarginAutoCenters() : void
 
         $style->setWidth(300);
         $style->setPadding(5);
-        $style->setMargin(-1);
+        $style->setMarginAuto();
 
         self::assertSame(100, $style->getMargin());
         self::assertSame(290, $style->getContentWidth());
     }
+
+    public function testModifyWithWhenMarginAutoIsEnabledRecalculatesMargin() : void
+    {
+        $style = $this->getMenuStyle();
+
+        $style->setWidth(300);
+        $style->setPadding(5);
+        $style->setMarginAuto();
+
+        self::assertSame(100, $style->getMargin());
+        self::assertSame(290, $style->getContentWidth());
+        
+        $style->setWidth(400);
+
+        self::assertSame(50, $style->getMargin());
+        self::assertSame(390, $style->getContentWidth());
+    }
 }