Add more specific psalm type for result of Random::string() method (#…

…53)

* Add more specific psalm type for result of `Random::string()` method

* fix typo

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.0.2 under development
 
 - Bug #35: Add missed `ext-hash` and `ext-openssl` dependencies (@vjik)
+- Enh #53: Add more specific psalm type for result of `Random::string()` method (@vjik)
 
 ## 1.0.1 February 10, 2021
 

src/Random.php

@@ -4,12 +4,14 @@
 
 namespace Yiisoft\Security;
 
+use Exception;
+use InvalidArgumentException;
 use Yiisoft\Strings\StringHelper;
 
 /**
  * Random allows generating random values.
  *
- * Currently it has a single method "string".
+ * Currently, it has a single method "string".
  * The following extras are available via PHP directly:
  *
  * - `random_bytes()` for bytes. Note that output may not be ASCII.
@@ -23,19 +25,25 @@ final class Random
      *
      * @param int $length The length of the key in characters.
      *
-     * @throws \Exception On failure.
+     * @throws Exception On failure.
      *
      * @return string The generated random key.
+     *
+     * @psalm-return non-empty-string
      */
     public static function string(int $length = 32): string
     {
         if ($length < 1) {
-            throw new \InvalidArgumentException('First parameter ($length) must be greater than 0.');
+            throw new InvalidArgumentException('First parameter ($length) must be greater than 0.');
         }
 
-        // Optimization: we can generate a quarter fewer bits to completely cover the desired length in base64
-        /** @psalm-suppress ArgumentTypeCoercion */
+        /**
+         * Optimization: we can generate a quarter fewer bits to completely cover the desired length in base64
+         * @psalm-suppress ArgumentTypeCoercion
+         */
         $bytes = random_bytes((int) ceil($length * 0.75));
+
+        /** @var non-empty-string */
         return substr(StringHelper::base64UrlEncode($bytes), 0, $length);
     }
 }