Play with php versions on build local image, psr/http-message 2 (#28)

* Add CacheableDispatcherFactoryProxy

* Update packages (#24)

* Remove unused import

* Up cebe/php-openapi

* rollback cebe/php-openapi (cebe/php-openapi#97)

* Allow lowest fig/http-message-util version

* Allow 0.15 league/openapi-psr7-validator versions

* Allow 0.16 league/openapi-psr7-validator versions

* Allow psr/cache v2

* Allow psr/cache v3

* Use helmich/phpunit-psr7-assert v4

* Add git to docker image for install composer packages from source

* Add missing dependency psr/container

* Remove unused dependency from doctrine

* Add doctrine/persistence dependency

Co-authored-by: n.gnato <[email protected]>

* Union types support (#25)

* Remove unused import

* Support union types for relationships dto

* Split testsuites by php versions

* Add test case without union types

* Use php version var for docker

* Check union types case first

* Fix typo in const name

* Extract common resource examples

* Update docs

* Suggest nyholm/psr7 package

* Exclude cebe/php-openapi versions affected by cebe/php-openapi#97 (#26)

* Add actual php versions to gitlab action matrix (#27)

* Add actual php versions to gitlab action matrix

* Downgrade cebe/openapi version: get issue after 1.6 with null nullable.

* drop php 7.4 support

* Change dependencies constraints

* replace cebe/php-openapi with league/openapi-psr7-validator used fork

* Replace neomerx/json-api with laravel-json-api maintained fork, update ramsey/uuid to php 8.1 support version, fix warnings in test

* Allow doctrine usage 3

* Play with php versions on build local image, psr/http-message 2

* Add php 8.4 to test matrix

* Add inherited return types to ServiceRequestDecorator

* Update supported php versions and phpunit

---------

Co-authored-by: n.gnato <[email protected]>

Author: samizdam

.github/workflows/ci.yml

@@ -7,8 +7,10 @@ jobs:
     strategy:
       matrix:
         php:
-          - 7.4
-          - 8.0
+          - 8.1
+          - 8.2
+          - 8.3
+          - 8.4
         prefer:
           - lowest
           - stable

.gitignore

@@ -1,6 +1,8 @@
+/.env
+
 /.idea/
 
-/.phpunit.result.cache
+/.phpunit.cache/
 
 /composer.lock
 

CHANGELOG.md

@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Data Transfer Object classes generation from swagger spec
 - JsonApiResponseFactory::createResponse() `meta` and `links` arguments 
+- CacheableDispatcherFactoryProxy
+- Union types support for `data.relationships` DTO: use suitable type for input data structure 
+
+### Changed
+- Best composer dependencies compatibility: allow more versions
+
+## Removed
+- php 7.4 and 8.0 support
 
 ## [0.0.14] - 2021-02-02
 ### Added
@@ -17,7 +25,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - JsonApiResponseFactory::createRelationshipResponse()
 - RateLimitMiddleware and related packages
 
-
 ## [0.0.13] - 2021-01-27
 ### Added
 - TraceIntoDetailsExplainingErrorFactory for catched ErrorHandler exceptions debug. Note: not for production usage

Dockerfile

@@ -1,4 +1,6 @@
-FROM php:8-cli
+ARG PHP_VERSION=8.3
+
+FROM php:${PHP_VERSION}-cli
 
 RUN apt-get update \
     && apt-get install -y \

Makefile

@@ -1,7 +1,9 @@
 PATH := $(shell pwd)/bin:$(PATH)
+$(shell cp -n dev.env .env)
+include .env
 
 build:
-	docker build -t free-elephants/json-api-php-toolkit .
+	docker build --build-arg PHP_VERSION=$(PHP_VERSION) -t free-elephants/json-api-php-toolkit .
 
 install: build
 	composer install

README.md

@@ -28,3 +28,9 @@ Available in [/docs](/docs).
 1. [Serialize doctrine entities](/docs/doctrine.md)
 1. [DTO from psr server request](/docs/dto-psr7.md)
 1. [Validation](/docs/validation.md)
+
+## Development
+
+All dev env is dockerized. Your can use make receipts and `bin/` scripts without locally installed php, composer. 
+
+For run tests with different php version change `PHP_VERSION` value in .env and rebuild image with `make build`.  

composer.json

@@ -14,32 +14,34 @@
     "require": {
         "ext-intl": "*",
         "ext-json": "*",
-        "cebe/php-openapi": "1.4.*",
-        "fig/http-message-util": "^1.1",
+        "devizzent/cebe-php-openapi": "^1.0",
+        "doctrine/persistence": "^2.0|^3.0",
+        "fig/http-message-util": "^1.0",
         "free-elephants/i18n": "^0.0.1",
         "laminas/laminas-stratigility": "^3.2",
-        "league/openapi-psr7-validator": "0.14",
-        "neomerx/json-api": "^4.0",
+        "laravel-json-api/neomerx-json-api": "^5.0.2",
+        "league/openapi-psr7-validator": "0.19 - 0.22",
         "nette/php-generator": "^3.4",
         "nikic/fast-route": "^1.3",
-        "psr/cache": "^1.0",
+        "psr/cache": "^1|^2|^3",
+        "psr/container": "^1|^2",
         "psr/http-factory": "^1.0",
-        "psr/http-message": "^1.0",
+        "psr/http-message": "^1.0|^2.0",
         "psr/http-server-handler": "^1.0",
         "psr/http-server-middleware": "^1.0",
         "rakit/validation": "^1.2",
-        "ramsey/uuid": "^3.0|^4.0"
+        "ramsey/uuid": "^3.9.7|^4.0"
     },
     "require-dev": {
-        "doctrine/orm": "^2.7",
-        "helmich/phpunit-psr7-assert": "dev-master#c7c75e8",
+        "helmich/phpunit-psr7-assert": "^4",
         "nyholm/psr7": "^1.2",
-        "phpunit/phpunit": "^9.0"
+        "phpunit/phpunit": "^10.5.38|^11.0"
     },
     "suggest": {
         "doctrine/orm": "^2.7",
         "free-elephants/di": "*",
-        "laminas/laminas-httphandlerrunner": "*"
+        "laminas/laminas-httphandlerrunner": "*",
+        "nyholm/psr7": "^1.2"
     },
     "autoload": {
         "psr-4": {

dev.env

@@ -0,0 +1 @@
+PHP_VERSION=8.3

docs/dto-psr7.md

@@ -3,3 +3,5 @@
 Full typed objects from request or response body.
 
 See example in [test](/tests/FreeElephants/JsonApiToolkit/DTO/DocumentTest.php). 
+
+Union types support for relationships in PHP 8. 

docs/routing.md

@@ -60,3 +60,8 @@ JSON
 
 (new DispatcherFactory(null, new Parsers\JsonFileParser()))->buildDispatcher('swagger.json');
 ```
+
+## About performance
+
+Parse large swagger files have performance issues. Use `FreeElephants\JsonApiToolkit\Routing\FastRoute\CacheableDispatcherFactoryProxy` for production usage: it based on psr/cache component compare swagger file hash.
+