add ArrayAssertions

Author: Gummibeer

README.md

@@ -22,6 +22,14 @@ This will prevent any method name conflicts with core, your custom or other trai
 
 ## Assertions
 
+### Array
+
+```php
+\Astrotomic\PhpunitAssertions\ArrayAssertions::assertIndexed(['foo', 'bar']);
+\Astrotomic\PhpunitAssertions\ArrayAssertions::assertAssociative(['foo' => 'bar']);
+\Astrotomic\PhpunitAssertions\ArrayAssertions::assertEquals(['foo', 'bar'], ['bar', 'foo']);
+```
+
 ### Country
 
 `composer require --dev league/iso3166:^3.0`

src/ArrayAssertions.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Astrotomic\PhpunitAssertions;
+
+use PHPUnit\Framework\Assert as PHPUnit;
+
+trait ArrayAssertions
+{
+    public static function assertIndexed($actual): void
+    {
+        PHPUnit::assertIsArray($actual);
+        PHPUnit::assertEquals(
+            range(0, count($actual) - 1),
+            array_keys($actual)
+        );
+    }
+
+    public static function assertAssociative($actual): void
+    {
+        PHPUnit::assertIsArray($actual);
+        PHPUnit::assertNotEquals(
+            range(0, count($actual) - 1),
+            array_keys($actual)
+        );
+    }
+
+    public static function assertEquals(array $expected, $actual): void
+    {
+        PHPUnit::assertIsArray($actual);
+
+        if(array_keys($expected) === range(0, count($expected) - 1)) {
+            sort($expected);
+            sort($actual);
+        } else {
+            ksort($expected);
+            ksort($actual);
+        }
+
+        PHPUnit::assertEquals($expected, $actual);
+    }
+}

tests/ArrayAssertionsTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Astrotomic\PhpunitAssertions\Tests;
+
+use Astrotomic\PhpunitAssertions\ArrayAssertions;
+
+final class ArrayAssertionsTest extends TestCase
+{
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_array_is_indexed(): void
+    {
+        $actual = self::randomArray(self::randomInt(5, 20), false);
+
+        ArrayAssertions::assertIndexed($actual);
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_array_is_associative(): void
+    {
+        $actual = self::randomArray(self::randomInt(5, 20), true);
+
+        ArrayAssertions::assertAssociative($actual);
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_indexed_array_equality(): void
+    {
+        $array = self::randomArray(self::randomInt(5, 20), false);
+
+        $actual = $array;
+        $expected = $array;
+        shuffle($actual);
+
+        ArrayAssertions::assertEquals($expected, $actual);
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_associative_array_equality(): void
+    {
+        $array = self::randomArray(self::randomInt(5, 20), true);
+
+        $actual = $array;
+        $expected = $array;
+        uksort($actual, fn(): int => self::randomInt() <=> self::randomInt());
+
+        ArrayAssertions::assertEquals($expected, $actual);
+    }
+}

tests/Utils/Randomize.php

@@ -16,12 +16,12 @@ protected static function randomString(int $length = 16): string
 
     protected static function randomBool(): bool
     {
-        return boolval(mt_rand(0, 1));
+        return (bool)random_int(0, 1);
     }
 
     protected static function randomInt(int $min = PHP_INT_MIN, int $max = PHP_INT_MAX): int
     {
-        return mt_rand($min, $max);
+        return random_int($min, $max);
     }
 
     protected static function randomFloat(float $min = PHP_INT_MIN, float $max = PHP_INT_MAX): float
@@ -33,4 +33,24 @@ protected static function randomElement(array $array)
     {
         return $array[array_rand($array)];
     }
+
+    protected static function randomArray(int $count, bool $assoc = false): array
+    {
+        $array = array_fill(0, $count, null);
+
+        $array = array_map(static function (): string {
+            return self::randomString(self::randomInt(4, 64));
+        }, $array);
+
+        if ($assoc) {
+            $values = $array;
+            $array = [];
+
+            foreach ($values as $value) {
+                $array[self::randomString(self::randomInt(4, 64))] = $value;
+            }
+        }
+
+        return $array;
+    }
 }