Merge branch 'release/6.1.0'

Author: lindyhopchris

.github/workflows/tests.yml

@@ -14,12 +14,12 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [8.1, 8.2]
+        php: [8.1, 8.2, 8.3]
         laravel: [10]
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -34,7 +34,7 @@ jobs:
         run: composer require "laravel/framework:^${{ matrix.laravel }}" --no-update
 
       - name: Install dependencies
-        uses: nick-fields/retry@v2
+        uses: nick-fields/retry@v3
         with:
           timeout_minutes: 5
           max_attempts: 5

.gitignore

@@ -1,3 +1,3 @@
 vendor/
 composer.lock
-.phpunit.result.cache
+.phpunit.cache/

CHANGELOG.md

@@ -3,6 +3,15 @@
 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/).
 
+## Unreleased
+
+## [6.1.0] - 2024-02-11
+
+### Fixed
+
+- [#642](https://github.com/cloudcreativity/laravel-json-api/pull/642) Add missing resource meta functionality.
+- [#643](https://github.com/cloudcreativity/laravel-json-api/issues/643) Add missing resource link functionality.
+
 ## [6.0.0] - 2023-02-14
 
 ### Changed

composer.json

@@ -38,7 +38,7 @@
         "laravel/ui": "^4.2",
         "mockery/mockery": "^1.1",
         "orchestra/testbench": "^8.0",
-        "phpunit/phpunit": "^9.5.28"
+        "phpunit/phpunit": "^10.5"
     },
     "suggest": {
         "cloudcreativity/json-api-testing": "Required to use the test helpers."

database/migrations/2018_10_23_000001_create_client_jobs_table.php

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

docs/basics/schemas.md

@@ -384,20 +384,35 @@ By default all resource objects will be encoded with their `self` link, e.g.:
 }
 ```
 
-You can change this behaviour by overloading the `getResourceLinks` or `getIncludedResourceLinks` methods.
-For example:
+You can change this behaviour by implementing the `getResourceLinks` method. For example, if you do not want any links
+to be serialized:
 
 ```php
 class Schema extends SchemaProvider
 {
     // ...
 
-    public function getResourceLinks($resource)
+    public function getResourceLinks($resource): ?array
     {
-        $links = parent::getResourceLinks($resource);
-        $links['foo'] = $this->createLink('posts/foo');
+        return null;
+    }
+}
+```
+
+If you return an array without any `self` key in it, the `self` link will be automatically added. If you do not want
+the `self` link to be set, set the array key `self` to `false`.
+
+```php
+class Schema extends SchemaProvider
+{
+    // ...
 
-        return $links;
+    public function getResourceLinks($resource): array
+    {
+        return [
+            // "self" will automatically be added as it is not set to false.
+            'foo' => $this->createLink('posts/foo'),
+        ];
     }
 
 }
@@ -423,33 +438,23 @@ This would result in the following resource object:
 > The `createLink` method allows you to pass in link meta and set whether the URI is relative to the API or an
 absolute path.
 
-If you want to only change the links when the resource is appearing in the `included` section of the JSON API
-document, overload the `getIncludedResourceLinks()` method instead.
-
 ## Meta
 
-You can add top-level `meta` to your resource object using the `getPrimaryMeta()` or `getInclusionMeta()` methods
-on your schema. These are called depending on whether your resource is appearing in either the primary `data`
-member of the JSON API document or the `included` member.
+You can add top-level `meta` to your resource object using the `getResourceMeta()` method
+on your schema.
 
-For example, the following would add meta to your resource object regardless of whether it is primary data or
-included in the document:
+For example:
 
 ```php
 class Schema extends SchemaProvider
 {
     // ...
 
-    public function getPrimaryMeta($resource)
+    public function getResourceMeta($resource)
     {
         return ['foo' => 'bar'];
     }
 
-    public function getInclusionMeta($resource)
-    {
-        return $this->getPrimaryMeta($resource);
-    }
-
 }
 ```
 

docs/upgrade.md

@@ -103,6 +103,28 @@ public function getId(object $resource): string
     return (string) $resource->getRouteKey();
 }
 ```
+The functions that are used to call meta data has also been changed. Before there were these 2 functions:
+
+```php
+public function getPrimaryMeta($resource)
+{
+    return ['foo => 'bar'];
+}
+public function getInclusionMeta($resource)
+{
+    return $this->getPrimaryMeta($resource);
+}
+```
+
+These have now been replaced with 1 function:
+
+```php
+  public function getResourceMeta($resource): ?array
+  {
+      return ['foo => 'bar'];
+  }
+```
+This method will be used in place of the other 2. In the rare event that your inclution meta was different from primary, you may need to amalgemate.
 
 ### Errors
 
@@ -116,4 +138,4 @@ your use against the new constructor arguments by inspecting the class directly.
 
 ## 2.x to 3.0
 
-[Use this link to view the 3.0 upgrade guide.](https://github.com/cloudcreativity/laravel-json-api/blob/v3.3.0/docs/upgrade.md)
+[Use this link to view the 3.0 upgrade guide.](https://github.com/cloudcreativity/laravel-json-api/blob/v3.3.0/docs/upgrade.md)

helpers.php

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

lang/en/errors.php

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

lang/en/validation.php

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