PHP 8 min, json object decoding (#2)

* upgraded minimum php version to 8.0

* Changed json decode to objects instead of associative arrays

* corrected build step

* upgrade guide

Author: LaravelFreelancerNL

.github/workflows/ci.yml

@@ -10,8 +10,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [7.4, 8.0]
-        arangodb: [3.6.0, 3.6, latest]
+        php: [8.0]
+        arangodb: [3.6, 3.7, latest]
     name:  Quality checks PHP ${{ matrix.php }} / ArangoDB ${{ matrix.arangodb }}
 
     services:
@@ -51,4 +51,4 @@ jobs:
           chmod +x "${GITHUB_WORKSPACE}/bin/qa.sh"
           "${GITHUB_WORKSPACE}/bin/qa.sh"
         env:
-          ARANGODB_VERSION: ${{ matrix.arangodb }}
+          ARANGODB_VERSION: ${{ matrix.arangodb }}

.github/workflows/coverage.yml

@@ -22,12 +22,13 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          fetch-depth: 2
-          php-version: 7.4
+          php-version: 8.0
           extensions: mbstring, intl
           ini-values: post_max_size=256M, short_open_tag=On
           coverage: xdebug
@@ -38,5 +39,5 @@ jobs:
       - name: Test coverage
         run: |
           vendor/bin/phpunit --coverage-clover clover.xml --whitelist src
-          wget https://scrutinizer-ci.com/ocular.phar
-          php ocular.phar code-coverage:upload --format=php-clover clover.xml
+          echo "Upload results to Scrutinizer-ci"
+          vendor/bin/ocular code-coverage:upload --format=php-clover clover.xml

README.md

@@ -1,6 +1,6 @@
 # ArangoClient - ArangoDB PHP client
 
-Low level PHP client for ArangoDB. Supports PHP versions 7.4 & ^8.0
+Low level PHP client for ArangoDB. Supports PHP ^8.0.
 
 ![Github CI tests](https://github.com/LaravelFreelancerNL/arangodb-php-client/workflows/CI%20tests/badge.svg)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/LaravelFreelancerNL/arangodb-php-client/badges/quality-score.png?b=next)](https://scrutinizer-ci.com/g/LaravelFreelancerNL/arangodb-php-client/?branch=next)
@@ -9,8 +9,10 @@ Low level PHP client for ArangoDB. Supports PHP versions 7.4 & ^8.0
 <a href="https://packagist.org/packages/laravel-freelancer-nl/arangodb-php-client"><img src="https://poser.pugx.org/laravel-freelancer-nl/arangodb-php-client/downloads" alt="Total Downloads"></a>
 <a href="https://packagist.org/packages/laravel-freelancer-nl/arangodb-php-client"><img src="https://poser.pugx.org/laravel-freelancer-nl/arangodb-php-client/license" alt="License"></a>
 
-## Install
+This client is a conduit to ArangoDB and back, so it doesn't make any presumptions on the returned data itself. 
+JSON objects are decoded to POPO's. You can cast those to what you need in your ODM or project. 
 
+## Install
 ```
 composer require laravel-freelancer-nl/arangodb-php-client
 ```

UPGRADE.md

@@ -0,0 +1,21 @@
+# Upgrade Guide
+
+## Upgrading From 1.x To  2.x
+
+### Response objects instead of associative arrays
+The biggest change is the decoding of responses. JSON objects are now decoded to POPO's (Plain Old Php Objects).
+This will influence how you use the response. Together with the improvements in php 8 this makes the result data much
+nicer to work with compared to associative arrays.
+
+This client is just a conduit, so it doesn't make any presumptions on the returned data itself, hence the the objects 
+are of the stdClass type.
+
+### PHP 8
+PHP 8.0 is now the minimum supported version. You will need to run your app with this version
+and ensure that other packages support it.
+
+If you need to use PHP 7.4 you can use the maintenance branch 1.x
+
+### Schema function result data
+Some schema functions just returned a boolean to indicate success or failure. These now match
+the returned result by ArangoDB.

composer.json

@@ -16,20 +16,21 @@
     "minimum-stability": "dev",
     "prefer-stable" : true,
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^8.0",
+        "ext-curl": "*",
         "ext-json": "*",
-        "guzzlehttp/guzzle": "^7.2",
+        "guzzlehttp/guzzle": "^7.3",
         "halaxa/json-machine": "^0.6.0",
-        "spatie/data-transfer-object": "^2.8"
+        "spatie/data-transfer-object": "^3.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
         "phpstan/phpstan": "^0.12.82",
         "phpmd/phpmd": "^2.9",
-        "vimeo/psalm": "^4.6",
-        "squizlabs/php_codesniffer": "^3.5",
+        "vimeo/psalm": "^4.7",
+        "squizlabs/php_codesniffer": "^3.6",
         "mockery/mockery": "^1.4",
-        "ext-curl": "*"
+        "scrutinizer/ocular": "^1.8"
     },
     "autoload": {
         "psr-4": {