Support for custom validation and aliases (#102)

* Add "as" and update "validate" type * Support custom validation and alias * Test custom validation and aliases * Ignore new PHPStan error * Fix code styling * Add "as" and update "validate" type * Remove aliases * Update Prompt.php --------- Co-authored-by: Jess Archer <jess@jessarcher.com> Co-authored-by: jessarcher <jessarcher@users.noreply.github.com> Co-authored-by: Taylor Otwell <taylor@laravel.com>
laravel · Dec 29, 2023 · d814a27 · d814a27
1 parent 0930ea9
commit d814a27
Show file tree

Hide file tree

Showing 18 changed files with 251 additions and 42 deletions.
diff --git a/src/ConfirmPrompt.php b/src/ConfirmPrompt.php
@@ -2,8 +2,6 @@
 
 namespace Laravel\Prompts;
 
-use Closure;
-
 class ConfirmPrompt extends Prompt
 {
     /**
@@ -20,8 +18,8 @@ public function __construct(
         public string $yes = 'Yes',
         public string $no = 'No',
         public bool|string $required = false,
-        public ?Closure $validate = null,
-        public string $hint = ''
+        public mixed $validate = null,
+        public string $hint = '',
     ) {
         $this->confirmed = $default;
 

diff --git a/src/MultiSearchPrompt.php b/src/MultiSearchPrompt.php
@@ -35,7 +35,7 @@ public function __construct(
         public string $placeholder = '',
         public int $scroll = 5,
         public bool|string $required = false,
-        public ?Closure $validate = null,
+        public mixed $validate = null,
         public string $hint = '',
     ) {
         $this->trackTypedValue(submit: false, ignore: fn ($key) => Key::oneOf([Key::SPACE, Key::HOME, Key::END, Key::CTRL_A, Key::CTRL_E], $key) && $this->highlighted !== null);

diff --git a/src/MultiSelectPrompt.php b/src/MultiSelectPrompt.php
@@ -2,7 +2,6 @@
 
 namespace Laravel\Prompts;
 
-use Closure;
 use Illuminate\Support\Collection;
 
 class MultiSelectPrompt extends Prompt
@@ -42,8 +41,8 @@ public function __construct(
         array|Collection $default = [],
         public int $scroll = 5,
         public bool|string $required = false,
-        public ?Closure $validate = null,
-        public string $hint = ''
+        public mixed $validate = null,
+        public string $hint = '',
     ) {
         $this->options = $options instanceof Collection ? $options->all() : $options;
         $this->default = $default instanceof Collection ? $default->all() : $default;

diff --git a/src/PasswordPrompt.php b/src/PasswordPrompt.php
@@ -2,8 +2,6 @@
 
 namespace Laravel\Prompts;
 
-use Closure;
-
 class PasswordPrompt extends Prompt
 {
     use Concerns\TypedValue;
@@ -15,8 +13,8 @@ public function __construct(
         public string $label,
         public string $placeholder = '',
         public bool|string $required = false,
-        public ?Closure $validate = null,
-        public string $hint = ''
+        public mixed $validate = null,
+        public string $hint = '',
     ) {
         $this->trackTypedValue();
     }

diff --git a/src/Prompt.php b/src/Prompt.php
@@ -45,9 +45,9 @@ abstract class Prompt
     public bool|string $required;
 
     /**
-     * The validator callback.
+     * The validator callback or rules.
      */
-    protected ?Closure $validate;
+    public mixed $validate;
 
     /**
      * The cancellation callback.
@@ -59,6 +59,11 @@ abstract class Prompt
      */
     protected bool $validated = false;
 
+    /**
+     * The custom validation callback.
+     */
+    protected static ?Closure $validateUsing;
+
     /**
      * The output instance.
      */
@@ -190,6 +195,14 @@ public static function terminal(): Terminal
         return static::$terminal ??= new Terminal();
     }
 
+    /**
+     * Set the custom validation callback.
+     */
+    public static function validateUsing(Closure $callback): void
+    {
+        static::$validateUsing = $callback;
+    }
+
     /**
      * Render the prompt.
      */
@@ -331,14 +344,18 @@ private function validate(mixed $value): void
             return;
         }
 
-        if (! isset($this->validate)) {
+        if (! isset($this->validate) && ! isset(static::$validateUsing)) {
             return;
         }
 
-        $error = ($this->validate)($value);
+        $error = match (true) {
+            is_callable($this->validate) => ($this->validate)($value),
+            isset(static::$validateUsing) => (static::$validateUsing)($this),
+            default => throw new RuntimeException('The validation logic is missing.'),
+        };
 
         if (! is_string($error) && ! is_null($error)) {
-            throw new \RuntimeException('The validator must return a string or null.');
+            throw new RuntimeException('The validator must return a string or null.');
         }
 
         if (is_string($error) && strlen($error) > 0) {

diff --git a/src/SearchPrompt.php b/src/SearchPrompt.php
@@ -28,7 +28,7 @@ public function __construct(
         public Closure $options,
         public string $placeholder = '',
         public int $scroll = 5,
-        public ?Closure $validate = null,
+        public mixed $validate = null,
         public string $hint = '',
         public bool|string $required = true,
     ) {

diff --git a/src/SelectPrompt.php b/src/SelectPrompt.php
@@ -2,7 +2,6 @@
 
 namespace Laravel\Prompts;
 
-use Closure;
 use Illuminate\Support\Collection;
 use InvalidArgumentException;
 
@@ -27,7 +26,7 @@ public function __construct(
         array|Collection $options,
         public int|string|null $default = null,
         public int $scroll = 5,
-        public ?Closure $validate = null,
+        public mixed $validate = null,
         public string $hint = '',
         public bool|string $required = true,
     ) {

diff --git a/src/SuggestPrompt.php b/src/SuggestPrompt.php
@@ -37,8 +37,8 @@ public function __construct(
         public string $default = '',
         public int $scroll = 5,
         public bool|string $required = false,
-        public ?Closure $validate = null,
-        public string $hint = ''
+        public mixed $validate = null,
+        public string $hint = '',
     ) {
         $this->options = $options instanceof Collection ? $options->all() : $options;
 

diff --git a/src/TextPrompt.php b/src/TextPrompt.php
@@ -2,8 +2,6 @@
 
 namespace Laravel\Prompts;
 
-use Closure;
-
 class TextPrompt extends Prompt
 {
     use Concerns\TypedValue;
@@ -16,8 +14,8 @@ public function __construct(
         public string $placeholder = '',
         public string $default = '',
         public bool|string $required = false,
-        public ?Closure $validate = null,
-        public string $hint = ''
+        public mixed $validate = null,
+        public string $hint = '',
     ) {
         $this->trackTypedValue($default);
     }

diff --git a/src/helpers.php b/src/helpers.php
@@ -8,17 +8,17 @@
 /**
  * Prompt the user for text input.
  */
-function text(string $label, string $placeholder = '', string $default = '', bool|string $required = false, ?Closure $validate = null, string $hint = ''): string
+function text(string $label, string $placeholder = '', string $default = '', bool|string $required = false, mixed $validate = null, string $hint = ''): string
 {
-    return (new TextPrompt($label, $placeholder, $default, $required, $validate, $hint))->prompt();
+    return (new TextPrompt(...func_get_args()))->prompt();
 }
 
 /**
  * Prompt the user for input, hiding the value.
  */
-function password(string $label, string $placeholder = '', bool|string $required = false, ?Closure $validate = null, string $hint = ''): string
+function password(string $label, string $placeholder = '', bool|string $required = false, mixed $validate = null, string $hint = ''): string
 {
-    return (new PasswordPrompt($label, $placeholder, $required, $validate, $hint))->prompt();
+    return (new PasswordPrompt(...func_get_args()))->prompt();
 }
 
 /**
@@ -27,9 +27,9 @@ function password(string $label, string $placeholder = '', bool|string $required
  * @param  array<int|string, string>|Collection<int|string, string>  $options
  * @param  true|string  $required
  */
-function select(string $label, array|Collection $options, int|string|null $default = null, int $scroll = 5, ?Closure $validate = null, string $hint = '', bool|string $required = true): int|string
+function select(string $label, array|Collection $options, int|string|null $default = null, int $scroll = 5, mixed $validate = null, string $hint = '', bool|string $required = true): int|string
 {
-    return (new SelectPrompt($label, $options, $default, $scroll, $validate, $hint, $required))->prompt();
+    return (new SelectPrompt(...func_get_args()))->prompt();
 }
 
 /**
@@ -39,27 +39,27 @@ function select(string $label, array|Collection $options, int|string|null $defau
  * @param  array<int|string>|Collection<int, int|string>  $default
  * @return array<int|string>
  */
-function multiselect(string $label, array|Collection $options, array|Collection $default = [], int $scroll = 5, bool|string $required = false, ?Closure $validate = null, string $hint = 'Use the space bar to select options.'): array
+function multiselect(string $label, array|Collection $options, array|Collection $default = [], int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = 'Use the space bar to select options.'): array
 {
-    return (new MultiSelectPrompt($label, $options, $default, $scroll, $required, $validate, $hint))->prompt();
+    return (new MultiSelectPrompt(...func_get_args()))->prompt();
 }
 
 /**
  * Prompt the user to confirm an action.
  */
-function confirm(string $label, bool $default = true, string $yes = 'Yes', string $no = 'No', bool|string $required = false, ?Closure $validate = null, string $hint = ''): bool
+function confirm(string $label, bool $default = true, string $yes = 'Yes', string $no = 'No', bool|string $required = false, mixed $validate = null, string $hint = ''): bool
 {
-    return (new ConfirmPrompt($label, $default, $yes, $no, $required, $validate, $hint))->prompt();
+    return (new ConfirmPrompt(...func_get_args()))->prompt();
 }
 
 /**
  * Prompt the user for text input with auto-completion.
  *
  * @param  array<string>|Collection<int, string>|Closure(string): array<string>  $options
  */
-function suggest(string $label, array|Collection|Closure $options, string $placeholder = '', string $default = '', int $scroll = 5, bool|string $required = false, ?Closure $validate = null, string $hint = ''): string
+function suggest(string $label, array|Collection|Closure $options, string $placeholder = '', string $default = '', int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = ''): string
 {
-    return (new SuggestPrompt($label, $options, $placeholder, $default, $scroll, $required, $validate, $hint))->prompt();
+    return (new SuggestPrompt(...func_get_args()))->prompt();
 }
 
 /**
@@ -68,9 +68,9 @@ function suggest(string $label, array|Collection|Closure $options, string $place
  * @param  Closure(string): array<int|string, string>  $options
  * @param  true|string  $required
  */
-function search(string $label, Closure $options, string $placeholder = '', int $scroll = 5, ?Closure $validate = null, string $hint = '', bool|string $required = true): int|string
+function search(string $label, Closure $options, string $placeholder = '', int $scroll = 5, mixed $validate = null, string $hint = '', bool|string $required = true): int|string
 {
-    return (new SearchPrompt($label, $options, $placeholder, $scroll, $validate, $hint, $required))->prompt();
+    return (new SearchPrompt(...func_get_args()))->prompt();
 }
 
 /**
@@ -79,9 +79,9 @@ function search(string $label, Closure $options, string $placeholder = '', int $
  * @param  Closure(string): array<int|string, string>  $options
  * @return array<int|string>
  */
-function multisearch(string $label, Closure $options, string $placeholder = '', int $scroll = 5, bool|string $required = false, ?Closure $validate = null, string $hint = 'Use the space bar to select options.'): array
+function multisearch(string $label, Closure $options, string $placeholder = '', int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = 'Use the space bar to select options.'): array
 {
-    return (new MultiSearchPrompt($label, $options, $placeholder, $scroll, $required, $validate, $hint))->prompt();
+    return (new MultiSearchPrompt(...func_get_args()))->prompt();
 }
 
 /**

diff --git a/tests/Feature/ConfirmPromptTest.php b/tests/Feature/ConfirmPromptTest.php
@@ -118,3 +118,21 @@
         required: true,
     );
 })->throws(NonInteractiveValidationException::class, 'Required.');
+
+it('supports custom validation', function () {
+    Prompt::validateUsing(function (Prompt $prompt) {
+        expect($prompt)
+            ->label->toBe('Are you sure?')
+            ->validate->toBe('confirmed');
+
+        return $prompt->validate === 'confirmed' && ! $prompt->value() ? 'Need to be sure!' : null;
+    });
+
+    Prompt::fake([Key::DOWN, Key::ENTER, Key::UP, Key::ENTER]);
+
+    confirm(label: 'Are you sure?', validate: 'confirmed');
+
+    Prompt::assertOutputContains('Need to be sure!');
+
+    Prompt::validateUsing(fn () => null);
+});
diff --git a/tests/Feature/MultiSearchPromptTest.php b/tests/Feature/MultiSearchPromptTest.php
@@ -184,3 +184,31 @@
 
     expect($result)->toBe(['result']);
 });
+
+it('supports custom validation', function () {
+    Prompt::fake(['a', Key::DOWN, Key::SPACE, Key::ENTER, Key::DOWN, Key::SPACE, Key::ENTER]);
+
+    Prompt::validateUsing(function (Prompt $prompt) {
+        expect($prompt)
+            ->label->toBe('What are your favorite colors?')
+            ->validate->toBe('in:green');
+
+        return $prompt->validate === 'in:green' && ! in_array('green', $prompt->value()) ? 'And green?' : null;
+    });
+
+    $result = multisearch(
+        label: 'What are your favorite colors?',
+        options: fn () => [
+            'red' => 'Red',
+            'green' => 'Green',
+            'blue' => 'Blue',
+        ],
+        validate: 'in:green',
+    );
+
+    expect($result)->toBe(['red', 'green']);
+
+    Prompt::assertOutputContains('And green?');
+
+    Prompt::validateUsing(fn () => null);
+});
diff --git a/tests/Feature/MultiSelectPromptTest.php b/tests/Feature/MultiSelectPromptTest.php
@@ -203,3 +203,31 @@
         'Blue',
     ], required: true);
 })->throws(NonInteractiveValidationException::class, 'Required.');
+
+it('supports custom validation', function () {
+    Prompt::fake([Key::SPACE, Key::ENTER, Key::DOWN, Key::SPACE, Key::ENTER]);
+
+    Prompt::validateUsing(function (Prompt $prompt) {
+        expect($prompt)
+            ->label->toBe('What are your favorite colors?')
+            ->validate->toBe('in:green');
+
+        return $prompt->validate === 'in:green' && ! in_array('green', $prompt->value()) ? 'And green?' : null;
+    });
+
+    $result = multiselect(
+        label: 'What are your favorite colors?',
+        options: [
+            'red' => 'Red',
+            'green' => 'Green',
+            'blue' => 'Blue',
+        ],
+        validate: 'in:green',
+    );
+
+    expect($result)->toBe(['red', 'green']);
+
+    Prompt::assertOutputContains('And green?');
+
+    Prompt::validateUsing(fn () => null);
+});
diff --git a/tests/Feature/PasswordPromptTest.php b/tests/Feature/PasswordPromptTest.php
@@ -79,3 +79,26 @@
 
     password('What is the password?', required: true);
 })->throws(NonInteractiveValidationException::class, 'Required.');
+
+it('supports custom validation', function () {
+    Prompt::validateUsing(function (Prompt $prompt) {
+        expect($prompt)
+            ->label->toBe('What is the password?')
+            ->validate->toBe('min:8');
+
+        return $prompt->validate === 'min:8' && strlen($prompt->value()) < 8 ? 'Minimum 8 chars!' : null;
+    });
+
+    Prompt::fake(['p', Key::ENTER, 'a', 's', 's', 'w', 'o', 'r', 'd', Key::ENTER]);
+
+    $result = password(
+        label: 'What is the password?',
+        validate: 'min:8',
+    );
+
+    expect($result)->toBe('password');
+
+    Prompt::assertOutputContains('Minimum 8 chars!');
+
+    Prompt::validateUsing(fn () => null);
+});