API Updates (#1)

* Supports Schema as an array
* Supports Schema from file as path
* Supports Schema as JSON
* Updated method (BREAKING CHANGE)
* Adds PHPUnit as a required dependency since this is for testing

Author: sixlive

README.md

@@ -37,7 +37,11 @@ public function it_has_a_valid_response()
 
     $response = $this->get('/foo');
 
-    $response->assertMatchesJsonSchema(json_encode($schema));
+    // Schema as an array
+    $response->assertJsonSchema($schema);
+
+    // Schema from a file
+    $response->assertJsonSchema(base_path('schemas/foo.json'));
 }
 ```
 
@@ -56,7 +60,7 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Code Style
-In addition to the php-cs-fixer rules, StyleCI will apply the [Laravel preset](https://docs.styleci.io/presets#laravel). 
+In addition to the php-cs-fixer rules, StyleCI will apply the [Laravel preset](https://docs.styleci.io/presets#laravel).
 
 ### Linting
 ```bash

composer.json

@@ -20,12 +20,12 @@
     ],
     "require": {
         "php": "^7.1|^7.2",
-        "swaggest/json-schema": "^0.12.0"
+        "swaggest/json-schema": "^0.12.0",
+        "phpunit/phpunit": "^7.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.12",
-        "orchestra/testbench": "^3.5|^3.6",
-        "phpunit/phpunit": "^7.0"
+        "orchestra/testbench": "^3.5|^3.6"
     },
     "autoload": {
         "psr-4": {

src/SchemaAssertion.php

@@ -5,16 +5,37 @@
 use Swaggest\JsonSchema\Schema;
 use Swaggest\JsonSchema\InvalidValue;
 use PHPUnit\Framework\Assert as PHPUnit;
+use sixlive\Laravel\JsonSchemaAssertions\Support\Str;
 
 class SchemaAssertion
 {
     protected $schema;
 
-    public function __construct(string $schema)
+    /**
+     * @param  array|string  $schema
+     *
+     * @return void
+     */
+    public function __construct($schema)
     {
-        $this->schema = Schema::import(json_decode($schema));
+        if (is_array($schema)) {
+            $schema = json_encode($schema);
+        }
+
+        if (is_string($schema) && Str::isJson($schema)) {
+            $schema = json_decode($schema);
+        }
+
+        $this->schema = Schema::import($schema);
     }
 
+    /**
+     * Assert JSON against the loaded schema.
+     *
+     * @param  string  $data
+     *
+     * @return void
+     */
     public function assert(string $data)
     {
         try {

src/ServiceProvider.php

@@ -12,7 +12,7 @@ class ServiceProvider extends Provider
      */
     public function boot()
     {
-        TestResponse::macro('assertMatchesJsonSchema', function ($schema) {
+        TestResponse::macro('assertJsonSchema', function ($schema) {
             (new SchemaAssertion($schema))->assert($this->content());
         });
     }

src/Support/Str.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace sixlive\Laravel\JsonSchemaAssertions\Support;
+
+class Str
+{
+    /**
+     * Test to see if a string is json.
+     *
+     * @param  string  $string
+     *
+     * @return bool
+     */
+    public static function isJson($string)
+    {
+        json_decode($string);
+
+        return json_last_error() === JSON_ERROR_NONE;
+    }
+}

tests/AssertResponseTest.php

@@ -19,7 +19,7 @@ public function setUp()
     }
 
     /** @test */
-    public function valid_schema_passes()
+    public function valid_schema_passes_as_json()
     {
         $schema = [
              'type' => 'object',
@@ -33,7 +33,32 @@ public function valid_schema_passes()
              ],
        ];
 
-        $this->get('foo')->assertMatchesJsonSchema(json_encode($schema));
+        $this->get('foo')->assertJsonSchema(json_encode($schema));
+    }
+
+    /** @test */
+    public function valid_schema_passes_as_array()
+    {
+        $schema = [
+             'type' => 'object',
+             'properties' => [
+               'foo' => [
+                 'type' => 'string',
+               ],
+             ],
+             'required' => [
+               'foo',
+             ],
+       ];
+
+        $this->get('foo')->assertJsonSchema($schema);
+    }
+
+    /** @test */
+    public function valid_schema_passes_as_file_path()
+    {
+        $this->get('foo')
+             ->assertJsonSchema(__DIR__.'/Support/Schemas/foo.json');
     }
 
     /** @test */
@@ -53,6 +78,6 @@ public function invalid_schema_fails_with_message()
              ],
        ];
 
-        $this->get('foo')->assertMatchesJsonSchema(json_encode($schema));
+        $this->get('foo')->assertJsonSchema(json_encode($schema));
     }
 }

tests/Support/Schemas/foo.json

@@ -0,0 +1,11 @@
+{
+    "properties": {
+        "foo": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "foo"
+    ],
+    "type": "object"
+}