Merge branch 'release/3.3.0' into main

Author: lindyhopchris

.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        php: ['7.4', '8.0']
+        laravel: ['^8.0']
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php }}
+        extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, gd
+        tools: composer:v2
+        coverage: none
+
+    - name: Set Laravel Version
+      run: composer require "illuminate/support:${{ matrix.laravel }}" --no-update -n
+
+    - name: Install dependencies
+      uses: nick-invision/retry@v1
+      with:
+        timeout_minutes: 5
+        max_attempts: 5
+        command: composer install --no-suggest --prefer-dist -n -o
+
+    - name: Execute tests
+      run: vendor/bin/phpunit

.travis.yml

@@ -3,9 +3,29 @@
 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.3.0] - 2021-07-31
+
+### Changed
+
+- Minimum PHP version is now `7.4`.
+- Minimum Laravel version is now `8.0`.
+- Minimum PHPUnit version is now `9.0`.
+
+### Fixed
+
+- [#19](https://github.com/cloudcreativity/json-api-testing/issues/19) The expected location for the
+  `assertCreatedWithServerId()` and `assertCreatedWithClientId()` can now be `null`, indicating that the `Location`
+  header is not expected.
+
+### Deprecated
+
+- The following methods are deprecated and will be removed in `4.0`:
+  - `assertDeleted()` - use `assertNoContent()` or `assertMetaWithoutData()` depending on your expected response.
+  - `assertUpdated()` - use `assertNoContent()` or `assertFetchedOne()` depending on your expected response.
+
 ## [3.2.0] - 2020-11-25
 
-###
+### Added
 - Package now supports PHP 8.
 
 ## [3.1.0] - 2020-09-09

CHANGELOG.md

@@ -21,10 +21,10 @@
         }
     ],
     "require": {
-        "php": "^7.2|^8.0",
+        "php": "^7.4|^8.0",
         "ext-json": "*",
-        "illuminate/support": "^6.0|^7.0|^8.0",
-        "phpunit/phpunit": "^8.0|^9.0"
+        "illuminate/support": "^8.0",
+        "phpunit/phpunit": "^9.0"
     },
     "autoload": {
         "psr-4": {

composer.json

@@ -1,18 +1,18 @@
 <?php
-/**
- * Copyright 2019 Cloud Creativity Limited
+/*
+ * Copyright 2021 Cloud Creativity Limited
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
+ *  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
+ *  You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *  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.
+ *  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.
  */
 
 namespace CloudCreativity\JsonApi\Testing;

src/Assert.php

@@ -1,18 +1,18 @@
 <?php
-/**
- * Copyright 2019 Cloud Creativity Limited
+/*
+ * Copyright 2021 Cloud Creativity Limited
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
+ *  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
+ *  You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *  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.
+ *  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.
  */
 
 namespace CloudCreativity\JsonApi\Testing;

src/Compare.php

@@ -1,18 +1,18 @@
 <?php
-/**
- * Copyright 2019 Cloud Creativity Limited
+/*
+ * Copyright 2021 Cloud Creativity Limited
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
+ *  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
+ *  You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *  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.
+ *  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.
  */
 
 namespace CloudCreativity\JsonApi\Testing\Concerns;

src/Concerns/HasDocumentAssertions.php

@@ -1,18 +1,18 @@
 <?php
-/**
- * Copyright 2019 Cloud Creativity Limited
+/*
+ * Copyright 2021 Cloud Creativity Limited
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
+ *  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
+ *  You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *  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.
+ *  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.
  */
 
 namespace CloudCreativity\JsonApi\Testing\Concerns;
@@ -309,13 +309,13 @@ public function assertFetchedToManyInOrder($expected, bool $strict = true): self
     /**
      * Assert that a resource was created with a server generated id.
      *
-     * @param string $expectedLocation
-     *      the expected location without the id.
+     * @param string|null $expectedLocation
+     *      the expected location without the id, or null if no location header is expected.
      * @param UrlRoutable|string|int|array $expected
      * @param bool $strict
      * @return $this
      */
-    public function assertCreatedWithServerId(string $expectedLocation, $expected, bool $strict = true): self
+    public function assertCreatedWithServerId(?string $expectedLocation, $expected, bool $strict = true): self
     {
         $this->document = HttpAssert::assertCreatedWithServerId(
             $this->getStatusCode(),
@@ -333,12 +333,13 @@ public function assertCreatedWithServerId(string $expectedLocation, $expected, b
     /**
      * Assert that a resource was created with a client generated id.
      *
-     * @param string $expectedLocation
+     * @param string|null $expectedLocation
+     *      the expected location without the id, or null if no location header is expected.
      * @param UrlRoutable|string|int|array $expected
      * @param bool $strict
      * @return $this
      */
-    public function assertCreatedWithClientId(string $expectedLocation, $expected, bool $strict = true): self
+    public function assertCreatedWithClientId(?string $expectedLocation, $expected, bool $strict = true): self
     {
         $this->document = HttpAssert::assertCreatedWithClientId(
             $this->getStatusCode(),
@@ -385,6 +386,7 @@ public function assertCreatedNoContent(string $expectedLocation): self
      *      array representation of the expected resource, or null for a no-content response
      * @param bool $strict
      * @return $this
+     * @deprecated 4.0 use not recommended: use `assertNoContent()` or `assertFetchedOne()` instead.
      */
     public function assertUpdated(array $expected = null, bool $strict = true): self
     {
@@ -411,6 +413,7 @@ public function assertUpdated(array $expected = null, bool $strict = true): self
      *      the expected top-level meta, or null for no content response.
      * @param bool $strict
      * @return $this
+     * @deprecated 4.0 use not recommended: use `assertNoContent() or `assertMetaWithoutData()` instead.
      */
     public function assertDeleted(array $expected = null, bool $strict = true): self
     {

src/Concerns/HasHttpAssertions.php

@@ -1,4 +1,19 @@
 <?php
+/*
+ * Copyright 2021 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.
+ */
 
 namespace CloudCreativity\JsonApi\Testing\Constraints;
 

src/Constraints/EmptyOrMissingList.php

@@ -1,18 +1,18 @@
 <?php
-/**
- * Copyright 2019 Cloud Creativity Limited
+/*
+ * Copyright 2021 Cloud Creativity Limited
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
+ *  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
+ *  You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *  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.
+ *  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.
  */
 
 namespace CloudCreativity\JsonApi\Testing\Constraints;