Merge pull request #6 from kjsoftware/feature/EPBASIC-2370

Feature/epbasic 2370

Author: thuijbers

.github/workflows/dependabot-auto-merge.yml

@@ -13,7 +13,7 @@ jobs:
 
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.3.6
+        uses: dependabot/fetch-metadata@v2.1.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
           compat-lookup: true

.github/workflows/php-cs-fixer.yml

@@ -8,7 +8,7 @@ jobs:
 
         steps:
             - name: Checkout code
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   ref: ${{ github.head_ref }}
 
@@ -18,6 +18,6 @@ jobs:
                   args: --config=.php_cs.dist.php --allow-risky=yes
 
             - name: Commit changes
-              uses: stefanzweifel/git-auto-commit-action@v4
+              uses: stefanzweifel/git-auto-commit-action@v5
               with:
                   commit_message: Fix styling

.github/workflows/phpstan.yml

@@ -0,0 +1,26 @@
+name: PHPStan
+
+on:
+    push:
+        paths:
+            - '**.php'
+            - 'phpstan.neon.dist'
+
+jobs:
+    phpstan:
+        name: phpstan
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: '8.2'
+                  coverage: none
+
+            - name: Install composer dependencies
+              uses: ramsey/composer-install@v3
+
+            - name: Run PHPStan
+              run: ./vendor/bin/phpstan --error-format=github

.github/workflows/run-tests.yml

@@ -1,27 +1,31 @@
 name: run-tests
 
-on: [push, pull_request]
+on:
+    push:
+        paths:
+            - '**.php'
+            - '.github/workflows/run-tests.yml'
+            - 'phpunit.xml.dist'
+            - 'composer.json'
+            - 'composer.lock'
 
 jobs:
     test:
         runs-on: ${{ matrix.os }}
+        timeout-minutes: 5
         strategy:
-            fail-fast: false
+            fail-fast: true
             matrix:
                 os: [ubuntu-latest]
-                php: [8.2, 8.1, 8.0]
-                laravel: [9.*, 10.*]
-                stability: [prefer-lowest, prefer-stable]
+                php: [8.3, 8.2]
+                laravel: [10.*, 11.*]
+                stability: [prefer-stable]
                 include:
-                    - laravel: 10.*
-                      testbench: 8.*
-                      carbon: ^2.63
-                    - laravel: 9.*
-                      testbench: 7.*
+                    - laravel: 11.*
+                      testbench: 9.*
                       carbon: ^2.63
-                exclude:
                     - laravel: 10.*
-                      php: 8.0                         
+                      testbench: 8.*
 
         name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
@@ -48,10 +52,8 @@ jobs:
                     --health-retries 5
 
         steps:
-
-
             - name: Checkout code
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
@@ -67,7 +69,7 @@ jobs:
 
             - name: Install dependencies
               run: |
-                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "nesbot/carbon:${{ matrix.carbon }}" --no-interaction --no-update
+                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}"  --no-interaction --no-update
                   composer update --${{ matrix.stability }} --prefer-dist --no-interaction
 
             - name: Execute tests

.github/workflows/update-changelog.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: main
 
@@ -21,7 +21,7 @@ jobs:
           release-notes: ${{ github.event.release.body }}
 
       - name: Commit updated CHANGELOG
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
           branch: main
           commit_message: Update CHANGELOG

.phpunit.cache/test-results

@@ -2,6 +2,143 @@
 
 All notable changes to `laravel-query-builder` will be documented in this file
 
+## 6.0.1 - 2024-05-21
+
+### What's Changed
+
+* Fix ability to filter models by an array as filter value by @inmula in https://github.com/spatie/laravel-query-builder/pull/943
+
+### New Contributors
+
+* @inmula made their first contribution in https://github.com/spatie/laravel-query-builder/pull/943
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.0.0...6.0.1
+
+## 6.0.0 - 2024-05-10
+
+### What's Changed
+
+* Add additional types & Phpstan by @Nielsvanpach in https://github.com/spatie/laravel-query-builder/pull/910
+
+### New Contributors
+
+* @Nielsvanpach made their first contribution in https://github.com/spatie/laravel-query-builder/pull/910
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.8.1...6.0.0
+
+## 5.8.1 - 2024-05-10
+
+### What's Changed
+
+* Fix typo by @justinkekeocha in https://github.com/spatie/laravel-query-builder/pull/926
+* List query-builder-ts front-end implementation package by @rogervila in https://github.com/spatie/laravel-query-builder/pull/925
+* Fix incorrect escape character in SQL for LIKE query in partial filter by @Talpx1 in https://github.com/spatie/laravel-query-builder/pull/927
+
+### New Contributors
+
+* @justinkekeocha made their first contribution in https://github.com/spatie/laravel-query-builder/pull/926
+* @rogervila made their first contribution in https://github.com/spatie/laravel-query-builder/pull/925
+* @Talpx1 made their first contribution in https://github.com/spatie/laravel-query-builder/pull/927
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.8.0...5.8.1
+
+## 5.8.0 - 2024-02-06
+
+### What's Changed
+
+* [Docs] Update config file content by @shdehnavi in https://github.com/spatie/laravel-query-builder/pull/918
+* Bump: Deprecating Laravel 9 and PHP 8.1, adding Laravel 11 support by @JustSteveKing in https://github.com/spatie/laravel-query-builder/pull/922
+
+### New Contributors
+
+* @shdehnavi made their first contribution in https://github.com/spatie/laravel-query-builder/pull/918
+* @JustSteveKing made their first contribution in https://github.com/spatie/laravel-query-builder/pull/922
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.7.0...5.8.0
+
+## 5.7.0 - 2024-01-08
+
+### What's Changed
+
+* Start testing against PHP 8.3 by @sergiy-petrov in https://github.com/spatie/laravel-query-builder/pull/899
+* Add the possibility to use the literal relation names in the `allowedFields`. by @carvemerson in https://github.com/spatie/laravel-query-builder/pull/917
+* Add `unsetDefault` as a replacement for `default(null)` which was removed in 5.6.0 by @patrickrobrecht in https://github.com/spatie/laravel-query-builder/pull/902
+* Allow passing an array to the `defaultSort` function as documented by @MajidMohammadian in https://github.com/spatie/laravel-query-builder/pull/904
+* Add `disable_invalid_includes_query_exception` config option by @dimzeta in https://github.com/spatie/laravel-query-builder/pull/906
+* Update `AllowedFilter.php` to include `getFilterClass` function by @justasSendrauskas in https://github.com/spatie/laravel-query-builder/pull/909
+
+### New Contributors
+
+* @sergiy-petrov made their first contribution in https://github.com/spatie/laravel-query-builder/pull/899
+* @carvemerson made their first contribution in https://github.com/spatie/laravel-query-builder/pull/917
+* @patrickrobrecht made their first contribution in https://github.com/spatie/laravel-query-builder/pull/902
+* @MajidMohammadian made their first contribution in https://github.com/spatie/laravel-query-builder/pull/904
+* @dimzeta made their first contribution in https://github.com/spatie/laravel-query-builder/pull/906
+* @justasSendrauskas made their first contribution in https://github.com/spatie/laravel-query-builder/pull/909
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.6.0...5.7.0
+
+## 5.6.0 - 2023-10-05
+
+### What's Changed
+
+- Add support for defining includes by callback by @enricodelazzari in https://github.com/spatie/laravel-query-builder/pull/894
+- Add nullable filters by @enricodelazzari in https://github.com/spatie/laravel-query-builder/pull/895
+- Fix escaping control characters in partial filters by @GrahamCampbell in https://github.com/spatie/laravel-query-builder/pull/898
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.5.0...5.6.0
+
+## 5.5.0 - 2023-09-12
+
+### What's Changed
+
+- Add support for [`withExists`](https://laravel.com/docs/master/eloquent-relationships#other-aggregate-functions) via `IncludedExists` by @enricodelazzari in https://github.com/spatie/laravel-query-builder/pull/891
+- Use default values for all config keys (avoids issues when `QueryBuilder` is used as a dependency in a package)
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.4.0...5.5.0
+
+## 5.4.0 - 2023-09-08
+
+### What's Changed
+
+- Deprecate `request_data_source` config. The `QueryBuilder` will always look at both the query string and the request body when available now
+- Fix having `null` as the query parameter name for filters (see #889)
+- Bump actions/checkout from 3 to 4 by @dependabot in https://github.com/spatie/laravel-query-builder/pull/890
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.3.0...5.4.0
+
+## 5.3.0 - 2023-08-21
+
+### What's Changed
+
+- Accepts string value for the `fields` query parameter by @ezra-obiwale in https://github.com/spatie/laravel-query-builder/pull/872
+- Add `FiltersEndsWithStrict` filter by @utsavsomaiya in https://github.com/spatie/laravel-query-builder/pull/885
+- Make sure the `allowedSorts` are always set (even when none are requested) @luilliarcec in https://github.com/spatie/laravel-query-builder/pull/865
+
+### New Contributors
+
+- @ezra-obiwale made their first contribution in https://github.com/spatie/laravel-query-builder/pull/872
+- @utsavsomaiya made their first contribution in https://github.com/spatie/laravel-query-builder/pull/885
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.2.0...5.3.0
+
+## 5.2.0 - 2023-02-24
+
+### What's Changed
+
+- Bump dependabot/fetch-metadata from 1.3.5 to 1.3.6 by @dependabot in https://github.com/spatie/laravel-query-builder/pull/843
+- Update sorting.md by @shukriYusof in https://github.com/spatie/laravel-query-builder/pull/846
+- Update custom sorts link in documentation by @turpoint in https://github.com/spatie/laravel-query-builder/pull/844
+- Add config to disable InvalidSortQuery exception by @bohemima in https://github.com/spatie/laravel-query-builder/pull/830
+
+### New Contributors
+
+- @shukriYusof made their first contribution in https://github.com/spatie/laravel-query-builder/pull/846
+- @turpoint made their first contribution in https://github.com/spatie/laravel-query-builder/pull/844
+- @bohemima made their first contribution in https://github.com/spatie/laravel-query-builder/pull/830
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/5.1.2...5.2.0
+
 ## 5.1.2 - 2023-01-24
 
 ### What's Changed

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Upgrading
 
+## From v5 to v6
+
+A lot of the query builder classes now have typed properties and method parameters. If you have any custom sorts, includes, or filters, you will need to specify the property and parameter types used.
+
+## Notice when upgrading to 5.6.0
+
+The changes to the `default()` method break backwards compatibility when setting the default value to `null` (`default(null)`). This is pretty much an edge case, but if you're trying to unset the default value, you can use the `unsetDefault()` method instead. 
+
 ## From v4 to v5
 
 This version adds support for Laravel 9 and drops support for all older version.

UPGRADING.md

@@ -20,19 +20,21 @@
         }
     ],
     "require": {
-        "php": "^8.0",
-        "illuminate/database": "^9.0|^10.0",
-        "illuminate/http": "^9.0|^10.0",
-        "illuminate/support": "^9.0|^10.0",
+        "php": "^8.2",
+        "illuminate/database": "^10.0|^11.0",
+        "illuminate/http": "^10.0|^11.0",
+        "illuminate/support": "^10.0|^11.0",
         "spatie/laravel-package-tools": "^1.11",
         "doctrine/dbal": "^3.5"
     },
     "require-dev": {
         "ext-json": "*",
         "mockery/mockery": "^1.4",
+        "nunomaduro/larastan": "^2.0",
         "orchestra/testbench": "^7.0|^8.0",
-        "spatie/laravel-ray": "^1.28",
-        "pestphp/pest": "^1.20"
+        "phpunit/phpunit": "^10.0",
+        "pestphp/pest": "^2.0",
+        "spatie/invade": "^2.0"
     },
     "autoload": {
         "psr-4": {
@@ -47,7 +49,9 @@
     },
     "scripts": {
         "test": "vendor/bin/pest",
-        "test-coverage": "phpunit --coverage-html coverage"
+        "test-coverage": "phpunit --coverage-html coverage",
+        "analyse": "vendor/bin/phpstan analyse --ansi --memory-limit=4G",
+        "baseline": "vendor/bin/phpstan analyse --generate-baseline --memory-limit=4G"
     },
     "config": {
         "sort-packages": true,

composer.json

@@ -26,18 +26,38 @@
      */
     'count_suffix' => 'Count',
 
+    /*
+     * Related model exists are included using the relationship name suffixed with this string.
+     * For example: GET /users?include=postsExists
+     */
+    'exists_suffix' => 'Exists',
+
     /*
      * By default the package will throw an `InvalidFilterQuery` exception when a filter in the
      * URL is not allowed in the `allowedFilters()` method.
      */
     'disable_invalid_filter_query_exception' => false,
 
     /*
-     * By default the package inspects query string of request using $request->query().
-     * You can change this behavior to inspect the request body using $request->input()
-     * by setting this value to `body`.
+     * By default the package will throw an `InvalidSortQuery` exception when a sort in the
+     * URL is not allowed in the `allowedSorts()` method.
+     */
+    'disable_invalid_sort_query_exception' => false,
+
+    /*
+     * By default the package will throw an `InvalidIncludeQuery` exception when an include in the
+     * URL is not allowed in the `allowedIncludes()` method.
+     */
+    'disable_invalid_includes_query_exception' => false,
+
+    /*
+     * By default, the package expects relationship names to be snake case plural when using fields[relationship].
+     * For example, fetching the id and name for a userOwner relation would look like this:
+     * GET /users?fields[user_owner]=id,name
      *
-     * Possible values: `query_string`, `body`
+     * Set this to `false` if you don't want that and keep the requested relationship names as-is and allows you to
+     * request the fields using a camelCase relationship name:
+     * GET /users?fields[userOwner]=id,name
      */
-    'request_data_source' => 'query_string',
+    'convert_relation_names_to_snake_case_plural' => true,
 ];