Merge branch 'release/1.0.0' into main

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +3,31 @@
 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/).
 
+## [1.0.0] - 2021-07-31
+
+### Added
+
+- New relationship filter classes: `Has`, `WhereHas`, `WhereDoesntHave`. Refer to
+  the [filter documentation](https://laraveljsonapi.io/docs/1.0/schemas/filters.html#available-filters) for details.
+
+### Changed
+
+- **BREAKING: Countable Relationships.** This feature is now turned off by default. Although included in the 1.0
+  release, this feature is **not considered production-ready**. This is because we plan to make breaking changes to it,
+  which will change how the client requests countable relationships. As such, this feature is considered
+  highly-experimental and developers must opt-in to it by calling the `canCount()` method on a relationship. Refer to
+  the [Countable relationships chapter](https://laraveljsonapi.io/docs/1.0/digging-deeper/countable.html) in the
+  documentation for more details.
+- **BREAKING: Cursor Pagination.** Laravel now has its own cursor pagination feature. We have therefore moved our
+  implementation into its own
+  package: [laravel-json-api/cursor-pagination](https://github.com/laravel-json-api/cursor-pagination)
+  This change has been made because it makes sense for the in-built cursor pagination implementation to use Laravel's
+  cursor pagination implementation rather than our own custom one. Support for Laravel's cursor pagination will be added
+  during the `1.x` release cycle. If you are already using our cursor implementation, you can migrate in two easy steps:
+    1. Install the new package: `composer require laravel-json-api/cursor-pagination`
+    2. In any schemas using the cursor pagination, change the import statement
+       from `LaravelJsonApi\Eloquent\Pagination\CursorPagination` to `LaravelJsonApi\CursorPagination\CursorPagination`.
+
 ## [1.0.0-beta.5] - 2021-07-10
 
 ### Added

README.md

@@ -19,6 +19,16 @@ composer require laravel-json-api/laravel
 
 See our documentation for further installation instructions.
 
+## Upgrading
+
+When upgrading you typically want to upgrade this package and all our related packages. This is the recommended way:
+
+```bash
+composer require laravel-json-api/laravel --no-update
+composer require laravel-json-api/testing --dev --no-update
+composer up laravel-json-api/* cloudcreativity/json-api-testing
+```
+
 ## Example Application
 
 To view an example Laravel application that uses this package, see the

composer.json

@@ -25,17 +25,17 @@
     "require": {
         "php": "^7.4|^8.0",
         "ext-json": "*",
-        "laravel-json-api/core": "^1.0.0-beta.5",
-        "laravel-json-api/eloquent": "^1.0.0-beta.6",
-        "laravel-json-api/encoder-neomerx": "^1.0.0-beta.1",
-        "laravel-json-api/exceptions": "^1.0.0-beta.4",
-        "laravel-json-api/spec": "^1.0.0-beta.2",
-        "laravel-json-api/validation": "^1.0.0-beta.2",
+        "laravel-json-api/core": "^1.0.0",
+        "laravel-json-api/eloquent": "^1.0.0",
+        "laravel-json-api/encoder-neomerx": "^1.0.0",
+        "laravel-json-api/exceptions": "^1.0.0",
+        "laravel-json-api/spec": "^1.0.0",
+        "laravel-json-api/validation": "^1.0.0",
         "laravel/framework": "^8.30"
     },
     "require-dev": {
-        "laravel-json-api/hashids": "^1.0.0-beta.3",
-        "laravel-json-api/testing": "^1.0.0-beta.1",
+        "laravel-json-api/hashids": "^1.0.0",
+        "laravel-json-api/testing": "^1.0.0",
         "orchestra/testbench": "^6.9",
         "phpunit/phpunit": "^9.5"
     },
@@ -54,7 +54,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "1.x-dev"
+            "dev-develop": "1.x-dev",
+            "dev-2.x": "2.x-dev"
         },
         "laravel": {
             "aliases": {

tests/dummy/app/JsonApi/V1/Posts/PostSchema.php

@@ -69,18 +69,18 @@ public function fields(): array
         return [
             HashId::make()->alreadyHashed()->withLength(10),
             BelongsTo::make('author')->type('users')->readOnly(),
-            HasMany::make('comments')->readOnly(),
+            HasMany::make('comments')->canCount()->readOnly(),
             Str::make('content'),
             DateTime::make('createdAt')->sortable()->readOnly(),
             SoftDelete::make('deletedAt')->sortable(),
             MorphToMany::make('media', [
                 BelongsToMany::make('images'),
                 BelongsToMany::make('videos'),
-            ]),
+            ])->canCount(),
             DateTime::make('publishedAt')->sortable(),
             Str::make('slug'),
             Str::make('synopsis'),
-            BelongsToMany::make('tags')->mustValidate(),
+            BelongsToMany::make('tags')->canCount()->mustValidate(),
             Str::make('title')->sortable(),
             DateTime::make('updatedAt')->sortable()->readOnly(),
         ];

tests/dummy/app/JsonApi/V1/Tags/TagSchema.php

@@ -48,10 +48,12 @@ public function fields(): array
             DateTime::make('createdAt')->sortable()->readOnly(),
             Str::make('name')->sortable(),
             BelongsToMany::make('posts')
+                ->canCount()
                 ->cannotEagerLoad()
                 ->readOnly(),
             DateTime::make('updatedAt')->sortable()->readOnly(),
             BelongsToMany::make('videos')
+                ->canCount()
                 ->cannotEagerLoad()
                 ->readOnly(),
         ];

tests/dummy/app/JsonApi/V1/Videos/VideoSchema.php

@@ -46,7 +46,7 @@ public function fields(): array
         return [
             ID::make()->uuid()->clientIds(),
             DateTime::make('createdAt')->sortable()->readOnly(),
-            BelongsToMany::make('tags'),
+            BelongsToMany::make('tags')->canCount(),
             Str::make('title')->sortable(),
             DateTime::make('updatedAt')->sortable()->readOnly(),
             Str::make('url'),

tests/dummy/tests/Api/V1/Posts/IndexTest.php

@@ -245,7 +245,6 @@ public function testWithCount(): void
         Post::factory()->create(['published_at' => null]);
 
         $response = $this
-            ->withoutExceptionHandling()
             ->jsonApi()
             ->expects('posts')
             ->query(['withCount' => 'tags'])