Fix description block excessive padding in HelpGenerator.

Author: MagicPush

docs/changelog.md

@@ -13,6 +13,8 @@ This change log references the repository changes and releases, which respect [s
    in your production classes under 'dev' environment (when you call `composer install` without `--no-dev` option),
    you will get "Class 'XXX' not found in ..." error.
    Previously there was no error, until you install composer packages with `--no-dev` flag.
+1. Fixed scripts main description block - stopped counting symbols in space-only lines.
+   Previously it caused too much padding for descriptions with too short space-only lines.
 
 ## v2.0.0
 

src/Parametizer/Config/HelpGenerator.php

@@ -123,9 +123,12 @@ public function getDescriptionBlock(): string {
         // 3. Determine the minimum heading spaces count in all lines of description.
         $descriptionLines      = explode(PHP_EOL, $description);
         $minHeadingSpacesCount = null;
-        foreach ($descriptionLines as $line) {
-            // Do not count empty lines:
-            if (!$line) {
+        foreach ($descriptionLines as $lineIndex => $line) {
+            // 4. Trim space-only lines.
+            // Ignore empty and space-only lines:
+            if (!trim($line)) {
+                $descriptionLines[$lineIndex] = '';
+
                 continue;
             }
 
@@ -135,19 +138,14 @@ public function getDescriptionBlock(): string {
             }
         }
 
-        // 4. Delete that many heading spaces from each line.
+        // 5. Delete that many heading spaces from each line.
         if ($minHeadingSpacesCount) {
-            foreach ($descriptionLines as &$line) {
-                // 5. Trim space-only lines.
-                if (!trim($line)) {
-                    $line = '';
-                }
-
+            foreach ($descriptionLines as $lineIndex => $line) {
                 if (!$line) {
                     continue;
                 }
 
-                $line = mb_substr($line, $minHeadingSpacesCount);
+                $descriptionLines[$lineIndex] = mb_substr($line, $minHeadingSpacesCount);
             }
             unset($line);
 

tests/Tests/Parametizer/HelpGenerator/HelpGeneratorTest.php

@@ -23,6 +23,7 @@ class HelpGeneratorTest extends TestCaseAbstract {
      *
      * @see HelpGenerator::getFullHelp()
      * @see HelpGenerator::getParamsBlock()
+     * @see HelpGenerator::getDescriptionBlock()
      */
     public function testScriptHelp(): void {
         assertSame(

tests/Tests/Parametizer/HelpGenerator/scripts/lots-of-params.php

@@ -7,16 +7,24 @@
 require_once __DIR__ . '/../../../init-console.php';
 
 Parametizer::newConfig(throwOnException: true)
+    /*
+     * There is excessive padding.
+     * Also pay attention at the blank line with 4 spaces under the first paragraph: in previous version it caused
+     * the whole help block to be shown as is with such a huge padding. The point is that the length of this exact
+     * space-line negatively affected the whole block minimum padding. However now it should be ignored at all,
+     * so eventually there should be correct padding for the whole block.
+     */
     ->description('
-        Here is a very very very very long description.
-        So long that multiple lines are needed.
-        
-        And there is more than that! Here is a list with padding, which should be outputted the same way in a terminal:
-            1. Start with this step.
-            2. Proceed with doing this thing.
-            3. Finally finish by doing this stuff.
-            
-                                            HERE IS SOME MORE PADDED TEXT
+                Here is a very very very very long description.
+                So long that multiple lines are needed.
+    
+                And there is more than that! Here is a list with padding, which should be outputted the same way '
+                . 'in a terminal:
+                    1. Start with this step.
+                    2. Proceed with doing this thing.
+                    3. Finally finish by doing this stuff.
+                    
+                                                    HERE IS SOME MORE PADDED TEXT