Merge pull request #34 from tempestphp/static-components

Static components
tempestphp · May 13, 2024 · 34db7a6 · 34db7a6
2 parents cf0b121 + 29d583a
commit 34db7a6
Show file tree

Hide file tree

Showing 43 changed files with 990 additions and 146 deletions.
diff --git a/src/Components/ComponentRenderer.php b/src/Components/ComponentRenderer.php
diff --git a/src/Components/HasStaticComponent.php b/src/Components/HasStaticComponent.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Console\Components;
+
+interface HasStaticComponent
+{
+    public function getStaticComponent(): StaticComponent;
+}
diff --git a/src/Components/ConfirmComponent.php → ...mponents/Interactive/ConfirmComponent.php b/src/Components/ConfirmComponent.php → ...mponents/Interactive/ConfirmComponent.php
@@ -2,23 +2,26 @@
 
 declare(strict_types=1);
 
-namespace Tempest\Console\Components;
+namespace Tempest\Console\Components\Interactive;
 
-use Tempest\Console\ConsoleComponent;
+use Tempest\Console\Components\HasStaticComponent;
+use Tempest\Console\Components\InteractiveComponent;
+use Tempest\Console\Components\Static\StaticConfirmComponent;
+use Tempest\Console\Components\StaticComponent;
 use Tempest\Console\HandlesKey;
 use Tempest\Console\HasCursor;
 use Tempest\Console\HasFooter;
 use Tempest\Console\Key;
 use Tempest\Console\Point;
 
-final class ConfirmComponent implements ConsoleComponent, HasFooter, HasCursor
+final class ConfirmComponent implements InteractiveComponent, HasFooter, HasCursor, HasStaticComponent
 {
     private bool $answer;
     private string $textualAnswer = '';
 
     public function __construct(
         private readonly string $question,
-        bool $default = false,
+        private readonly bool $default = false,
     ) {
         $this->answer = $default;
     }
@@ -81,4 +84,12 @@ public function getCursorPosition(): Point
             y: 0,
         );
     }
+
+    public function getStaticComponent(): StaticComponent
+    {
+        return new StaticConfirmComponent(
+            $this->question,
+            $this->default,
+        );
+    }
 }
diff --git a/src/Components/MultipleChoiceComponent.php → ...s/Interactive/MultipleChoiceComponent.php b/src/Components/MultipleChoiceComponent.php → ...s/Interactive/MultipleChoiceComponent.php
@@ -2,13 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Tempest\Console\Components;
+namespace Tempest\Console\Components\Interactive;
 
-use Tempest\Console\ConsoleComponent;
+use Tempest\Console\Components\HasStaticComponent;
+use Tempest\Console\Components\InteractiveComponent;
+use Tempest\Console\Components\Static\StaticMultipleChoiceComponent;
+use Tempest\Console\Components\StaticComponent;
 use Tempest\Console\HandlesKey;
 use Tempest\Console\Key;
 
-final class MultipleChoiceComponent implements ConsoleComponent
+final class MultipleChoiceComponent implements InteractiveComponent, HasStaticComponent
 {
     public array $selectedOptions = [];
     public int $activeOption;
@@ -88,4 +91,12 @@ public function down(): void
             $this->activeOption = 0;
         }
     }
+
+    public function getStaticComponent(): StaticComponent
+    {
+        return new StaticMultipleChoiceComponent(
+            $this->question,
+            $this->options,
+        );
+    }
 }
diff --git a/src/Components/PasswordComponent.php → ...ponents/Interactive/PasswordComponent.php b/src/Components/PasswordComponent.php → ...ponents/Interactive/PasswordComponent.php
@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Tempest\Console\Components;
+namespace Tempest\Console\Components\Interactive;
 
-use Tempest\Console\ConsoleComponent;
+use Tempest\Console\Components\InteractiveComponent;
 use Tempest\Console\HandlesKey;
 use Tempest\Console\HasCursor;
 use Tempest\Console\HasFooter;
 use Tempest\Console\Key;
 use Tempest\Console\Point;
 
-final class PasswordComponent implements ConsoleComponent, HasCursor, HasFooter
+final class PasswordComponent implements InteractiveComponent, HasCursor, HasFooter
 {
     public string $password = '';
 

diff --git a/src/Components/Interactive/ProgressBarComponent.php b/src/Components/Interactive/ProgressBarComponent.php
@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Console\Components\Interactive;
+
+use Closure;
+use Generator;
+use Tempest\Console\Components\HasStaticComponent;
+use Tempest\Console\Components\InteractiveComponent;
+use Tempest\Console\Components\Static\StaticProgressBarComponent;
+use Tempest\Console\Components\StaticComponent;
+
+final readonly class ProgressBarComponent implements InteractiveComponent, HasStaticComponent
+{
+    public function __construct(
+        private iterable $data,
+        private Closure $handler,
+        /** @var null|Closure(int $step, int $count): string $format */
+        private ?Closure $format = null,
+    ) {
+    }
+
+    public function render(): Generator
+    {
+        $result = [];
+
+        $count = iterator_count($this->data);
+        $step = 1;
+
+        $format = $this->format ?? function (int $step, int $count): string {
+            $width = 30;
+
+            $progress = (int) round(($step / $count) * $width);
+
+            if ($step === $count) {
+                $bar = sprintf(
+                    '[%s]',
+                    str_repeat('=', $width),
+                );
+            } else {
+                $bar = sprintf(
+                    '[%s>%s]',
+                    str_repeat('=', max(0, $progress)),
+                    str_repeat(' ', $width - $progress),
+                );
+            }
+
+            return sprintf(
+                '%s (%s/%s)',
+                $bar,
+                $step,
+                $count,
+            ) . PHP_EOL;
+        };
+
+        foreach ($this->data as $item) {
+            yield $format($step, $count);
+
+            $result[] = ($this->handler)($item);
+
+            $step += 1;
+        }
+
+        return $result;
+    }
+
+    public function getStaticComponent(): StaticComponent
+    {
+        return new StaticProgressBarComponent(
+            data: $this->data,
+            handler: $this->handler,
+            format: $this->format,
+        );
+    }
+}
diff --git a/src/Components/SearchComponent.php → ...omponents/Interactive/SearchComponent.php b/src/Components/SearchComponent.php → ...omponents/Interactive/SearchComponent.php
@@ -2,18 +2,21 @@
 
 declare(strict_types=1);
 
-namespace Tempest\Console\Components;
+namespace Tempest\Console\Components\Interactive;
 
 use Closure;
 use Generator;
-use Tempest\Console\ConsoleComponent;
+use Tempest\Console\Components\HasStaticComponent;
+use Tempest\Console\Components\InteractiveComponent;
+use Tempest\Console\Components\Static\StaticSearchComponent;
+use Tempest\Console\Components\StaticComponent;
 use Tempest\Console\HandlesKey;
 use Tempest\Console\HasCursor;
 use Tempest\Console\HasFooter;
 use Tempest\Console\Key;
 use Tempest\Console\Point;
 
-final class SearchComponent implements ConsoleComponent, HasFooter, HasCursor
+final class SearchComponent implements InteractiveComponent, HasFooter, HasCursor, HasStaticComponent
 {
     public Point $cursorPosition;
     public string $query = '';
@@ -157,4 +160,12 @@ private function isSelected(int $key): bool
     {
         return $this->selectedOption === $key;
     }
+
+    public function getStaticComponent(): StaticComponent
+    {
+        return new StaticSearchComponent(
+            label: $this->label,
+            search: $this->search,
+        );
+    }
 }
diff --git a/src/Components/QuestionComponent.php → ...nts/Interactive/SingleChoiceComponent.php b/src/Components/QuestionComponent.php → ...nts/Interactive/SingleChoiceComponent.php
@@ -2,21 +2,38 @@
 
 declare(strict_types=1);
 
-namespace Tempest\Console\Components;
+namespace Tempest\Console\Components\Interactive;
 
-use Tempest\Console\ConsoleComponent;
+use Tempest\Console\Components\HasStaticComponent;
+use Tempest\Console\Components\InteractiveComponent;
+use Tempest\Console\Components\Static\StaticSingleChoiceComponent;
+use Tempest\Console\Components\StaticComponent;
 use Tempest\Console\HandlesKey;
 use Tempest\Console\Key;
 
-final class QuestionComponent implements ConsoleComponent
+final class SingleChoiceComponent implements InteractiveComponent, HasStaticComponent
 {
     public int $selectedOption;
 
     public function __construct(
         public string $question,
         public array $options,
+        public mixed $default = null,
+        public bool $asList = false,
     ) {
-        $this->selectedOption = array_key_first($this->options);
+        if ($this->default) {
+            foreach ($this->options as $key => $option) {
+                if ($option === $this->default) {
+                    $this->selectedOption = $key;
+
+                    break;
+                }
+            }
+        }
+
+        if (! isset($this->selectedOption)) {
+            $this->selectedOption = array_key_first($this->options);
+        }
     }
 
     public function render(): string
@@ -63,4 +80,14 @@ public function down(): void
             $this->selectedOption = 0;
         }
     }
+
+    public function getStaticComponent(): StaticComponent
+    {
+        return new StaticSingleChoiceComponent(
+            question: $this->question,
+            options: $this->options,
+            default: $this->default,
+            asList: $this->asList,
+        );
+    }
 }
diff --git a/src/Components/TextBoxComponent.php → ...mponents/Interactive/TextBoxComponent.php b/src/Components/TextBoxComponent.php → ...mponents/Interactive/TextBoxComponent.php
@@ -2,16 +2,19 @@
 
 declare(strict_types=1);
 
-namespace Tempest\Console\Components;
+namespace Tempest\Console\Components\Interactive;
 
-use Tempest\Console\ConsoleComponent;
+use Tempest\Console\Components\HasStaticComponent;
+use Tempest\Console\Components\InteractiveComponent;
+use Tempest\Console\Components\Static\StaticTextBoxComponent;
+use Tempest\Console\Components\StaticComponent;
 use Tempest\Console\HandlesKey;
 use Tempest\Console\HasCursor;
 use Tempest\Console\HasFooter;
 use Tempest\Console\Key;
 use Tempest\Console\Point;
 
-final class TextBoxComponent implements ConsoleComponent, HasFooter, HasCursor
+final class TextBoxComponent implements InteractiveComponent, HasFooter, HasCursor, HasStaticComponent
 {
     public Point $cursorPosition;
     public string $answer = '';
@@ -107,4 +110,9 @@ public function getCursorPosition(): Point
             y: $this->cursorPosition->y - 1,
         );
     }
+
+    public function getStaticComponent(): StaticComponent
+    {
+        return new StaticTextBoxComponent($this->label);
+    }
 }
diff --git a/src/ConsoleComponent.php → src/Components/InteractiveComponent.php b/src/ConsoleComponent.php → src/Components/InteractiveComponent.php
@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Tempest\Console;
+namespace Tempest\Console\Components;
 
 use Generator;
 
-interface ConsoleComponent
+interface InteractiveComponent
 {
     public function render(): Generator|string;
 }
diff --git a/src/Components/GenericComponentRenderer.php → ...mponents/InteractiveComponentRenderer.php b/src/Components/GenericComponentRenderer.php → ...mponents/InteractiveComponentRenderer.php
@@ -7,7 +7,6 @@
 use ReflectionClass;
 use ReflectionMethod;
 use Tempest\Console\Console;
-use Tempest\Console\ConsoleComponent;
 use Tempest\Console\Exceptions\InterruptException;
 use Tempest\Console\HandlesKey;
 use Tempest\Console\Key;
@@ -17,13 +16,13 @@
 use Tempest\Validation\Rule;
 use Tempest\Validation\Validator;
 
-final class GenericComponentRenderer implements ComponentRenderer
+final class InteractiveComponentRenderer
 {
     private array $validationErrors = [];
 
     public function render(
         Console $console,
-        ConsoleComponent $component,
+        InteractiveComponent $component,
         array $validation = []
     ): mixed {
         $terminal = new Terminal($console);
@@ -84,7 +83,7 @@ public function render(
         return null;
     }
 
-    private function resolveHandlers(ConsoleComponent $component): array
+    private function resolveHandlers(InteractiveComponent $component): array
     {
         /** @var ReflectionMethod[][] $keyBindings */
         $keyBindings = [];