Merge branch 'release/3.4.0' into main

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [3.4.0] - 2022-01-16
+
+### Added
+
+- The `assertCreatedWithServerId`, `assertCreatedWithClientId` and `assertCreatedNoContent` methods will now fail with a
+  better assertion message if the Location header is missing.
+- 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
+
+- The `assertFetchedManyInOrder` assertion did not work if the expected `data` was an empty array.
+- The `assertFetchedToMany` and `assertFetchedToManyInOrder` assertions did not work if the expected `data` was an empty
+  array.
+
 ## [3.3.0] - 2021-07-31
 
 ### Changed
@@ -26,81 +43,95 @@ All notable changes to this project will be documented in this file. This projec
 ## [3.2.0] - 2020-11-25
 
 ### Added
+
 - Package now supports PHP 8.
 
 ## [3.1.0] - 2020-09-09
 
 ### Added
+
 - Package now supports Laravel 8.
 
 ## [3.0.0] - 2020-04-12
 
 ### Added
+
 - Package now supports PHP Unit 9.
 
 ### Changed
+
 - Dropped support for PHP Unit 7.
 - Dropped support for Laravel 5.
 
 ## [2.1.0] - 2020-03-04
 
 ### Added
+
 - Package now supports Laravel 7.
 - [#9](https://github.com/cloudcreativity/json-api-testing/issues/9)
-Can now assert that there are no resources included - i.e. that the `included` member is not present
-or is an empty list.
+  Can now assert that there are no resources included - i.e. that the `included` member is not present or is an empty
+  list.
 
 ### Fixed
+
 - [#10](https://github.com/cloudcreativity/json-api-testing/pull/10)
-Pass expected and actual values to PHPUnit's assertion in correct order.
+  Pass expected and actual values to PHPUnit's assertion in correct order.
 
 ## [2.0.0] - 2019-10-14
 
 ### Changed
+
 - Minimum `illuminate/support` version is now `5.8` (previously `5.5`).
 - Minimum PHPUnit version is now `7.5` (previously `6.0`).
 
 ### Removed
-- Removed the `assertNoContent()` method from the `Concerns\HasHttpAssertions` trait. Unlike other
-assertion methods in that trait, this method refers to a HTTP status description which means it is
-likely to collide with assertions provided by frameworks. For example, Laravel `6.1.0` introduced
-an `assertNoContent()` method to its test response which is not compatible with the implementation
-provided by this package.
+
+- Removed the `assertNoContent()` method from the `Concerns\HasHttpAssertions` trait. Unlike other assertion methods in
+  that trait, this method refers to a HTTP status description which means it is likely to collide with assertions
+  provided by frameworks. For example, Laravel `6.1.0` introduced an `assertNoContent()` method to its test response
+  which is not compatible with the implementation provided by this package.
 
 ## [1.2.0] - 2019-09-04
 
 ### Added
+
 - Package now supports Laravel 6.
 
 ## [1.1.0] - 2019-05-23
 
 ### Added
+
 - Package now supports PHPUnit 8.
 
 ## [1.0.0] - 2019-02-27
 
 ### Added
+
 - [#3](https://github.com/cloudcreativity/json-api-testing/issues/3)
-Can now assert exact errors on a document and HTTP message.
+  Can now assert exact errors on a document and HTTP message.
 - [#5](https://github.com/cloudcreativity/json-api-testing/issues/5)
-Can now assert a server generated id with a known id.
+  Can now assert a server generated id with a known id.
 
 ### Fixed
+
 - [#6](https://github.com/cloudcreativity/json-api-testing/issues/6)
-Fixed asserting that an error exists with only an integer HTTP status code.
+  Fixed asserting that an error exists with only an integer HTTP status code.
 - [#4](https://github.com/cloudcreativity/json-api-testing/issues/4)
-Fixed incorrect diff when asserting a resource identifier on a document that contains a resource object.
+  Fixed incorrect diff when asserting a resource identifier on a document that contains a resource object.
 
 ## [1.0.0-rc.1] - 2019-01-03
 
 ### Added
+
 - New implementation using constraint classes. Assertions are now provided via the `Assert` and `HttpAssert`
-classes, with traits in the `Concerns` namespace for adding these to test classes.
+  classes, with traits in the `Concerns` namespace for adding these to test classes.
 
 ### Changed
+
 - Minimum PHP version is now `7.1`.
 
 ### Removed
+
 - Package no longer supports PHPUnit 5.
 - The previous implementation was deleted, removing these classes:
   - `AbstractTraversableTester`
@@ -115,34 +146,40 @@ classes, with traits in the `Concerns` namespace for adding these to test classe
 ## [0.4.0] - 2018-04-29
 
 ### Added
+
 - Object tester now had meta test helpers.
 - Can now assert the order of resources within the a resource object collection.
 
 ## [0.3.0] - 2018-02-08
 
 ### Added
+
 - Now supports PHP 5.6 to 7.2.
 - Now supports PHPUnit 5.7 to 7.0.
 
 ## [0.2.0] - 2017-09-02
 
 ### Removed
+
 - This package no longer supports PHP 5.6.
 - Updated to PHPUnit v6.
 
 ## [0.1.1] - 2017-09-02
 
 ### Added
+
 - Can now assert that a resource object is one of multiple types using `assertTypeIs()`.
 - Can now assert that the `data` member of a document is `null`.
 - Can now assert that a resource object matches an expected structure.
 - Can now assert that the `data` member of a document is a resource identifier.
 - Can now assert that a document does not contain an `errors` member.
 
 ### Changed
+
 - Added a generic JSON API object tester class containing common assertions.
 
 ### Fixed
+
 - Resource object type assertion caused a PHP error.
 
 ## [0.1.0] - 2017-09-02

composer.json

@@ -33,7 +33,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "CloudCreativity\\JsonApi\\Testing\\": "tests/"
+            "CloudCreativity\\JsonApi\\Testing\\Tests\\": "tests/"
         }
     },
     "extra": {

src/Assert.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.

src/Compare.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.
@@ -19,6 +19,7 @@
 
 use Illuminate\Contracts\Routing\UrlRoutable;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
 use SebastianBergmann\Comparator\ComparisonFailure;
 
 /**
@@ -86,12 +87,13 @@ public static function resourceIdentifier($value): bool
             return false;
         }
 
-        $members = collect($value);
+        $members = Collection::make($value);
 
         return $members->has('type') &&
             $members->has('id') &&
             !$members->has('attributes') &&
-            !$members->has('relationships');
+            !$members->has('relationships') &&
+            !$members->has('links');
     }
 
     /**
@@ -209,7 +211,7 @@ public static function identifiers($ids, ?string $type): array
             return [self::identifier($ids, $type)];
         }
 
-        return collect($ids)->map(function ($id) use ($type) {
+        return Collection::make($ids)->map(function ($id) use ($type) {
             return self::identifier($id, $type);
         })->values()->all();
     }
@@ -240,6 +242,10 @@ public static function identifier($id, ?string $type): array
             $id['id'] = (string) $id['id']->getRouteKey();
         }
 
+        if (isset($id['id']) && is_int($id['id'])) {
+            $id['id'] = (string) $id['id'];
+        }
+
         if ($type && !array_key_exists('type', $id)) {
             $id['type'] = $type;
         }

src/Concerns/HasDocumentAssertions.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.

src/Concerns/HasHttpAssertions.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.
@@ -47,14 +47,14 @@ trait HasHttpAssertions
      */
     public function getDocument(): Document
     {
-        if (!$this->document) {
-            $this->document = HttpAssert::assertContent(
-                $this->getContentType(),
-                $this->getContent()
-            );
+        if ($this->document) {
+            return $this->document;
         }
 
-        return $this->document;
+        return $this->document = HttpAssert::assertContent(
+            $this->getContentType(),
+            $this->getContent()
+        );
     }
 
     /**
@@ -246,9 +246,7 @@ public function assertFetchedNone(): self
      * If either type or id are null, then it will be asserted that the data member of the content
      * is null.
      *
-     * Prov
-     *
-     * @param UrlRoutable|string|int $id
+     * @param UrlRoutable|array|string|int $id
      * @return $this
      */
     public function assertFetchedToOne($id): self
@@ -505,6 +503,18 @@ public function assertIncluded(array $expected, bool $strict = true): self
         return $this;
     }
 
+    /**
+     * Assert that the document does not have the top-level included member.
+     *
+     * @return $this
+     */
+    public function assertDoesntHaveIncluded(): self
+    {
+        $this->getDocument()->assertNotExists('included', 'Document has included resources.');
+
+        return $this;
+    }
+
     /**
      * Assert a top-level meta response without data.
      *
@@ -573,6 +583,18 @@ public function assertExactMeta(array $expected, bool $strict = true): self
         return $this;
     }
 
+    /**
+     * Assert that the document does not have the top-level meta member.
+     *
+     * @return $this
+     */
+    public function assertDoesntHaveMeta(): self
+    {
+        $this->getDocument()->assertNotExists('meta', 'Document has top-level meta.');
+
+        return $this;
+    }
+
     /**
      * Assert that the top-level links match the expected values.
      *
@@ -601,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.
      *

src/Constraints/EmptyOrMissingList.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.

src/Constraints/ExactInDocument.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.

src/Constraints/ExactInList.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.

src/Constraints/HttpStatusIs.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2021 Cloud Creativity Limited
+ * 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.