Merge branch 'release/1.0.0-alpha.2' 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 "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

.travis.yml

@@ -3,6 +3,44 @@
 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-alpha.2] - 2021-02-02
+
+### Added
+
+- [#1](https://github.com/laravel-json-api/laravel/pull/1)
+  Resource classes are now optional. If one is not defined, the implementation falls-back to using the Eloquent schema
+  to serialize a model. Eloquent schema fields now have new
+  `hidden` and `serializeUsing` methods to customise the serialization of models by the schema.
+- Resource classes now support using conditional attributes in their `meta()` method.
+- New field classes `ArrayList` and `ArrayHash` have been added, to distinguish between PHP zero-indexed arrays that
+  serialize to JSON arrays (`ArrayList`) and PHP associative arrays that serialize to JSON objects (`ArrayHash`). The
+  distinction is required because an empty array list can be serialized to `[]` in JSON whereas an empty associative
+  array must be serialized to `null` in JSON.
+
+### Changed
+
+- **BREAKING** The JsonApiResource method signatures for the `attributes()`, `relationships()`,
+  `meta()`, and `links()` methods have been changed so that they receive the HTTP request as the first (and only)
+  parameter. This brings the implementation in line with Laravel's Eloquent resources, which receive the request to
+  their `toArray()` method. The slight difference is our implementation allows the request to be `null` - this is to
+  cover encoding resources outside of HTTP requests, e.g. queued broadcasting. When upgrading, you will need to either
+  delete resource classes (as they are now optional), or update the method signatures on any classes you are retaining.
+
+### Fixed
+
+- [#3](https://github.com/laravel-json-api/laravel/issues/3)
+  Example server registration in the published configuration file prevented developer from creating a `v1` server after
+  adding this package to their Laravel application.
+- Package discovery for sub-packages that have service providers now works correctly.
+
+### Removed
+
+- **BREAKING** The `Arr` schema field has been removed - use the new `ArrayList` or `ArrayHash`
+  fields instead.
+- **BREAKING** The `uri` method on resource and relationship routes has been removed:
+    - The resource type URI can now be set on the resource's schema (using the `$uriType` property).
+    - Relationship URIs are now set on the schema field for the relationship (via the `withUriFieldName` method).
+
 ## [1.0.0-alpha.1] - 2021-01-25
 
 Initial release.

CHANGELOG.md

@@ -25,16 +25,16 @@
     "require": {
         "php": "^7.4|^8.0",
         "ext-json": "*",
-        "laravel-json-api/core": "^1.0.0-alpha.1",
-        "laravel-json-api/eloquent": "^1.0.0-alpha.1",
-        "laravel-json-api/encoder-neomerx": "^1.0.0-alpha.1",
+        "laravel-json-api/core": "^1.0.0-alpha.2",
+        "laravel-json-api/eloquent": "^1.0.0-alpha.2",
+        "laravel-json-api/encoder-neomerx": "^1.0.0-alpha.2",
         "laravel-json-api/exceptions": "^1.0.0-alpha.1",
-        "laravel-json-api/spec": "^1.0.0-alpha.1",
-        "laravel-json-api/validation": "^1.0.0-alpha.1",
+        "laravel-json-api/spec": "^1.0.0-alpha.2",
+        "laravel-json-api/validation": "^1.0.0-alpha.2",
         "laravel/framework": "^8.0"
     },
     "require-dev": {
-        "laravel-json-api/testing": "^1.0@alpha",
+        "laravel-json-api/testing": "^1.0.0-alpha.1",
         "orchestra/testbench": "^6.9",
         "phpunit/phpunit": "^9.5"
     },
@@ -56,16 +56,16 @@
             "dev-develop": "1.x-dev"
         },
         "laravel": {
-            "providers": [
-                "LaravelJsonApi\\Laravel\\ServiceProvider"
-            ],
             "aliases": {
                 "JsonApi": "LaravelJsonApi\\Core\\Facades\\JsonApi",
                 "JsonApiRoute": "LaravelJsonApi\\Laravel\\Facades\\JsonApiRoute"
-            }
+            },
+            "providers": [
+                "LaravelJsonApi\\Laravel\\ServiceProvider"
+            ]
         }
     },
-    "minimum-stability": "stable",
+    "minimum-stability": "dev",
     "prefer-stable": true,
     "config": {
         "sort-packages": true

composer.json

@@ -27,6 +27,6 @@
     | class name of the server class.
     */
     'servers' => [
-        'v1' => \App\JsonApi\V1\Server::class,
+//        'v1' => \App\JsonApi\V1\Server::class,
     ],
 ];

config/jsonapi.php

@@ -449,7 +449,7 @@ protected function existingAttributes(object $model): iterable
     {
         $resource = $this->resources()->create($model);
 
-        return $resource->attributes();
+        return $resource->attributes($this);
     }
 
     /**
@@ -463,7 +463,7 @@ protected function existingRelationships(object $model): iterable
         $resource = $this->resources()->create($model);
 
         /** @var Relation $relationship */
-        foreach ($resource->relationships() as $relationship) {
+        foreach ($resource->relationships($this) as $relationship) {
             if ($relationship->isValidated()) {
                 yield $relationship->fieldName() => $relationship->data();
             }

src/Http/Requests/ResourceRequest.php

@@ -82,19 +82,6 @@ public function __construct(
         $this->options = [];
     }
 
-    /**
-     * Set the URI for the relationship, if it is not the same as the field name.
-     *
-     * @param string $uri
-     * @return $this
-     */
-    public function uri(string $uri): self
-    {
-        $this->options['relationship_uri'] = $uri;
-
-        return $this;
-    }
-
     /**
      * Set the methods the controller should apply to.
      *

src/Routing/PendingRelationshipRegistration.php

@@ -82,19 +82,6 @@ public function __construct(
         $this->options = [];
     }
 
-    /**
-     * Set the URI for the resource type, if it is not the same as the resource type's name.
-     *
-     * @param string $uri
-     * @return $this
-     */
-    public function uri(string $uri): self
-    {
-        $this->options['resource_uri'] = $uri;
-
-        return $this;
-    }
-
     /**
      * Set the methods the controller should apply to.
      *

src/Routing/PendingResourceRegistration.php

@@ -22,6 +22,7 @@
 use Illuminate\Contracts\Routing\Registrar as RegistrarContract;
 use Illuminate\Routing\Route as IlluminateRoute;
 use Illuminate\Routing\RouteCollection;
+use LaravelJsonApi\Contracts\Schema\Schema;
 use LaravelJsonApi\Core\Support\Str;
 
 class RelationshipRegistrar
@@ -32,6 +33,11 @@ class RelationshipRegistrar
      */
     private RegistrarContract $router;
 
+    /**
+     * @var Schema
+     */
+    private Schema $schema;
+
     /**
      * @var string
      */
@@ -51,17 +57,20 @@ class RelationshipRegistrar
      * RelationshipRegistrar constructor.
      *
      * @param RegistrarContract $router
+     * @param Schema $schema
      * @param string $resourceType
      * @param string $controller
      * @param string $parameter
      */
     public function __construct(
         RegistrarContract $router,
+        Schema $schema,
         string $resourceType,
         string $controller,
         string $parameter
     ) {
         $this->router = $router;
+        $this->schema = $schema;
         $this->resourceType = $resourceType;
         $this->controller = $controller;
         $this->parameter = $parameter;
@@ -95,7 +104,7 @@ public function register(string $fieldName, bool $hasMany, array $options = []):
      */
     protected function addShowRelated(string $fieldName, array $options): IlluminateRoute
     {
-        $uri = $this->getRelationshipUri($fieldName, $options);
+        $uri = $this->getRelationshipUri($fieldName);
         $action = $this->getRelationshipAction(
             'showRelated',
             'showRelated' . Str::classify($fieldName),
@@ -120,7 +129,7 @@ protected function addShowRelated(string $fieldName, array $options): Illuminate
      */
     protected function addShowRelationship(string $fieldName, array $options): IlluminateRoute
     {
-        $uri = $this->getRelationshipUri($fieldName, $options);
+        $uri = $this->getRelationshipUri($fieldName);
         $action = $this->getRelationshipAction(
             'showRelationship',
             'show' . Str::classify($fieldName),
@@ -145,7 +154,7 @@ protected function addShowRelationship(string $fieldName, array $options): Illum
      */
     protected function addUpdateRelationship(string $fieldName, array $options): IlluminateRoute
     {
-        $uri = $this->getRelationshipUri($fieldName, $options);
+        $uri = $this->getRelationshipUri($fieldName);
         $action = $this->getRelationshipAction(
             'updateRelationship',
             'update' . Str::classify($fieldName),
@@ -170,7 +179,7 @@ protected function addUpdateRelationship(string $fieldName, array $options): Ill
      */
     protected function addAttachRelationship(string $fieldName, array $options): IlluminateRoute
     {
-        $uri = $this->getRelationshipUri($fieldName, $options);
+        $uri = $this->getRelationshipUri($fieldName);
         $action = $this->getRelationshipAction(
             'attachRelationship',
             'attach' . Str::classify($fieldName),
@@ -195,7 +204,7 @@ protected function addAttachRelationship(string $fieldName, array $options): Ill
      */
     protected function addDetachRelationship(string $fieldName, array $options): IlluminateRoute
     {
-        $uri = $this->getRelationshipUri($fieldName, $options);
+        $uri = $this->getRelationshipUri($fieldName);
         $action = $this->getRelationshipAction(
             'detachRelationship',
             'detach' . Str::classify($fieldName),
@@ -277,16 +286,11 @@ private function getRelationshipAction(
 
     /**
      * @param string $fieldName
-     * @param array $options
      * @return string
      */
-    private function getRelationshipUri(string $fieldName, array $options): string
+    private function getRelationshipUri(string $fieldName): string
     {
-        if (isset($options['relationship_uri'])) {
-            return $options['relationship_uri'];
-        }
-
-        return Str::dasherize($fieldName);
+        return $this->schema->relationship($fieldName)->uriName();
     }
 
     /**