Fix changing margins when menu has been shrunk

Author: AydinHassan

src/MenuStyle.php

@@ -4,6 +4,7 @@
 
 use PhpSchool\CliMenu\Terminal\TerminalFactory;
 use PhpSchool\CliMenu\Util\ColourUtil;
+use PhpSchool\CliMenu\Util\StringUtil as s;
 use PhpSchool\Terminal\Terminal;
 use Assert\Assertion;
 
@@ -30,23 +31,31 @@ class MenuStyle
     protected $bg;
 
     /**
+     * The width of the menu. Including borders and padding.
+     * Does not include margin.
+     *
+     * May not be the value that was requested in the
+     * circumstance that the terminal is smaller then the
+     * requested width.
+     *
      * @var int
      */
     protected $width;
 
     /**
-     * In case the menu is wider than the terminal
-     * The value that we originally shrunk it to
-     * (the width of the terminal)
+     * In case the requested width is wider than the terminal
+     * then we shrink the width to fit the terminal. We keep
+     * the requested size in case the margins are changed and
+     * we need to recalculate the width.
      *
-     * @var bool
+     * @var int
      */
-    private $widthShrunkTo;
+    private $requestedWidth;
 
     /**
      * @var int
      */
-    protected $margin;
+    protected $margin = 0;
 
     /**
      * @var int
@@ -143,6 +152,11 @@ class MenuStyle
      */
     private $marginAuto = false;
 
+    /**
+     * @var bool
+     */
+    private $debugMode = false;
+
     /**
      * Default Values
      *
@@ -255,10 +269,10 @@ public function hasChangedFromDefaults() : bool
         ];
 
         $defaultStyleValues = self::$defaultStyleValues;
-        if ($this->widthShrunkTo) {
-            $defaultStyleValues['width'] = $this->widthShrunkTo;
+        if ($this->width !== $this->requestedWidth) {
+            $defaultStyleValues['width'] = $this->width;
         }
-                
+
         return $currentValues !== array_values($defaultStyleValues);
     }
 
@@ -326,13 +340,14 @@ public function getColoursResetCode() : string
 
     /**
      * Calculate the contents width
+     *
+     * The content width is menu width minus borders and padding.
      */
     protected function calculateContentWidth() : void
     {
         $this->contentWidth = $this->width
             - ($this->paddingLeftRight * 2)
-            - ($this->borderRightWidth + $this->borderLeftWidth)
-            - $this->margin;
+            - ($this->borderRightWidth + $this->borderLeftWidth);
 
         if ($this->contentWidth < 0) {
             $this->contentWidth = 0;
@@ -384,14 +399,12 @@ public function setWidth(int $width) : self
     {
         Assertion::greaterOrEqualThan($width, 0);
 
-        if ($width >= $this->terminal->getWidth()) {
-            $width = $this->terminal->getWidth();
-            $this->widthShrunkTo = $width;
-        }
+        $this->requestedWidth = $width;
+        $width = $this->maybeShrinkWidth($this->margin, $width);
 
         $this->width = $width;
         if ($this->marginAuto) {
-            $this->setMarginAuto();
+            $this->calculateMarginAuto($width);
         }
 
         $this->calculateContentWidth();
@@ -401,6 +414,15 @@ public function setWidth(int $width) : self
         return $this;
     }
 
+    private function maybeShrinkWidth(int $margin, int $width) : int
+    {
+        if ($width + $margin >= $this->terminal->getWidth()) {
+            $width = $this->terminal->getWidth() - $margin;
+        }
+
+        return $width;
+    }
+
     public function getPaddingTopBottom() : int
     {
         return $this->paddingTopBottom;
@@ -421,7 +443,7 @@ private function generatePaddingTopBottomRows() : void
 
         $paddingRow = sprintf(
             "%s%s%s%s%s%s%s%s%s%s\n",
-            str_repeat(' ', $this->margin),
+            $this->debugMode ? $this->getDebugString($this->margin) : str_repeat(' ', $this->margin),
             $borderColour,
             str_repeat(' ', $this->borderLeftWidth),
             $this->getColoursSetCode(),
@@ -433,6 +455,15 @@ private function generatePaddingTopBottomRows() : void
             $this->coloursResetCode
         );
 
+
+        if ($this->debugMode && s::length($paddingRow) <= $this->terminal->getWidth()) {
+            $paddingRow = substr_replace(
+                $paddingRow,
+                sprintf("%s\n", $this->getDebugString($this->terminal->getWidth() - (s::length($paddingRow) - 1))),
+                -1
+            );
+        }
+
         $this->paddingTopBottomRows = array_fill(0, $this->paddingTopBottom, $paddingRow);
     }
 
@@ -485,24 +516,28 @@ public function getMargin() : int
     public function setMarginAuto() : self
     {
         $this->marginAuto = true;
-        $this->margin = (int) floor(($this->terminal->getWidth() - $this->width) / 2);
+        $this->margin = 0;
 
-        $this->generateBorderRows();
-        $this->generatePaddingTopBottomRows();
+        $this->setWidth($this->requestedWidth);
 
         return $this;
     }
 
+    private function calculateMarginAuto(int $width) : void
+    {
+        $this->margin = (int) floor(($this->terminal->getWidth() - ($width)) / 2);
+    }
+
     public function setMargin(int $margin) : self
     {
         Assertion::greaterOrEqualThan($margin, 0);
 
         $this->marginAuto = false;
         $this->margin = $margin;
 
-        $this->calculateContentWidth();
-        $this->generateBorderRows();
-        $this->generatePaddingTopBottomRows();
+        //margin + width may now exceed terminal size
+        //so set width again to trigger width check + maybe resize
+        $this->setWidth($this->requestedWidth);
 
         return $this;
     }
@@ -566,12 +601,20 @@ private function generateBorderRows() : void
     {
         $borderRow = sprintf(
             "%s%s%s%s\n",
-            str_repeat(' ', $this->margin),
+            $this->debugMode ? $this->getDebugString($this->margin) : str_repeat(' ', $this->margin),
             $this->getBorderColourCode(),
-            str_repeat(' ', $this->width - $this->margin),
-            $this->coloursResetCode
+            str_repeat(' ', $this->width),
+            $this->getColoursResetCode()
         );
 
+        if ($this->debugMode && s::length($borderRow) <= $this->terminal->getWidth()) {
+            $borderRow = substr_replace(
+                $borderRow,
+                sprintf("%s\n", $this->getDebugString($this->terminal->getWidth() - (s::length($borderRow) - 1))),
+                -1
+            );
+        }
+
         $this->borderTopRows = array_fill(0, $this->borderTopWidth, $borderRow);
         $this->borderBottomRows = array_fill(0, $this->borderBottomWidth, $borderRow);
     }
@@ -713,4 +756,22 @@ public function getBorderColourCode() : string
 
         return sprintf("\033[%sm", $borderColourCode);
     }
+
+    /**
+     * Get a string of given length consisting of 0-9
+     * eg $length = 15 : 012345678901234
+     */
+    private function getDebugString(int $length) : string
+    {
+        $nums = [];
+        for ($i = 0, $j = 0; $i < $length; $i++, $j++) {
+            if ($j === 10) {
+                $j = 0;
+            }
+
+            $nums[] = $j;
+        }
+
+        return implode('', $nums);
+    }
 }