Add keysInteger

Fixes webmozarts#213

Signed-off-by: Maximilian Bösing <[email protected]>

README.md

@@ -111,6 +111,7 @@ Method                                                   | Description
 `isNotA($value, $class, $message = '')`                  | Check that a value is not of the class or has not one of its parents
 `isArrayAccessible($value, $message = '')`               | Check that a value can be accessed as an array
 `uniqueValues($values, $message = '')`                   | Check that the given array contains unique values
+`keysInteger($value, $message = '')`                     | Check that the given iterable contains only integer keys
 
 ### Comparison Assertions
 

src/Assert.php

@@ -1707,6 +1707,23 @@ public static function validArrayKey($value, $message = '')
         }
     }
 
+    /**
+     * @psalm-pure
+     * @psalm-template T
+     * @psalm-param iterable<T> $array
+     * @psalm-assert iterable<int, T> $array
+     *
+     * @param mixed $value
+     * @param string $message
+     *
+     * @throws InvalidArgumentException
+     */
+    public static function keysInteger($value, $message = '')
+    {
+        static::isIterable($value, $message);
+        static::allInteger(array_keys(is_array($value) ? $value : iterator_to_array($value)), $message);
+    }
+
     /**
      * Does not check if $array is countable, this can generate a warning on php versions after 7.2.
      *

src/Mixin.php

@@ -1759,6 +1759,32 @@ public static function nullOrValidArrayKey($value, $message = '');
      */
     public static function allValidArrayKey($value, $message = '');
 
+    /**
+     * @psalm-pure
+     * @psalm-template T
+     * @psalm-param iterable<T> $array
+     * @psalm-assert null|iterable<int, T> $array
+     *
+     * @param mixed  $value
+     * @param string $message
+     *
+     * @throws InvalidArgumentException
+     */
+    public static function nullOrKeysInteger($value, $message = '');
+
+    /**
+     * @psalm-pure
+     * @psalm-template T
+     * @psalm-param iterable<T> $array
+     * @psalm-assert iterable<iterable<int, T>> $array
+     *
+     * @param mixed  $value
+     * @param string $message
+     *
+     * @throws InvalidArgumentException
+     */
+    public static function allKeysInteger($value, $message = '');
+
     /**
      * @param null|Countable|array $array
      * @param int                  $number

tests/AssertTest.php

@@ -47,7 +47,7 @@ public function getTests()
     {
         $resource = self::getResource();
 
-        return array(
+        $tests = array(
             array('string', array('value'), true),
             array('string', array(''), true),
             array('string', array(1234), false),
@@ -130,6 +130,11 @@ public function getTests()
             array('isIterable', array(new ArrayIterator(array())), true),
             array('isIterable', array(123), false),
             array('isIterable', array(new stdClass()), false),
+            array('keysInteger', array(array()), true),
+            array('keysInteger', array(new ArrayIterator(array(1, 2, 3))), true),
+            array('keysInteger', array(new ArrayIterator(array('foo' => 'bar'))), false),
+            array('keysInteger', array(array('' => 'bar')), false),
+            array('keysInteger', array(new ArrayIterator(array('' => 'bar', 2, 3))), false),
             array('isInstanceOf', array(new stdClass(), 'stdClass'), true),
             array('isInstanceOf', array(new Exception(), 'stdClass'), false),
             array('isInstanceOf', array(123, 'stdClass'), false),
@@ -567,6 +572,8 @@ public function getTests()
             array('uniqueValues', array(array('asdfg', 'qwerty')), true),
             array('uniqueValues', array(array(123, '123')), false),
         );
+
+        return $tests;
     }
 
     public function getMethods()

tests/static-analysis/assert-keysInteger.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Webmozart\Assert\Tests\StaticAnalysis;
+
+use Webmozart\Assert\Assert;
+
+/**
+ * @psalm-pure
+ *
+ * @param mixed $value
+ */
+function keysInteger($value): iterable
+{
+    Assert::keysInteger($value);
+
+    return $value;
+}
+
+/**
+ * @psalm-pure
+ *
+ * @param mixed $value
+ */
+function nullOrkeysInteger($value): ?iterable
+{
+    Assert::nullOrkeysInteger($value);
+
+    return $value;
+}
+
+/**
+ * @psalm-pure
+ *
+ * @param mixed $value
+ *
+ * @return iterable<iterable>
+ */
+function allkeysInteger($value): iterable
+{
+    Assert::allkeysInteger($value);
+
+    return $value;
+}