47 hidden prompt (#48)

47 hidden prompt

Author: adhocore

README.md

@@ -317,7 +317,7 @@ $interactor->greenBold("Anything is: $any", true);
 ```php
 $nameValidator = function ($value) {
     if (\strlen($value) < 5) {
-        throw new \Exception('Name should be atleast 5 chars');
+        throw new \InvalidArgumentException('Name should be atleast 5 chars');
     }
 
     return $value;
@@ -328,6 +328,22 @@ $name = $interactor->prompt('Name', null, $nameValidator, 5);
 $interactor->greenBold("The name is: $name", true);
 ```
 
+#### Prompt hidden
+
+> Currently not supported in windows platform, but maybe supported in future.
+
+```php
+$passValidator = function ($pass) {
+    if (\strlen($pass) < 6) {
+        throw new \InvalidArgumentException('Password too short');
+    }
+
+    return $pass;
+};
+
+$pass = $interactor->promptHidden('Password', $passValidator, 2);
+```
+
 ![Interactive Preview](https://i.imgur.com/qYBNd29.gif "Interactive Preview")
 
 ## IO Components

src/IO/Interactor.php

@@ -280,25 +280,50 @@ public function choices(string $text, array $choices, $default = null, bool $cas
      */
     public function prompt(string $text, $default = null, callable $fn = null, int $retry = 3)
     {
-        $error = 'Invalid value. Please try again!';
+        $error  = 'Invalid value. Please try again!';
+        $hidden = \func_get_args()[4] ?? false;
+        $readFn = $hidden ? 'readHidden' : 'read';
 
         $this->writer->yellow($text)->comment(null !== $default ? " [$default]: " : ': ');
 
         try {
-            $input = $this->reader->read($default, $fn);
+            $input = $this->reader->{$readFn}($default, $fn);
         } catch (\Exception $e) {
             $error = $e->getMessage();
         }
 
         if ($retry > 0 && (isset($e) || \strlen($input ?? '') === 0)) {
             $this->writer->bgRed($error, true);
 
-            return $this->prompt($text, $default, $fn, $retry - 1);
+            return $this->prompt($text, $default, $fn, $retry - 1, $hidden);
         }
 
         return $input ?? $default;
     }
 
+    /**
+     * Prompt user for secret input like password. Currently for unix only.
+     *
+     * @param string        $text  Prompt text.
+     * @param callable|null $fn    The sanitizer/validator for user input
+     *                             Any exception message is printed as error.
+     * @param int           $retry How many more times to retry on failure.
+     *
+     * @return mixed
+     */
+    public function promptHidden(string $text, callable $fn = null, int $retry = 3)
+    {
+        $winOS = '\\' === \DIRECTORY_SEPARATOR;
+
+        // @codeCoverageIgnoreStart
+        if ($winOS) {
+            $this->writer->error('Hidden input not supported, Press Ctrl+C if you would like to abort', true);
+        }
+        // @codeCoverageIgnoreEnd
+
+        return $this->prompt($text, null, $fn, $retry, !$winOS);
+    }
+
     /**
      * Show choices list.
      *

src/Input/Reader.php

@@ -52,4 +52,22 @@ public function read($default = null, callable $fn = null)
 
         return $fn ? $fn($in) : $in;
     }
+
+    /**
+     * Read a line from configured stream (or terminal) but don't echo it back.
+     *
+     * @param callable|null $fn The validator/sanitizer callback.
+     *
+     * @return mixed
+     */
+    public function readHidden($default = null, callable $fn = null)
+    {
+        \shell_exec('stty -echo');
+        $in = $this->read($default, $fn);
+        \shell_exec('stty echo');
+
+        echo \PHP_EOL;
+
+        return $in;
+    }
 }

tests/IO/InteractorTest.php

@@ -130,6 +130,15 @@ public function test_prompt_filter()
         $this->assertContains('gte 5', file_get_contents(static::$ou));
     }
 
+    public function test_prompt_hidden()
+    {
+        $i = $this->newInteractor('abcde');
+
+        $this->assertSame('abcde', $i->promptHidden('pass'));
+
+        $this->assertNotContains('abcde', file_get_contents(static::$ou));
+    }
+
     public function test_call()
     {
         $i = $this->newInteractor('');