Assertions for verifying the data types of arrays (#19)

Author: jasonmccreary

composer.json

@@ -18,5 +18,12 @@
         "psr-4": {
             "JMac\\Testing\\": "src/"
         }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "JMac\\Testing\\AdditionalAssertionsServiceProvider"
+            ]
+        }
     }
 }

src/AdditionalAssertionsServiceProvider.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace JMac\Testing;
+
+use Illuminate\Support\ServiceProvider;
+use JMac\Testing\Traits\AdditionalAssertions;
+
+class AdditionalAssertionsServiceProvider extends ServiceProvider
+{
+    public function register()
+    {
+        $test_response_class = class_exists(\Illuminate\Testing\TestResponse::class)
+            ? \Illuminate\Testing\TestResponse::class
+            : \Illuminate\Foundation\Testing\TestResponse::class;
+
+        if (!$test_response_class::hasMacro('assertJsonTypedStructure')) {
+            $test_response_class::macro('assertJsonTypedStructure', function (array $structure) {
+                AdditionalAssertions::assertArrayStructure($structure, $this->json());
+
+                return $this;
+            });
+        }
+    }
+}
+
+

src/Traits/AdditionalAssertions.php

@@ -108,6 +108,44 @@ public function assertValidationRuleContains($rule, string $class)
         }
     }
 
+    public static function assertArrayStructure(array $structure, array $actual)
+    {
+        foreach ($structure as $key => $type) {
+            if (is_array($type) && $key === '*') {
+                PHPUnitAssert::assertIsArray($actual);
+
+                foreach ($actual as $data) {
+                    static::assertArrayStructure($structure['*'], $data);
+                }
+            } elseif (is_array($type) && array_key_exists($key, $structure)) {
+                if (is_array($structure[$key])) {
+                    static::assertArrayStructure($structure[$key], $actual[$key]);
+                }
+            } else {
+                switch ($type) {
+                    case 'string':
+                        PHPUnitAssert::assertIsString($actual[$key]);
+                        break;
+                    case 'integer':
+                        PHPUnitAssert::assertIsInt($actual[$key]);
+                        break;
+                    case 'number':
+                        PHPUnitAssert::assertIsNumeric($actual[$key]);
+                        break;
+                    case 'boolean':
+                        PHPUnitAssert::assertIsBool($actual[$key]);
+                        break;
+                    case 'array':
+                        PHPUnitAssert::assertIsArray($actual[$key]);
+                        break;
+                    default:
+                        PHPUnitAssert::fail('unexpected type: ' . $type);
+                }
+            }
+        }
+    }
+
+
     private function normalizeRules(array $rules)
     {
         return array_map([$this, 'expandRules'], $rules);