From 81b58bb543db10907b2529e49f7ca9e9d38fdfff Mon Sep 17 00:00:00 2001
From: Allan Mariucci Carvalho <allan.m.carvalho@outlook.com>
Date: Wed, 21 Feb 2024 16:25:08 -0300
Subject: [PATCH] Added pause prompt (#108)

* Added pause prompt

* refactoring

* Ignore when non-interactive

* Update helpers.php

---------

Co-authored-by: Jess Archer <jess@jessarcher.com>
Co-authored-by: Taylor Otwell <taylor@laravel.com>
---
 playground/pause.php                       |  9 ++++
 src/Concerns/Themes.php                    |  3 ++
 src/PausePrompt.php                        | 27 +++++++++++
 src/Themes/Default/PausePromptRenderer.php | 24 ++++++++++
 src/helpers.php                            |  8 ++++
 tests/Feature/PausePromptTest.php          | 52 ++++++++++++++++++++++
 6 files changed, 123 insertions(+)
 create mode 100644 playground/pause.php
 create mode 100644 src/PausePrompt.php
 create mode 100644 src/Themes/Default/PausePromptRenderer.php
 create mode 100644 tests/Feature/PausePromptTest.php

diff --git a/playground/pause.php b/playground/pause.php
new file mode 100644
index 00000000..d10c1c17
--- /dev/null
+++ b/playground/pause.php
@@ -0,0 +1,9 @@
+<?php
+
+use function Laravel\Prompts\pause;
+
+require __DIR__.'/../vendor/autoload.php';
+
+$continued = pause();
+
+var_dump($continued);
diff --git a/src/Concerns/Themes.php b/src/Concerns/Themes.php
index 62e61142..f2fe3b57 100644
--- a/src/Concerns/Themes.php
+++ b/src/Concerns/Themes.php
@@ -8,6 +8,7 @@
 use Laravel\Prompts\MultiSelectPrompt;
 use Laravel\Prompts\Note;
 use Laravel\Prompts\PasswordPrompt;
+use Laravel\Prompts\PausePrompt;
 use Laravel\Prompts\Progress;
 use Laravel\Prompts\SearchPrompt;
 use Laravel\Prompts\SelectPrompt;
@@ -20,6 +21,7 @@
 use Laravel\Prompts\Themes\Default\MultiSelectPromptRenderer;
 use Laravel\Prompts\Themes\Default\NoteRenderer;
 use Laravel\Prompts\Themes\Default\PasswordPromptRenderer;
+use Laravel\Prompts\Themes\Default\PausePromptRenderer;
 use Laravel\Prompts\Themes\Default\ProgressRenderer;
 use Laravel\Prompts\Themes\Default\SearchPromptRenderer;
 use Laravel\Prompts\Themes\Default\SelectPromptRenderer;
@@ -47,6 +49,7 @@ trait Themes
             SelectPrompt::class => SelectPromptRenderer::class,
             MultiSelectPrompt::class => MultiSelectPromptRenderer::class,
             ConfirmPrompt::class => ConfirmPromptRenderer::class,
+            PausePrompt::class => PausePromptRenderer::class,
             SearchPrompt::class => SearchPromptRenderer::class,
             MultiSearchPrompt::class => MultiSearchPromptRenderer::class,
             SuggestPrompt::class => SuggestPromptRenderer::class,
diff --git a/src/PausePrompt.php b/src/PausePrompt.php
new file mode 100644
index 00000000..65605d58
--- /dev/null
+++ b/src/PausePrompt.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Laravel\Prompts;
+
+class PausePrompt extends Prompt
+{
+    /**
+     * Create a new PausePrompt instance.
+     */
+    public function __construct(public string $message = 'Press enter to continue...') {
+        $this->required = false;
+        $this->validate = null;
+
+        $this->on('key', fn ($key) => match($key) {
+            Key::ENTER => $this->submit(),
+            default => null,
+        });
+    }
+
+    /**
+     * Get the value of the prompt.
+     */
+    public function value(): bool
+    {
+        return static::$interactive;
+    }
+}
diff --git a/src/Themes/Default/PausePromptRenderer.php b/src/Themes/Default/PausePromptRenderer.php
new file mode 100644
index 00000000..242be178
--- /dev/null
+++ b/src/Themes/Default/PausePromptRenderer.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Laravel\Prompts\Themes\Default;
+
+use Laravel\Prompts\PausePrompt;
+
+class PausePromptRenderer extends Renderer
+{
+    use Concerns\DrawsBoxes;
+
+    /**
+     * Render the pause prompt.
+     */
+    public function __invoke(PausePrompt $prompt): string
+    {
+        match ($prompt->state) {
+            'submit' => collect(explode(PHP_EOL, $prompt->message))
+                ->each(fn($line) => $this->line($this->gray(" {$line}"))),
+            default => collect(explode(PHP_EOL, $prompt->message))
+                ->each(fn($line) => $this->line($this->green(" {$line}")))
+        };
+        return $this;
+    }
+}
diff --git a/src/helpers.php b/src/helpers.php
index d5e60b68..8c05b784 100644
--- a/src/helpers.php
+++ b/src/helpers.php
@@ -52,6 +52,14 @@ function confirm(string $label, bool $default = true, string $yes = 'Yes', strin
     return (new ConfirmPrompt(...func_get_args()))->prompt();
 }
 
+/**
+ * Prompt the user to continue or cancel after pausing.
+ */
+function pause(string $message = 'Press enter to continue...'): bool
+{
+    return (new PausePrompt(...func_get_args()))->prompt();
+}
+
 /**
  * Prompt the user for text input with auto-completion.
  *
diff --git a/tests/Feature/PausePromptTest.php b/tests/Feature/PausePromptTest.php
new file mode 100644
index 00000000..66b1bd7b
--- /dev/null
+++ b/tests/Feature/PausePromptTest.php
@@ -0,0 +1,52 @@
+<?php
+
+use Laravel\Prompts\Key;
+use Laravel\Prompts\PausePrompt;
+use Laravel\Prompts\Prompt;
+
+use function Laravel\Prompts\pause;
+
+it('continues after enter', function () {
+    Prompt::fake([Key::ENTER]);
+
+    $result = pause();
+
+    expect($result)->toBeTrue();
+
+    Prompt::assertOutputContains('Press enter to continue...');
+});
+
+it('allows the message to be changed', function () {
+    Prompt::fake([Key::ENTER]);
+
+    $result = pause('Read and then press enter...');
+
+    expect($result)->toBeTrue();
+
+    Prompt::assertOutputContains('Read and then press enter...');
+});
+
+it('can fall back', function () {
+    Prompt::fallbackWhen(true);
+
+    PausePrompt::fallbackUsing(function (PausePrompt $prompt) {
+        expect($prompt->message)->toBe('Press enter to continue...');
+
+        return true;
+    });
+
+    $result = pause();
+
+    expect($result)->toBeTrue();
+});
+
+it('does not render when non-interactive', function () {
+    Prompt::fake();
+    Prompt::interactive(false);
+
+    $result = pause('This should not be rendered');
+
+    expect($result)->toBeFalse();
+
+    Prompt::assertOutputDoesntContain('This should not be rendered');
+});