Rewrite

Author: tobyzerner

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.html]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.github/workflows/docs.yml

@@ -1,22 +1,34 @@
 name: Deploy Docs
 
 on:
+  workflow_dispatch: {}
   push:
-     branches: [ master ]
+    branches: [main]
 
 jobs:
-  build-and-deploy:
-    
+  deploy:
     runs-on: ubuntu-latest
-    
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
-    - uses: actions/checkout@v2
-
-    - name: vuepress-deploy
-      uses: jenkey2011/vuepress-deploy@master
-      env:
-        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-        TARGET_REPO: tobyzerner/json-api-server
-        TARGET_BRANCH: gh-pages
-        BUILD_SCRIPT: npm i && npm run docs:build
-        BUILD_DIR: docs/.vuepress/dist/
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+      - run: npm ci
+      - name: Build
+        run: npm run docs:build
+      - uses: actions/configure-pages@v2
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/.vitepress/dist
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/php.yml

@@ -0,0 +1,24 @@
+name: Prettier
+
+on: [push, pull_request]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # Make sure the actual branch is checked out when running on pull requests
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - uses: creyD/[email protected]
+        with:
+          prettier_options: --write .
+          prettier_plugins: '@prettier/plugin-php'
+          only_changed: true
+          commit_message: 'Run Prettier'

.github/workflows/prettier.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-versions: ['8.1', '8.2']
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: json
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --prefer-dist
+
+      - name: Run test suite
+        run: composer run-script test

.github/workflows/tests.yml

@@ -2,3 +2,5 @@ composer.lock
 vendor
 node_modules
 .phpunit.result.cache
+.vitepress/dist
+.vitepress/cache

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+vendor
+pnpm-lock.yaml

.phpunit.cache/test-results

@@ -0,0 +1,17 @@
+{
+    "singleQuote": true,
+    "printWidth": 100,
+    "proseWrap": "always",
+    "phpVersion": "8.1",
+    "plugins": [
+        "@prettier/plugin-php"
+    ],
+    "overrides": [
+        {
+            "files": "docs/**/*",
+            "options": {
+                "printWidth": 80
+            }
+        }
+    ]
+}

.prettierignore

@@ -6,78 +6,99 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [0.2.0] - 2022-06-21
+
 ### Fixed
-- Fix `EloquentAdapter::filterByIds()` getting key name from query model instead of adapter model
-- Fix deprecation notice on PHP 8.1
+
+-   Fix `EloquentAdapter::filterByIds()` getting key name from query model instead of adapter model
+-   Fix deprecation notice on PHP 8.1
 
 ## [0.2.0-beta.6] - 2022-04-22
+
 ### Changed
-- Add support for `doctrine/inflector:^2.0`
+
+-   Add support for `doctrine/inflector:^2.0`
 
 ## [0.2.0-beta.5] - 2022-01-03
+
 ### Added
-- `Context::getBody()` method to retrieve the parsed JSON:API payload from the request
-- `Context::sortRequested()` method to determine if a sort field has been requested
+
+-   `Context::getBody()` method to retrieve the parsed JSON:API payload from the request
+-   `Context::sortRequested()` method to determine if a sort field has been requested
 
 ### Fixed
-- `Laravel\rules()`: Fix regression disallowing use of advanced validation rules like callbacks and `Rule` instances. (@SychO9)
+
+-   `Laravel\rules()`: Fix regression disallowing use of advanced validation rules like callbacks and `Rule` instances. (@SychO9)
 
 ## [0.2.0-beta.4] - 2021-09-05
+
 ### Added
-- `Laravel\rules()`: Replace `{id}` placeholder in rules with the model's key.
-  - This is useful for the `unique` rule, for example: `unique:users,email,{id}`
-- `Laravel\can()`: Pass through additional arguments to Gate check.
-  - This is needed to use policy methods without models, for example: `can('create', Post::class)`
+
+-   `Laravel\rules()`: Replace `{id}` placeholder in rules with the model's key.
+    -   This is useful for the `unique` rule, for example: `unique:users,email,{id}`
+-   `Laravel\can()`: Pass through additional arguments to Gate check.
+    -   This is needed to use policy methods without models, for example: `can('create', Post::class)`
 
 ### Changed
-- Get a fresh copy of the model to display after create/update to ensure consistency
-- Respond with `400 Bad Request` when attempting to filter on an attribute of a polymorphic relationship
+
+-   Get a fresh copy of the model to display after create/update to ensure consistency
+-   Respond with `400 Bad Request` when attempting to filter on an attribute of a polymorphic relationship
 
 ## [0.2.0-beta.3] - 2021-09-03
+
 ### Fixed
-- Fix dependency on `http-accept` now that a version has been tagged
-- Change `EloquentAdapter` to load relationships using `load` instead of `loadMissing`, as they may need API-specific scopes applied
+
+-   Fix dependency on `http-accept` now that a version has been tagged
+-   Change `EloquentAdapter` to load relationships using `load` instead of `loadMissing`, as they may need API-specific scopes applied
 
 ## [0.2.0-beta.2] - 2021-09-01
+
 ### Added
-- Content-Type validation and Accept negotiation
-- Include `jsonapi` object with `version` member in response
-- Validate implementation-specific query parameters according to specification
-- Added `Location` header to `201 Created` responses
-- Improved error responses when creating and updating resources
-- `Context::filter()` method to get the value of a filter
-- `ResourceType::applyScope()`, `applyFilter()` and `applySort()` methods
-- `ResourceType::url()` method to get the URL for a model
-- `Forbidden` error details for CRUD actions, useful when running Atomic Operations
-- `JsonApi::getExtensions()` method to get all registered extensions
-- `ConflictException` class
+
+-   Content-Type validation and Accept negotiation
+-   Include `jsonapi` object with `version` member in response
+-   Validate implementation-specific query parameters according to specification
+-   Added `Location` header to `201 Created` responses
+-   Improved error responses when creating and updating resources
+-   `Context::filter()` method to get the value of a filter
+-   `ResourceType::applyScope()`, `applyFilter()` and `applySort()` methods
+-   `ResourceType::url()` method to get the URL for a model
+-   `Forbidden` error details for CRUD actions, useful when running Atomic Operations
+-   `JsonApi::getExtensions()` method to get all registered extensions
+-   `ConflictException` class
 
 ### Changed
-- Renamed `$linkage` parameter in `AdapterInterface` methods to `$linkageOnly`
-- Renamed `Type::newModel()` to `model()` to be consistent with Adapter
+
+-   Renamed `$linkage` parameter in `AdapterInterface` methods to `$linkageOnly`
+-   Renamed `Type::newModel()` to `model()` to be consistent with Adapter
 
 ### Fixed
-- Properly respond with meta information added to `Context` instance
+
+-   Properly respond with meta information added to `Context` instance
 
 ## [0.2.0-beta.1] - 2021-08-27
+
 ### Added
-- Preliminary support for Extensions
-- Support filtering by nested relationships/attributes (eg. `filter[relationship.attribute]=value`)
-- Add new methods to Context object: `getApi`, `getPath`, `fieldRequested`, `meta`
-- Eloquent adapter: apply scopes when including polymorphic relationships
-- Laravel validation helper: support nested validation messages
-- Allow configuration of sort and filter visibility
-- Add new `setId` method to `AdapterInterface`
+
+-   Preliminary support for Extensions
+-   Support filtering by nested relationships/attributes (eg. `filter[relationship.attribute]=value`)
+-   Add new methods to Context object: `getApi`, `getPath`, `fieldRequested`, `meta`
+-   Eloquent adapter: apply scopes when including polymorphic relationships
+-   Laravel validation helper: support nested validation messages
+-   Allow configuration of sort and filter visibility
+-   Add new `setId` method to `AdapterInterface`
 
 ### Changed
-- Change paradigm for eager loading relationships; allow fields to return `Deferred` values to be evaluated after all other fields, so that resource loading can be buffered.
-- Remove `on` prefix from field event methods
+
+-   Change paradigm for eager loading relationships; allow fields to return `Deferred` values to be evaluated after all other fields, so that resource loading can be buffered.
+-   Remove `on` prefix from field event methods
 
 ### Removed
-- Removed `load` and `dontLoad` field methods
+
+-   Removed `load` and `dontLoad` field methods
 
 ### Fixed
-- Fix pagination next link appearing when it shouldn't
+
+-   Fix pagination next link appearing when it shouldn't
 
 [0.2.0]: https://github.com/tobyzerner/json-api-server/compare/v0.2.0...v0.2.0-beta.6
 [0.2.0-beta.6]: https://github.com/tobyzerner/json-api-server/compare/v0.2.0-beta.6...v0.2.0-beta.5