Removed Assert::naturalNumber(), since we already have `Assert::nat…

…ural()` doing the same thing

Note: we refined the assertion on `Assert::natural()` to correctly restrict to `positive-int|0`,
but we had to remove some minor test on `Assert::allNaturalNumber()` due to `@psalm-assert iterable<positive-int|0>`
not yet working in upstream.

See vimeo/psalm#5052

src/Assert.php

@@ -126,25 +126,6 @@ public static function positiveInteger($value, $message = '')
         }
     }
 
-    /**
-     * @psalm-pure
-     * @psalm-assert positive-int|0 $value
-     *
-     * @param mixed  $value
-     * @param string $message
-     *
-     * @throws InvalidArgumentException
-     */
-    public static function naturalNumber($value, $message = '')
-    {
-        if (! (\is_int($value) && $value > 0)) {
-            static::reportInvalidArgument(\sprintf(
-                $message ?: 'Expected a positive integer. Got: %s',
-                static::valueToString($value)
-            ));
-        }
-    }
-
     /**
      * @psalm-pure
      * @psalm-assert float $value
@@ -185,7 +166,7 @@ public static function numeric($value, $message = '')
 
     /**
      * @psalm-pure
-     * @psalm-assert int $value
+     * @psalm-assert positive-int|0 $value
      *
      * @param mixed  $value
      * @param string $message

src/Mixin.php

@@ -168,36 +168,6 @@ public static function allPositiveInteger($value, $message = '')
         static::__callStatic('allPositiveInteger', [$value, $message]);
     }
 
-    /**
-     * @psalm-pure
-     * @psalm-assert positive-int|0|null $value
-     *
-     * @param mixed  $value
-     * @param string $message
-     *
-     * @throws InvalidArgumentException
-     * @return void
-     */
-    public static function nullOrNaturalNumber($value, $message = '')
-    {
-        static::__callStatic('nullOrNaturalNumber', [$value, $message]);
-    }
-
-    /**
-     * @psalm-pure
-     * @psalm-assert iterable<positive-int|0> $value
-     *
-     * @param mixed  $value
-     * @param string $message
-     *
-     * @throws InvalidArgumentException
-     * @return void
-     */
-    public static function allNaturalNumber($value, $message = '')
-    {
-        static::__callStatic('allNaturalNumber', [$value, $message]);
-    }
-
     /**
      * @psalm-pure
      * @psalm-assert float|null $value
@@ -260,7 +230,7 @@ public static function allNumeric($value, $message = '')
 
     /**
      * @psalm-pure
-     * @psalm-assert int|null $value
+     * @psalm-assert positive-int|0|null $value
      *
      * @param mixed  $value
      * @param string $message
@@ -275,7 +245,7 @@ public static function nullOrNatural($value, $message = '')
 
     /**
      * @psalm-pure
-     * @psalm-assert iterable<int> $value
+     * @psalm-assert iterable<positive-int|0> $value
      *
      * @param mixed  $value
      * @param string $message

tests/static-analysis/assert-natural.php

@@ -8,6 +8,8 @@
  * @psalm-pure
  *
  * @param mixed $value
+ *
+ * @psalm-return positive-int|0
  */
 function natural($value): int
 {
@@ -20,6 +22,8 @@ function natural($value): int
  * @psalm-pure
  *
  * @param mixed $value
+ *
+ * @psalm-return positive-int|0|null
  */
 function nullOrNatural($value): ?int
 {
@@ -33,7 +37,10 @@ function nullOrNatural($value): ?int
  *
  * @param mixed $value
  *
- * @return iterable<int>
+ * @return iterable<positive-int|0>
+ *
+ * @psalm-suppress MixedInferredReturnType https://github.com/vimeo/psalm/issues/5052
+ * @psalm-suppress MixedReturnStatement https://github.com/vimeo/psalm/issues/5052
  */
 function allNatural($value): iterable
 {