Merge branch 'release/1.3.0'

Author: lindyhopchris

.travis.yml

@@ -4,55 +4,47 @@ sudo: false
 
 matrix:
   include:
-  - php: 7.1
-    env:
-    - LARAVEL_VERSION=5.5.*
-    - PHPUNIT_VERSION=^6.5
-  - php: 7.1
-    env:
-    - LARAVEL_VERSION=5.6.*
-    - PHPUNIT_VERSION=^7.0
-  - php: 7.1
-    env:
-    - LARAVEL_VERSION=5.7.*
-    - PHPUNIT_VERSION=^7.0
-  - php: 7.2
-    env:
-    - LARAVEL_VERSION=5.5.*
-    - PHPUNIT_VERSION=^6.5
-  - php: 7.2
-    env:
-    - LARAVEL_VERSION=5.6.*
-    - PHPUNIT_VERSION=^7.0
-  - php: 7.2
-    env:
-    - LARAVEL_VERSION=5.7.*
-    - PHPUNIT_VERSION=^7.0
-  - php: 7.2
-    env:
-      - LARAVEL_VERSION=5.8.*
-      - PHPUNIT_VERSION=^7.0
-  - php: 7.3
-    env:
-    - LARAVEL_VERSION=5.5.*
-    - PHPUNIT_VERSION=^6.5
-  - php: 7.3
-    env:
-    - LARAVEL_VERSION=5.6.*
-    - PHPUNIT_VERSION=^7.0
-  - php: 7.3
-    env:
-    - LARAVEL_VERSION=5.7.*
-    - PHPUNIT_VERSION=^7.0
-  - php: 7.3
-    env:
-      - LARAVEL_VERSION=5.8.*
-      - PHPUNIT_VERSION=^7.5
+    - php: 7.1
+      env:
+        - LARAVEL_VERSION=5.5.*
+        - PHPUNIT_VERSION=^6.5
+    - php: 7.1
+      env:
+        - LARAVEL_VERSION=5.6.*
+        - PHPUNIT_VERSION=^7.0
+    - php: 7.1
+      env:
+        - LARAVEL_VERSION=5.7.*
+        - PHPUNIT_VERSION=^7.0
+    - php: 7.2
+      env:
+        - LARAVEL_VERSION=5.5.*
+        - PHPUNIT_VERSION=^6.5
+    - php: 7.2
+      env:
+        - LARAVEL_VERSION=5.8.*
+        - PHPUNIT_VERSION=^7.0
+    - php: 7.2
+      env:
+        - LARAVEL_VERSION=5.9.*
+        - PHPUNIT_VERSION=^7.0
+    - php: 7.3
+      env:
+        - LARAVEL_VERSION=5.5.*
+        - PHPUNIT_VERSION=^6.5
+    - php: 7.3
+      env:
+        - LARAVEL_VERSION=5.8.*
+        - PHPUNIT_VERSION=^7.0
+    - php: 7.3
+      env:
+        - LARAVEL_VERSION=5.9.*
+        - PHPUNIT_VERSION=^7.5
 
 install:
-- composer require "laravel/framework:${LARAVEL_VERSION}" --no-update -n
-- composer require "phpunit/phpunit:${PHPUNIT_VERSION}" --dev --no-update -n
-- travis_retry composer install --no-suggest --prefer-dist -n -o
+  - composer require "laravel/framework:${LARAVEL_VERSION}" --no-update -n
+  - composer require "phpunit/phpunit:${PHPUNIT_VERSION}" --dev --no-update -n
+  - travis_retry composer install --no-suggest --prefer-dist -n -o
 
 script:
   - vendor/bin/phpunit

CHANGELOG.md

@@ -2,6 +2,34 @@
 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.3.0] - 2019-07-24
+
+Package now supports Laravel 5.9.
+
+### Added
+- [#352](https://github.com/cloudcreativity/laravel-json-api/issues/352)
+Can now set an API's default controller name to the singular version of the resource type.
+- Can now register a callback for resolving a controller name from a resource type.
+- [#373](https://github.com/cloudcreativity/laravel-json-api/issues/373)
+Can now change the JSON API controller's default connection and whether it uses transactions
+via an API's config.
+- [#377](https://github.com/cloudcreativity/laravel-json-api/issues/377)
+Can now toggle the simple pagination strategy back to using length aware pagination.
+- [#380](https://github.com/cloudcreativity/laravel-json-api/issues/380)
+Can now customise the conversion of a resource id to a database id on an adapter by overloading the
+`databaseId()` method.
+- New `HasOne` and `HasMany` rule objects for validating that a relationship is *to-one* or
+*to-many*, and has the expected resource type(s).
+- [#391](https://github.com/cloudcreativity/laravel-json-api/issues/391)
+Allow the validators `existingRelationships()` method to return the existing related records,
+and automatically convert these to JSON API identifiers.
+
+### Fixed
+- [#371](https://github.com/cloudcreativity/laravel-json-api/issues/371)
+Ensure Eloquent delete/deleting events are fired when soft-deleting a resource.
+- Eloquent adapter hooks will now be invoked when force-deleting a resource that uses
+the `SoftDeletesModels` trait.
+
 ## [1.2.0] - 2019-06-20
 
 ### Added

README.md

@@ -33,13 +33,7 @@ The following additional features are also supported:
 - Support multiple media-types within your API.
 - Generators for all the classes you need to add a resource to your API.
 
-Installation instructions and documentation are available on
-[Read the Docs](http://laravel-json-api.readthedocs.io/en/latest/).
-
-> Credit where credit is due: this package is based on the framework agnostic package
-[neomerx/json-api](https://github.com/neomerx/json-api).
-
-## What is JSON API?
+### What is JSON API?
 
 From [jsonapi.org](http://jsonapi.org)
 
@@ -52,6 +46,14 @@ efficiently caching responses, sometimes eliminating network requests entirely.
 
 For full information on the spec, plus examples, see [http://jsonapi.org](http://jsonapi.org).
 
+## Tutorial and Documentation
+
+Want a tutorial to get started? Read the
+[*How to JSON:API* Laravel tutorial.](https://howtojsonapi.com/laravel.html)
+
+Full package documentation is available on
+[Read the Docs](http://laravel-json-api.readthedocs.io/en/latest/).
+
 ## Demo
 
 A demo application is available at [here](https://github.com/cloudcreativity/demo-laravel-json-api).
@@ -60,6 +62,7 @@ A demo application is available at [here](https://github.com/cloudcreativity/dem
 
 | Laravel | This Package | EOL? |
 | --- | --- | --- |
+| 5.9.* | `^1.3` | - |
 | 5.8.* | `^1.0` | - |
 | 5.7.* | `^1.0` | - |
 | 5.6.* | `^1.0` | - |
@@ -75,10 +78,6 @@ Currently we have not integrated the package with Lumen. We do not have any acti
 so if you do and can help, please let us know on
 [this issue](https://github.com/cloudcreativity/laravel-json-api/issues/61).
 
-## Documentation
-
-Documentation is available on [Read the Docs](http://laravel-json-api.readthedocs.io/en/latest/).
-
 ## License
 
 Apache License (Version 2.0). Please see [License File](LICENSE) for more information.

composer.json

@@ -25,24 +25,25 @@
         "php": "^7.1",
         "ext-json": "*",
         "cloudcreativity/utils-object": "^1.0",
-        "illuminate/console": "5.5.*|5.6.*|5.7.*|5.8.*",
-        "illuminate/contracts": "5.5.*|5.6.*|5.7.*|5.8.*",
-        "illuminate/database": "5.5.*|5.6.*|5.7.*|5.8.*",
-        "illuminate/filesystem": "5.5.*|5.6.*|5.7.*|5.8.*",
-        "illuminate/http": "5.5.*|5.6.*|5.7.*|5.8.*",
-        "illuminate/pagination": "5.5.*|5.6.*|5.7.*|5.8.*",
-        "illuminate/support": "5.5.*|5.6.*|5.7.*|5.8.*",
+        "illuminate/console": "5.5.*|5.6.*|5.7.*|5.8.*|5.9.*",
+        "illuminate/contracts": "5.5.*|5.6.*|5.7.*|5.8.*|5.9.*",
+        "illuminate/database": "5.5.*|5.6.*|5.7.*|5.8.*|5.9.*",
+        "illuminate/filesystem": "5.5.*|5.6.*|5.7.*|5.8.*|5.9.*",
+        "illuminate/http": "5.5.*|5.6.*|5.7.*|5.8.*|5.9.*",
+        "illuminate/pagination": "5.5.*|5.6.*|5.7.*|5.8.*|5.9.*",
+        "illuminate/support": "5.5.*|5.6.*|5.7.*|5.8.*|5.9.*",
         "neomerx/json-api": "^1.0.3",
         "ramsey/uuid": "^3.0",
         "symfony/psr-http-message-bridge": "^1.0",
         "zendframework/zend-diactoros": "^1.0|^2.0"
     },
     "require-dev": {
         "ext-sqlite3": "*",
-        "cloudcreativity/json-api-testing": "^1.0.0",
+        "cloudcreativity/json-api-testing": "^1.1",
+        "composer/semver": "^1.5",
         "guzzlehttp/guzzle": "^6.3",
         "mockery/mockery": "^1.1",
-        "orchestra/testbench": "3.5.*|3.6.*|3.7.*|3.8.*",
+        "orchestra/testbench": "3.5.*|3.6.*|3.7.*|3.8.*|3.9.*",
         "phpunit/phpunit": "^6.0|^7.0"
     },
     "suggest": {
@@ -77,7 +78,7 @@
             }
         }
     },
-    "minimum-stability": "stable",
+    "minimum-stability": "dev",
     "prefer-stable": true,
     "config": {
         "sort-packages": true

docs/basics/routing.md

@@ -240,25 +240,51 @@ JsonApi::register('default')->routes(function ($api) {
 ## Controllers
 
 By default no controller is required because this package contains a standard controller for processing JSON API
-requests. However it is possible to specify your own controller, using the `controller` option.
+requests. However it is possible to specify that a resource has its own controller, using the `controller` method.
 
 For example, the following would use the `PostsController` in the `Api` namespace:
 
 ```php
 JsonApi::register('default')->withNamespace('Api')->routes(function ($api, $router) {
-    $api->resource('posts')->controller();
+    $api->resource('posts')->controller(); // uses PostsController
 });
 ```
 
+### Controller Names
+
 If you call `controller()` without any arguments, we assume your controller is the camel case name version of 
 the resource type with `Controller` on the end. I.e. `posts` would expect `PostsController` and
-`blog-posts` would expect `BlogPostsController`.
+`blog-posts` would expect `BlogPostsController`. Or if your resource type was `post`,
+we would guess `PostController`.
 
-If your controller does not conform to this expectation, supply the controller name as follows:
+If your resource names are plural, e.g. `posts`, but you would like to use the singular for the controller
+name, i.e. `PostController`, use the `singularControllers()` method as follows:
+
+```php
+JsonApi::register('default')
+    ->withNamespace('Api')
+    ->singularControllers()
+    ->routes(function ($api, $router) {
+        $api->resource('posts')->controller(); // uses PostController
+    });
+```
+
+If your controller names do not conform to either of these patterns, you have two options. Either explicitly
+provide the controller name for each resource, e.g.:
 
 ```php
 JsonApi::register('default')->withNamespace('Api')->routes(function ($api, $router) {
-    $api->resource('posts')->controller('PostController');
+    $api->resource('posts')->controller('PostResourceController');
+});
+```
+
+Or you can provide a callback to work it out from the resource name:
+
+```php
+JsonApi::register('default')->withNamespace('Api')->controllerResolver(function ($resourceType) {
+    return ucfirst($resourceType) . 'ResourceController';
+})->routes(function ($api, $router) {
+    $api->resource('posts')->controller(); // expects PostsResourceController
 });
 ```
 
@@ -275,7 +301,7 @@ JsonApi::register('default')
     ->withNamespace('Api')
     ->defaultController('DefaultController')
     ->routes(function ($api, $router) {
-        $api->resource('posts')->controller();
+        $api->resource('posts'); // uses DefaultController instead of our JsonApiController
     });
 ```