Merge branch 'release/2.0.0'

lindyhopchris · lindyhopchris · commit 2dcc119db668 · 2022-02-09T19:25:05.000Z
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -10,34 +10,38 @@ jobs:
   build:
 
     runs-on: ubuntu-latest
-    
+
     strategy:
       fail-fast: true
       matrix:
-        php: ['7.4', '8.0']
-        laravel: ['^8.0']
+        php: [7.4, '8.0', 8.1]
+        laravel: [8, 9]
+        exclude:
+          - php: 7.4
+            laravel: 9
 
     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 "laravel/framework:${{ 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
+      - 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
+          tools: composer:v2
+          coverage: none
+          ini-values: error_reporting=E_ALL
+
+      - name: Set Laravel Version
+        run: composer require "illuminate/contracts:^${{ matrix.laravel }}" --no-update
+
+      - name: Install dependencies
+        uses: nick-invision/retry@v1
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: composer update --prefer-dist --no-interaction --no-progress
+
+      - name: Execute tests
+        run: vendor/bin/phpunit
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,19 @@
 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/).
 
+## [2.0.0] - 2022-02-09
+
+### Added
+
+- Package now supports Laravel 9.
+- Package now supports PHP 8.1.
+
+### Changed
+
+- Upgraded the `laravel-json-api/neomerx-json-api` dependency to `5.0`.
+- Upgraded the `laravel-json-api/core` dependency to `2.0`.
+- Added return types to internal methods to remove deprecation messages in PHP 8.1
+
 ## [1.1.0] - 2022-01-03
 
 ### Fixed
diff --git a/composer.json b/composer.json
@@ -25,12 +25,13 @@
     "require": {
         "php": "^7.4|^8.0",
         "ext-json": "*",
-        "illuminate/support": "^8.0",
-        "laravel-json-api/core": "^1.1",
-        "laravel-json-api/neomerx-json-api": "^4.0.2"
+        "illuminate/contracts": "^8.0|^9.0",
+        "illuminate/support": "^8.0|^9.0",
+        "laravel-json-api/core": "^2.0",
+        "laravel-json-api/neomerx-json-api": "^5.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.5.10"
     },
     "autoload": {
         "psr-4": {
@@ -44,7 +45,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "1.x-dev"
+            "dev-develop": "2.x-dev"
         },
         "laravel": {
             "providers": [
diff --git a/phpunit.xml b/phpunit.xml
@@ -8,23 +8,27 @@
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
+         convertDeprecationsToExceptions="true"
          processIsolation="false"
          stopOnError="false"
          stopOnFailure="false"
          verbose="true"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
 >
-  <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
-  </coverage>
-  <testsuites>
-    <testsuite name="Unit">
-      <directory suffix="Test.php">./tests/Unit/</directory>
-    </testsuite>
-    <testsuite name="Integration">
-      <directory suffix="Test.php">./tests/Integration/</directory>
-    </testsuite>
-  </testsuites>
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit/</directory>
+        </testsuite>
+        <testsuite name="Integration">
+            <directory suffix="Test.php">./tests/Integration/</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <ini name="error_reporting" value="E_ALL"/>
+    </php>
 </phpunit>
diff --git a/src/CompoundDocument.php b/src/CompoundDocument.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.
diff --git a/src/Document.php b/src/Document.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.
@@ -167,7 +167,7 @@ public function toArray()
     /**
      * @inheritDoc
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         try {
             $this->prepareEncoder();
diff --git a/src/Encoder.php b/src/Encoder.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.
diff --git a/src/Encoder/Encoder.php b/src/Encoder/Encoder.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.
diff --git a/src/Factory.php b/src/Factory.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.
diff --git a/src/Factory/Factory.php b/src/Factory/Factory.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.
diff --git a/src/Mapper.php b/src/Mapper.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.
diff --git a/src/Parser/IdentifierAndResource.php b/src/Parser/IdentifierAndResource.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.
@@ -87,7 +87,7 @@ public function getResourceMeta()
      */
     private function cacheMeta(): void
     {
-        if (is_null($this->meta)) {
+        if (null === $this->meta) {
             $this->meta = Json::hash(parent::getResourceMeta());
         }
     }
@@ -99,7 +99,7 @@ private function cacheMeta(): void
      */
     private function cacheIdentifierMeta(): void
     {
-        if (is_null($this->identifierMeta)) {
+        if (null === $this->identifierMeta) {
             $this->identifierMeta = Json::hash(parent::getIdentifierMeta());
         }
     }
diff --git a/src/RelationshipDocument.php b/src/RelationshipDocument.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.
diff --git a/src/Schema/Relation.php b/src/Schema/Relation.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.
diff --git a/src/Schema/Relationships.php b/src/Schema/Relationships.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.
@@ -28,6 +28,7 @@
 use LaravelJsonApi\Core\Resources\JsonApiResource;
 use LaravelJsonApi\Encoder\Neomerx\Mapper;
 use Neomerx\JsonApi\Contracts\Schema\ContextInterface;
+use Traversable;
 use UnexpectedValueException;
 
 /**
@@ -97,7 +98,7 @@ public function __construct(
     /**
      * @inheritDoc
      */
-    public function getIterator()
+    public function getIterator(): Traversable
     {
         foreach ($this->iterator() as $relation) {
             if (!$relation instanceof JsonApiRelation) {
diff --git a/src/Schema/Schema.php b/src/Schema/Schema.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.
diff --git a/src/Schema/SchemaContainer.php b/src/Schema/SchemaContainer.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.
diff --git a/src/Schema/SchemaFields.php b/src/Schema/SchemaFields.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.
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.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.
@@ -31,7 +31,7 @@ class ServiceProvider extends BaseServiceProvider implements DeferrableProvider
     /**
      * @inheritDoc
      */
-    public function provides()
+    public function provides(): array
     {
         return [
             EncoderFactoryContract::class,
diff --git a/tests/Unit/PackageTest.php b/tests/Unit/PackageTest.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.
diff --git a/tests/Unit/Schema/SchemaFieldsTest.php b/tests/Unit/Schema/SchemaFieldsTest.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.

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`	`/*`
`3`		`- * Copyright 2021 Cloud Creativity Limited`
	`3`	`+ * Copyright 2022 Cloud Creativity Limited`
`4`	`4`	`*`
`5`	`5`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`6`	`6`	`* you may not use this file except in compliance with the License.`