[Feature] Add assertion that document does not have links

Author: lindyhopchris

CHANGELOG.md

@@ -12,6 +12,7 @@ All notable changes to this project will be documented in this file. This projec
 - New `assertDoesntHaveIncluded` assertion to assert that the JSON:API document does not have the top-level `included`
   member.
 - New `assertDoesntHaveMeta` assertion to assert the JSON:API document does not have the top-level `meta` member.
+- New `assertDoesntHaveLinks` assertion to assert the JSON:API document does not have the top-level `links` member.
 
 ### Fixed
 

src/Concerns/HasHttpAssertions.php

@@ -623,6 +623,18 @@ public function assertExactLinks(array $expected, bool $strict = true): self
         return $this;
     }
 
+    /**
+     * Assert that the document does not have the top-level links member.
+     *
+     * @return $this
+     */
+    public function assertDoesntHaveLinks(): self
+    {
+        $this->getDocument()->assertNotExists('links', 'Document has top-level links.');
+
+        return $this;
+    }
+
     /**
      * Assert the document contains a single error that matches the supplied error.
      *

tests/Assertions/LinksTest.php

@@ -0,0 +1,115 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\JsonApi\Testing\Tests\Assertions;
+
+use CloudCreativity\JsonApi\Testing\HttpMessage;
+use CloudCreativity\JsonApi\Testing\Tests\TestCase;
+
+class LinksTest extends TestCase
+{
+    /**
+     * @var array
+     */
+    private array $links = [
+        'self' => '/api/v1/comments/123/relationships/post',
+        'related' => '/api/v1/comments/123/post',
+    ];
+
+    /**
+     * @var array
+     */
+    private array $post = [
+        'type' => 'posts',
+        'id' => '1',
+        'attributes' => [
+            'title' => 'Hello World',
+            'content' => '...',
+        ],
+    ];
+
+    /**
+     * @var HttpMessage
+     */
+    private HttpMessage $http;
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->http = new HttpMessage(
+            200,
+            'application/vnd.api+json',
+            json_encode(['data' => $this->post, 'links' => $this->links]),
+            ['Content-Type' => 'application/vnd.api+json', 'Accept' => 'application/vnd.api+json'],
+        );
+    }
+
+    public function testLinks(): void
+    {
+        $partial = $this->links;
+        unset($partial['self']);
+
+        $invalid = $this->links;
+        $invalid['related'] = '/api/foo/bar';
+
+        $this->http->assertLinks($this->links);
+        $this->http->assertLinks($partial);
+
+        $this->assertThatItFails(
+            'member at [/links] matches the subset',
+            fn() => $this->http->assertLinks($invalid)
+        );
+    }
+
+    public function testExactLinks(): void
+    {
+        $partial = $this->links;
+        unset($partial['self']);
+
+        $invalid = $this->links;
+        $invalid['related'] = '/api/foo/bar';
+
+        $this->http->assertExactLinks($this->links);
+
+        $this->assertThatItFails(
+            'member at [/links] exactly matches',
+            fn() => $this->http->assertExactLinks($partial),
+        );
+
+        $this->assertThatItFails(
+            'member at [/links] exactly matches',
+            fn() => $this->http->assertExactLinks($invalid),
+        );
+    }
+
+    public function testDoesntHaveLinks(): void
+    {
+        $none = $this->http->withContent(json_encode(['data' => $this->post]));
+        $none->assertDoesntHaveLinks();
+
+        $this->assertThatItFails(
+            'Document has top-level links.',
+            fn() => $this->http->assertDoesntHaveLinks()
+        );
+    }
+}