Add optional JSON Pointer values to structure classes

pint.json

@@ -0,0 +1,3 @@
+{
+    "preset": "psr12"
+}

src/OpenAPI.php

@@ -18,7 +18,7 @@ final class OpenAPI
 
     private \Opis\JsonSchema\Validator $validator;
 
-    public function __construct(?Retriever $retriever = null)
+    public function __construct(Retriever $retriever = null)
     {
         $retriever = $retriever ?? new LocalFilesystemRetriever();
 

src/References/JsonPointer.php

@@ -2,8 +2,6 @@
 
 namespace Apiboard\OpenAPI\References;
 
-use InvalidArgumentException;
-
 class JsonPointer
 {
     private string $filename;
@@ -15,10 +13,6 @@ class JsonPointer
 
     public function __construct(string $value)
     {
-        if (is_string($value) === false) {
-            throw new InvalidArgumentException('Ref value must be a string');
-        }
-
         $splitRef = explode('#', $value, 2);
 
         $this->filename = $splitRef[0];

src/References/Resolver.php

@@ -14,7 +14,7 @@ final class Resolver
 
     private array $replacedKeys = [];
 
-    public function __construct(?Retriever $retriever = null)
+    public function __construct(Retriever $retriever = null)
     {
         $this->retriever = $retriever;
     }

src/Structure/Structure.php

@@ -2,19 +2,28 @@
 
 namespace Apiboard\OpenAPI\Structure;
 
+use Apiboard\OpenAPI\References\JsonPointer;
 use JsonSerializable;
 
 abstract class Structure implements JsonSerializable
 {
     protected array $data;
 
-    public function __construct(array $data)
+    protected ?JsonPointer $pointer;
+
+    public function __construct(array $data, JsonPointer $pointer = null)
     {
         $this->data = $data;
+        $this->pointer = $pointer;
     }
 
     public function jsonSerialize(): array
     {
         return $this->data;
     }
+
+    public function pointer(): ?JsonPointer
+    {
+        return $this->pointer;
+    }
 }

tests/Concerns/CanBeDeprecatedTest.php

@@ -7,8 +7,7 @@
 use Apiboard\OpenAPI\Structure\Schema;
 
 test('it can return the deprecated state', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use CanBeDeprecated;
 
         protected $data = [
@@ -22,8 +21,7 @@
 });
 
 test('it returns false for the the deprecated state by default', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use CanBeDeprecated;
     };
 

tests/Concerns/CanBeDescribedTest.php

@@ -15,8 +15,7 @@
 use Apiboard\OpenAPI\Structure\Tag;
 
 test('it can return the description', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use CanBeDescribed;
 
         protected $data = [
@@ -30,8 +29,7 @@
 });
 
 test('it returns null when description is unavaible', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use CanBeDescribed;
     };
 

tests/Concerns/CanBeRequiredTest.php

@@ -6,8 +6,7 @@
 use Apiboard\OpenAPI\Structure\RequestBody;
 
 test('it can return the required state', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use CanBeRequired;
 
         protected $data = [
@@ -21,8 +20,7 @@
 });
 
 test('it returns false for the the required state by default', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use CanBeRequired;
 
         protected $data = [];

tests/Concerns/CanBeUsedAsArrayTest.php

@@ -20,8 +20,7 @@
 use Apiboard\OpenAPI\Structure\Webhooks;
 
 test('it can be looped over', function () {
-    $class = new class() implements ArrayAccess, Countable, Iterator
-    {
+    $class = new class () implements ArrayAccess, Countable, Iterator {
         use CanBeUsedAsArray;
 
         protected $data = [
@@ -42,8 +41,7 @@
 });
 
 test('it can be counted', function () {
-    $class = new class() implements ArrayAccess, Countable, Iterator
-    {
+    $class = new class () implements ArrayAccess, Countable, Iterator {
         use CanBeUsedAsArray;
 
         protected $data = [
@@ -58,8 +56,7 @@
 });
 
 test('it can retrieve data by key', function () {
-    $class = new class() implements ArrayAccess, Countable, Iterator
-    {
+    $class = new class () implements ArrayAccess, Countable, Iterator {
         use CanBeUsedAsArray;
 
         protected $data = [

tests/Concerns/HasReferencesTest.php

@@ -20,8 +20,7 @@
 use Apiboard\OpenAPI\Structure\Webhooks;
 
 test('it can return all references', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use HasReferences;
 
         public function toArray(): array

tests/Concerns/HasSchemaTest.php

@@ -7,8 +7,7 @@
 use Apiboard\OpenAPI\Structure\Schema;
 
 test('it can return the schema', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use HasASchema;
 
         protected $data = [
@@ -27,8 +26,7 @@ public function toArray(): array
 });
 
 test('it can return a referenced schema', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use HasASchema;
 
         protected $data = [

tests/Concerns/HasVendorExtensionsTest.php

@@ -28,8 +28,7 @@
 use Apiboard\OpenAPI\Structure\Tag;
 
 test('it can retrieve vendor extensions', function () {
-    $class = new class()
-    {
+    $class = new class () {
         use HasVendorExtensions;
 
         protected $data = [

tests/OpenAPITest.php

@@ -45,8 +45,7 @@
 
 test('it can resolve references', function () {
     $jsonFile = fixture('references.json');
-    $retriever = new class() implements Retriever
-    {
+    $retriever = new class () implements Retriever {
         private bool $called = false;
 
         private string $basePath = '';
@@ -87,8 +86,7 @@ public function wasCalled(): bool
 
 test('it resolves references when parsing', function () {
     $jsonFile = fixture('references.json');
-    $retriever = new class() implements Retriever
-    {
+    $retriever = new class () implements Retriever {
         private bool $called = false;
 
         private string $basePath = '';

tests/Pest.php

@@ -51,7 +51,7 @@
 |
 */
 
-function openAPI(?Retriever $retriever = null): OpenAPI
+function openAPI(Retriever $retriever = null): OpenAPI
 {
     return new OpenAPI($retriever);
 }

tests/References/ResolverTest.php

@@ -188,8 +188,7 @@
 function retriever(callable $callback): Retriever
 {
     /** @var Retriever */
-    $retriever = new class($callback) implements Retriever
-    {
+    $retriever = new class ($callback) implements Retriever {
         private Closure $callback;
 
         private string $basePath = '';

tests/Structure/StructureTest.php

@@ -1,16 +1,26 @@
 <?php
 
+use Apiboard\OpenAPI\References\JsonPointer;
 use Apiboard\OpenAPI\Structure\RuntimeExpression;
 use Apiboard\OpenAPI\Structure\Structure;
 
 test('it can be json serialized', function () {
-    $class = new class([]) extends Structure
-    {
+    $class = new class ([]) extends Structure {
     };
 
     expect($class->jsonSerialize())->toBe([]);
 });
 
+test('it optionally accepts a JSON Pointer as context', function () {
+    $pointer = new JsonPointer('/info/title');
+    $class = new class ([], $pointer) extends Structure {
+    };
+
+    $result = $class->pointer();
+
+    expect($result)->toEqual($pointer);
+});
+
 test('it is used as parent where applicable', function (string $class) {
     $parent = get_parent_class($class);